index.asciidoc in logstash-output-udp-3.1.0

- old
+ new

@@ -21,22 +21,31 @@
 
 ==== Description
 
 Send events over UDP
 
-Keep in mind that UDP will lose messages.
+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>> |<<number,number>>|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.
 
@@ -58,10 +67,24 @@
   * Value type is <<number,number>>
   * There is no default value for this setting.
 
 The port to send messages on
 
+[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!:
\ No newline at end of file