telemetry

Documentation

Index

• func AddConnection(n string, c ConnType)
• func Close()
• func IncrementBytes(n string, c ConnType, d Direction, count uint64)
• func IncrementPackets(n string, c ConnType, d Direction, count uint64)
• func Init()
• func SubConnection(n string, c ConnType)
• type Conn
  • func NewConn(c net.Conn, n string, t ConnType) *Conn
  • func (c *Conn) Close() error
  • func (c *Conn) Read(b []byte) (n int, err error)
  • func (c *Conn) Write(b []byte) (n int, err error)
• type ConnType
  • func (c ConnType) String() string
• type Direction
  • func (d Direction) String() string
• type Listener
  • func NewListener(l net.Listener, n string, t ConnType) *Listener
  • func (l *Listener) Accept() (net.Conn, error)
• type PacketConn
  • func NewPacketConn(c net.PacketConn, n string, t ConnType) *PacketConn
  • func (c *PacketConn) Close() error
  • func (c *PacketConn) ReadFrom(p []byte) (n int, addr net.Addr, err error)
  • func (c *PacketConn) WriteTo(p []byte, addr net.Addr) (n int, err error)
• type RelayAddressGenerator
  • func (g *RelayAddressGenerator) AllocateConn(network string, requestedPort int) (net.Conn, net.Addr, error)
  • func (r *RelayAddressGenerator) AllocatePacketConn(network string, requestedPort int) (net.PacketConn, net.Addr, error)
  • func (r *RelayAddressGenerator) Validate() error

Functions

func AddConnection

func AddConnection(n string, c ConnType)

func Close

func Close()

func IncrementBytes

func IncrementBytes(n string, c ConnType, d Direction, count uint64)

func IncrementPackets

func IncrementPackets(n string, c ConnType, d Direction, count uint64)

func Init

func Init()

func SubConnection

func SubConnection(n string, c ConnType)

Types

type Conn

type Conn struct {
	net.Conn
	// contains filtered or unexported fields
}

Conn is a net.Conn that knows how to report to Prometheus.

func NewConn

func NewConn(c net.Conn, n string, t ConnType) *Conn

NewConn allocates a stats conn that knows its name and type.

func (*Conn) Close

func (c *Conn) Close() error

Close closes the Conn.

func (*Conn) Read

func (c *Conn) Read(b []byte) (n int, err error)

Read reads from the Conn.

func (*Conn) Write

func (c *Conn) Write(b []byte) (n int, err error)

Write writes to the Conn.

type ConnType

type ConnType int

ConnType species whether a conn stat was collected at a listener or a cluster.

const (
	ListenerType ConnType = iota + 1
	ClusterType
)

func (ConnType) String

func (c ConnType) String() string

String returns a string representation for a ConnType.

type Direction

type Direction int

Direction species whether a conn stat applies in the sender or a receiving direction from the standpoint of STUNner.

const (
	Incoming Direction = iota + 1
	Outgoing
)

func (Direction) String

func (d Direction) String() string

String returns a string representation for a Direction.

type Listener

type Listener struct {
	net.Listener
	// contains filtered or unexported fields
}

Listener is a net.Listener that knows how to report to Prometheus.

func NewListener

func NewListener(l net.Listener, n string, t ConnType) *Listener

NewListener creates a net.Listener that knows its name and type.

func (*Listener) Accept

func (l *Listener) Accept() (net.Conn, error)

Accept accepts a new connection on a Listener.

type PacketConn

type PacketConn struct {
	net.PacketConn
	// contains filtered or unexported fields
}

PacketConn is a net.PacketConn that knows how to report to Prometheus.

func NewPacketConn

func NewPacketConn(c net.PacketConn, n string, t ConnType) *PacketConn

NewPacketConn allocates a stats conn that knows its name and type.

func (*PacketConn) Close

func (c *PacketConn) Close() error

ReadFrom reads from the PacketConn. WriteTo writes to the PacketConn. Close closes the PacketConn.

func (*PacketConn) ReadFrom

func (c *PacketConn) ReadFrom(p []byte) (n int, addr net.Addr, err error)

ReadFrom reads from the PacketConn.

func (*PacketConn) WriteTo

func (c *PacketConn) WriteTo(p []byte, addr net.Addr) (n int, err error)

WriteTo writes to the PacketConn.

type RelayAddressGenerator

type RelayAddressGenerator struct {
	// Name is the name of the listener this relay address generator belongs to. Note that
	// packets sent to/received from upstream cluster are reported with the name of the
	// *listener* that the packet belongs to, and not the cluster.
	Name string

	// RelayAddress is the IP returned to the user when the relay is created.
	RelayAddress net.IP

	// MinPort the minimum port to allocate.
	MinPort uint16
	// MaxPort the maximum (inclusive) port to allocate.
	MaxPort uint16

	// MaxRetries the amount of tries to allocate a random port in the defined range.
	MaxRetries int

	// Rand the random source of numbers.
	Rand randutil.MathRandomGenerator

	// Address is passed to Listen/ListenPacket when creating the Relay.
	Address string

	// Net is a pion/transport VNet, used for testing.
	Net transport.Net
}

RelayAddressGenerator can be used to only allocate connections inside a defined port range. A static ip address can be set.

func (*RelayAddressGenerator) AllocateConn

func (g *RelayAddressGenerator) AllocateConn(network string, requestedPort int) (net.Conn, net.Addr, error)

AllocateConn generates a new Conn to receive traffic on and the IP/Port to populate the allocation response with

func (*RelayAddressGenerator) AllocatePacketConn

func (r *RelayAddressGenerator) AllocatePacketConn(network string, requestedPort int) (net.PacketConn, net.Addr, error)

AllocatePacketConn generates a new PacketConn to receive traffic on and the IP/Port to populate the allocation response with

func (*RelayAddressGenerator) Validate

func (r *RelayAddressGenerator) Validate() error

Validate is called on server startup and confirms the RelayAddressGenerator is properly configured