in_udp: document source_address_key

The support for source_address_key was added to in_udp too. https://www.fluentd.org/blog/fluentd-v1.4.2-has-been-released Signed-off-by: Fujimoto Seiji <fujimoto@clear-code.com>
juergen-walter · Apr 10, 2019 · abf654d · abf654d
1 parent 44ae5bd
commit abf654d
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/docs/v1.0/in_udp.txt b/docs/v1.0/in_udp.txt
@@ -84,6 +84,31 @@ then the client's hostname is set to `client_host` field.
         "client_host": "client.hostname.org"
     }
 
+### source_address_key
+
+| type   | default                        | version |
+|:------:|:------------------------------:|:-------:|
+| string | nil (no adding source address) | 1.4.2   |
+
+The field name for the client's IP address. If you set this option, Fluentd automatically adds the remote address to each data record.
+
+For example, if you have the following configuration:
+
+    <source>
+      @type udp
+      source_address_key client_addr
+      ...
+    </source>
+
+you will get something like below:
+
+    :::text
+    {
+        ...
+        "client_addr": "192.168.10.10"
+        ...
+    }
+
 ### message_length_limit
 
 | type | default | version |