udp_listener

README

UDP Listener Input Plugin

DEPRECATED: As of version 1.3 the UDP listener plugin has been deprecated in favor of the socket_listener plugin

Configuration

# Generic UDP listener
[[inputs.udp_listener]]
  # see https://github.com/influxdata/telegraf/tree/master/plugins/inputs/socket_listener

Documentation

Index

• Constants
• type UDPListener
  • func (u *UDPListener) Gather(_ telegraf.Accumulator) error
  • func (*UDPListener) SampleConfig() string
  • func (u *UDPListener) SetParser(parser parsers.Parser)
  • func (u *UDPListener) Start(acc telegraf.Accumulator) error
  • func (u *UDPListener) Stop()

Constants

const UDPMaxPacketSize int = 64 * 1024

UDPMaxPacketSize is packet limit, see https://en.wikipedia.org/wiki/User_Datagram_Protocol#Packet_structure

Types

type UDPListener

type UDPListener struct {
	ServiceAddress string

	// UDPBufferSize should only be set if you want/need the telegraf UDP socket to
	// differ from the system setting. In cases where you set the rmem_default to a lower
	// value at the host level, but need a larger buffer for UDP bursty traffic, this
	// setting enables you to configure that value ONLY for telegraf UDP sockets on this listener
	// Set this to 0 (or comment out) to take system default
	//
	// NOTE: You should ensure that your rmem_max is >= to this setting to work properly!
	// (e.g. sysctl -w net.core.rmem_max=N)
	UDPBufferSize          int `toml:"udp_buffer_size"`
	AllowedPendingMessages int

	// UDPPacketSize is deprecated, it's only here for legacy support
	// we now always create 1 max size buffer and then copy only what we need
	// into the in channel
	// see https://github.com/influxdata/telegraf/pull/992
	UDPPacketSize int `toml:"udp_packet_size"`

	sync.Mutex

	PacketsRecv selfstat.Stat
	BytesRecv   selfstat.Stat

	Log telegraf.Logger
	// contains filtered or unexported fields
}

UDPListener main struct for the collector

func (*UDPListener) Gather

func (u *UDPListener) Gather(_ telegraf.Accumulator) error

All the work is done in the Start() function, so this is just a dummy function.

func (*UDPListener) SampleConfig

func (*UDPListener) SampleConfig() string

func (*UDPListener) SetParser

func (u *UDPListener) SetParser(parser parsers.Parser)

func (*UDPListener) Start

func (u *UDPListener) Start(acc telegraf.Accumulator) error

func (*UDPListener) Stop

func (u *UDPListener) Stop()