in_tcp: document "send_keepalive_packet" option

See fluent/fluentd#3961 Signed-off-by: Fujimoto Seiji <[email protected]>
fujimotos · Nov 22, 2022 · d9ecb66 · d9ecb66
1 parent 821d278
commit d9ecb66
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/input/tcp.md b/input/tcp.md
@@ -167,6 +167,17 @@ You can set positive value to send FIN on closing on non-Windows.
 </source>
 ```
 
+##### `send_keepalive_packet`
+
+| type | default | available transport type | version |
+| :--- | :--- | :--- | :--- |
+| bool | false | tcp, tls | 1.15.0 |
+
+Enable `SO_KEEPALIVE` on the underlying TCP sockets.
+
+This is useful when you connect to Fluentd over firewalls or proxies and
+want to prevent connections from being closed automatically.
+
 #### TLS configuration
 
 ```text