This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Timber output plugin Webhdfs output plugin »

› ›

Udp output plugin

edit

Udp output plugin

edit

Plugin version: v3.2.0
Released on: 2021-07-14
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

Send events over UDP

Keep in mind that UDP does not provide delivery or duplicate protection guarantees. Even when this plugin succeeds at writing to the UDP socket, there is no guarantee that the recipient will receive exactly one copy of the event.

When this plugin fails to write to the UDP socket, by default the event will be dropped and the error message will be logged. The retry_count option in conjunction with the retry_backoff_ms option can be used to retry a failed write for a number of times before dropping the event.

Udp Output Configuration Options

edit

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

Setting	Input type	Required
`host`	string	Yes
`port`	string	Yes
`retry_count`	number	No
`retry_backoff_ms`	number	No

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

`host`

edit

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

The address to send messages to

`port`

edit

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

The port to send messages on. This can be dynamic using the %{[target][port]} syntax.

`retry_count`

edit

Value type is number
Default value is 0

The number of times to retry a failed UPD socket write

`retry_backoff_ms`

edit

Value type is number
Default value is 10

The amount of time to wait in milliseconds before attempting to retry a failed UPD socket write

Common options

edit

These configuration options are supported by all output plugins:

Setting	Input type	Required
`codec`	codec	No
`enable_metric`	boolean	No
`id`	string	No

`codec`

edit

Value type is codec
Default value is "json"

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output 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 outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
  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.

« Timber output plugin Webhdfs output plugin »