UDP

Supported Platforms

Platform	Metrics	Logs	Traces
Linux		✓
Windows		✓
macOS		✓
Kubernetes Gateway		✓
OpenShift Gateway		✓

Configuration Table

Parameter	Type	Default	Description
listen_port*	int		Port to listen on.
listen_ip	string	"0.0.0.0"	IP Address to listen on.
log_type	string	udp	Arbitrary for attribute 'log_type'. Useful for filtering between many udp sources.
parse_format	enum	none	Method to use when parsing. Valid values are none, json, and regex. When regex is selected, 'Regex Pattern' must be set.
regex_pattern	string		The regex pattern used when parsing log entries.
multiline_line_start_pattern	string		Regex pattern that matches the beginning of a log entry, for handling multiline logs.
multiline_line_end_pattern	string		Regex pattern that matches the end of a log entry, useful for terminating parsing of multiline logs.
parse_timestamp	bool	false	Whether to parse the timestamp from the log entry.
timestamp_field	string	timestamp	The field containing the timestamp in the log entry.
parse_timestamp_format	enum	ISO8601	The format of the timestamp in the log entry. Choose a common format, or specify a custom format. Options include "ISO8601", "RFC3339", "Epoch", and "Manual".
epoch_timestamp_format	enum	s	The layout of the epoch-based timestamp. Required when parse_timestamp_format is set to "Epoch".. Options include "s", "ms", "us", "ns", "s.ms", "s.us", "s.ns".
manual_timestamp_format	string	'%Y-%m-%dT%H:%M:%S.%f%z'	The strptime layout of the timestamp. Used when parse_timestamp_format is set to "Manual".
timezone	timezone	UTC	The timezone to use if the Timestamp Format doesn't include a timezone. Otherwise, the timezone in the Timestamp Format will be respected. NOTE: This is also required to parse timezone abbreviations, due to their ambiguity.
parse_severity	bool	false	Whether to parse severity from the log entry.
severity_field	string	severity	The field containing the severity in the log entry.
parse_to	string	body	The field that the log will be parsed to. Some exporters handle logs favorably when parsed to attributes over body and vice versa.
async_readers	int	1	Determines how many workers read from UDP port and push to buffer. Generally this value should remain at 1 unless otherwise directed by Bindplane support.
async_processors	int	3	Determines how many workers read from buffer (pushed by readers) and process logs before sending downstream. Increasing this value can be useful when the collector is under significant load.
max_queue_length	int	100	Determines size of buffer being used by async reader workers. When buffer reaches max number, reader workers will block until buffer has room. Increasing this value can be useful if you anticipate short durations of increased log volume. Generally, you should increase async_processors before increasing this value.

*required field

Kubernetes

When using this source with Kubernetes or OpenShift, you must create a custom Service resource to route traffic to the collector. See the Kubernetes Service for more information.