listeners

README

package listeners

This package handles the network transmission for statsd protocols and returns packets to be processed by the dogstatsd package.

Packet

Packet is a statsd packet that might contain several statsd messages in it's Contents field. If origin detection is supported and enabled, the Origin field will hold the container id ready for tag resolution. If not, the field holds an empty string.

StatsdListener

StatsdListener is the common interface, currently implemented by:

• UDPListener: handles the historical UDP protocol,
• UDSListener: handles the host-local UDS protocol with optional origin detection, see [https://github.com/DataDog/datadog-agent/wiki/Unix-Domain-Sockets-support](the wiki) for more info.

Origin Detection is Linux only

As our client implementations rely on Unix Credentials being added automatically by the Linux kernel, this feature is Linux only for now. If needed, server and client side could be updated and tested with other unices.

Documentation

Index

• Constants
• type Packet
• type StatsdListener
• type UDPListener
  • func NewUDPListener(packetOut chan *Packet) (*UDPListener, error)
  • func (l *UDPListener) Listen()
  • func (l *UDPListener) Stop()
• type UDSListener
  • func NewUDSListener(packetOut chan *Packet) (*UDSListener, error)
  • func (l *UDSListener) Listen()
  • func (l *UDSListener) Stop()

Constants

const (
	// PIDToContainerKeyPrefix holds the name prefix for cache keys
	PIDToContainerKeyPrefix = "pid_to_container"
)

Types

type Packet

type Packet struct {
	Contents []byte // Contents, might contain several messages
	Origin   string // Origin container if identified
}

Packet reprensents a statsd packet ready to process, with its origin metadata if applicable.

type StatsdListener

type StatsdListener interface {
	Listen()
	Stop()
}

StatsdListener opens a communication channel to get statsd packets in.

type UDPListener

type UDPListener struct {
	// contains filtered or unexported fields
}

UDPListener implements the StatsdListener interface for UDP protocol. It listens to a given UDP address and sends back packets ready to be processed. Origin detection is not implemented for UDP.

func NewUDPListener

func NewUDPListener(packetOut chan *Packet) (*UDPListener, error)

NewUDPListener returns an idle UDP Statsd listener

func (*UDPListener) Listen

func (l *UDPListener) Listen()

Listen runs the intake loop. Should be called in its own goroutine

func (*UDPListener) Stop

func (l *UDPListener) Stop()

Stop closes the UDP connection and stops listening

type UDSListener

type UDSListener struct {
	OriginDetection bool
	// contains filtered or unexported fields
}

UDSListener implements the StatsdListener interface for Unix Domain Socket datagram protocol. It listens to a given socket path and sends back packets ready to be processed. Origin detection will be implemented for UDS.

func NewUDSListener

func NewUDSListener(packetOut chan *Packet) (*UDSListener, error)

NewUDSListener returns an idle UDS Statsd listener

func (*UDSListener) Listen

func (l *UDSListener) Listen()

Listen runs the intake loop. Should be called in its own goroutine

func (*UDSListener) Stop

func (l *UDSListener) Stop()

Stop closes the UDS connection and stops listening