Udp output plugin v3.1.0

  • Plugin version: v3.1.0
  • Released on: 2019-12-17
  • Changelog

For other versions, see the overview list.

To learn more about Logstash, see the Logstash Reference.

Getting Help

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

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

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

Setting Input type Required

host

string

Yes

port

number

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

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

The address to send messages to

port

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

The port to send messages on

retry_count

  • Value type is number
  • Default value is 0

The number of times to retry a failed UPD socket write

retry_backoff_ms

  • 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

The following configuration options are supported by all output plugins:

Setting Input type Required

codec

codec

No

enable_metric

boolean

No

id

string

No

codec

  • 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

  • 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

  • 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"
  }
}