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

« Twitter input plugin Unix input plugin »

› ›

Udp input plugin

edit

Udp input plugin

edit

Plugin version: v3.4.1
Released on: 2021-03-26
Changelog

For other versions, see the Versioned plugin docs.

Getting Help

edit

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Description

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.

Event Metadata and the Elastic Common Schema (ECS)

edit

This plugin adds a field containing the source IP address of the UDP packet. By default, the IP address is stored in the host field. When Elastic Common Schema (ECS) is enabled (in ecs_compatibility), the source IP address is stored in the [host][ip] field.

You can customize the field name using the source_ip_fieldname. See ecs_compatibility for more information.

Udp Input Configuration Options

edit

This plugin supports the following configuration options plus the Common Options described later.

Setting	Input type	Required
`buffer_size`	number	No
`ecs_compatibility`	string	No
`host`	string	No
`port`	number	Yes
`queue_size`	number	No
`receive_buffer_bytes`	number	No
`source_ip_fieldname`	string	No
`workers`	number	No

Also see Common Options for a list of options supported by all input plugins.

`buffer_size`

edit

Value type is number
Default value is 65536

The maximum packet size to read from the network

`ecs_compatibility`

edit

Value type is string
Supported values are:
- disabled: unstructured connection metadata added at root level
- v1: structured connection metadata added under ECS compliant namespaces
Default value depends on which version of Logstash is running:
- When Logstash provides a pipeline.ecs_compatibility setting, its value is used as the default
- Otherwise, the default value is disabled.

Controls this plugin’s compatibility with the Elastic Common Schema (ECS).

The value of this setting affects the placement of a TCP connection’s metadata on events.

Table 1. Metadata Location by ecs_compatibility value

`disabled`	`v1`	Availability	Description
host	[host][ip]	Always	Source IP of UDP packet

`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.

`receive_buffer_bytes`

edit

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

The socket receive buffer size in bytes. If option is not set, the operating system default is used. The operating system will use the max allowed value if receive_buffer_bytes is larger than allowed. Consult your operating system documentation if you need to increase this max allowed value.

`source_ip_fieldname`

edit

Value type is string
Default value could be "host" or [host][ip] depending on the value of ecs_compatibility

The name of the field where the source IP address will be stored. See Event Metadata and the Elastic Common Schema (ECS) for more information on how ECS compatibility settings affect these defaults.

Example:

    input {
      udp {
        source_ip_fieldname => "[appliance][monitoring][ip]"
      }
    }

`workers`

edit

Value type is number
Default value is 2

Number of threads processing packets

Common Options

edit

The following configuration options are supported by all input plugins:

Setting	Input type	Required
`add_field`	hash	No
`codec`	codec	No
`enable_metric`	boolean	No
`id`	string	No
`tags`	array	No
`type`	string	No

Details

edit

`add_field`

edit

Value type is hash
Default value is {}

Add a field to an event

`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.

`enable_metric`

edit

Value type is boolean
Default value is true

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

`id`

edit

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

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 udp inputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

input {
  udp {
    id => "my_plugin_id"
  }
}

Variable substitution in the id field only supports environment variables and does not support the use of values from the secret store.

`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.

« Twitter input plugin Unix input plugin »