IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« twitter unix »

› ›

udp

edit

udp

edit

Read messages as events over the network via udp. The only required configuration item is port, which specifies the udp port logstash will listen on for event streams.

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

udp {
    port => ...
}

Available configuration options:

Setting	Input type	Required	Default value
`add_field`	hash	No	`{}`
`buffer_size`	number	No	`8192`
`codec`	codec	No	`"plain"`
`host`	string	No	`"0.0.0.0"`
`port`	number	Yes
`queue_size`	number	No	`2000`
`tags`	array	No
`type`	string	No
`workers`	number	No	`2`

Details

edit

`add_field`

edit

Value type is hash
Default value is {}

Add a field to an event

`buffer_size`

edit

Value type is number
Default value is 8192

The maximum packet size to read from the network

`codec`

edit

Value type is codec
Default value is "plain"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

`host`

edit

Value type is string
Default value is "0.0.0.0"

The address which logstash will listen on.

`port`

edit

This is a required setting.
Value type is number
There is no default value for this setting.

The port which logstash will listen on. Remember that ports less than 1024 (privileged ports) may require root or elevated privileges to use.

`queue_size`

edit

Value type is number
Default value is 2000

This is the number of unprocessed UDP packets you can hold in memory before packets will start dropping.

`tags`

edit

Value type is array
There is no default value for this setting.

Add any number of arbitrary tags to your event.

This can help with processing later.

`type`

edit

Value type is string
There is no default value for this setting.

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.

`workers`

edit

Value type is number
Default value is 2

Number of threads processing packets

« twitter unix »