:plugin: udp
:type: output
:default_codec: json

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}s-{plugin}"]

=== Udp output plugin

include::{include_path}/plugin_header.asciidoc[]

==== 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 <<plugins-{type}s-{plugin}-retry_count>> option
in conjunction with the <<plugins-{type}s-{plugin}-retry_backoff_ms>> option can be used
to retry a failed write for a number of times before dropping the event.

[id="plugins-{type}s-{plugin}-options"]
==== Udp Output Configuration Options

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-port>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-retry_count>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-retry_backoff_ms>> |<<number,number>>|No
|=======================================================================

Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
output plugins.

&nbsp;

[id="plugins-{type}s-{plugin}-host"]
===== `host` 

  * This is a required setting.
  * Value type is <<string,string>>
  * There is no default value for this setting.

The address to send messages to

[id="plugins-{type}s-{plugin}-port"]
===== `port` 

  * This is a required setting.
  * Value type is <<string,string>>
  * There is no default value for this setting.

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

[id="plugins-{type}s-{plugin}-retry_count"]
===== `retry_count`

* Value type is <<number,number>>
* Default value is `0`

The number of times to retry a failed UPD socket write

[id="plugins-{type}s-{plugin}-retry_backoff_ms"]
===== `retry_backoff_ms`

* Value type is <<number,number>>
* Default value is `10`

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

[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]

:default_codec!: