Add description to linger_timeout behavior about Windows

This option is added in fluent/fluentd#3644 The description is added in fluent#392 However, there was a lack of consideration regarding the default behavior on Windows. Signed-off-by: Daijiro Fukuda <fukuda@clear-code.com>
daipom · Apr 4, 2022 · c418a89 · c418a89
1 parent 7df3e8b
commit c418a89
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 8 deletions.
diff --git a/input/forward.md b/input/forward.md
@@ -170,9 +170,11 @@ This section is for setting TLS transport or some general transport configuratio
 
 The timeout \(seconds\) to set `SO_LINGER`.
 
-The default value `0` is to send RST rather than FIN to avoid lots of connections sitting in TIME_WAIT on closing.
+The default value `0` is to send RST rather than FIN to avoid lots of connections sitting in TIME_WAIT on closing on non-Windows.
 
-You can set positive value to send FIN on closing.
+You can set positive value to send FIN on closing on non-Windows.
+
+(On Windows, Fluentd sends FIN when `linger_timeout` is `0` too).
 
 ```text
 <transport tcp>

diff --git a/input/http.md b/input/http.md
@@ -178,9 +178,11 @@ This section is for setting TLS transport or some general transport configuratio
 
 The timeout \(seconds\) to set `SO_LINGER`.
 
-The default value `0` is to send RST rather than FIN to avoid lots of connections sitting in TIME_WAIT on closing.
+The default value `0` is to send RST rather than FIN to avoid lots of connections sitting in TIME_WAIT on closing on non-Windows.
 
-You can set positive value to send FIN on closing.
+You can set positive value to send FIN on closing on non-Windows.
+
+(On Windows, Fluentd sends FIN when `linger_timeout` is `0` too).
 
 ```text
 <transport tcp>

diff --git a/input/tcp.md b/input/tcp.md
@@ -151,9 +151,11 @@ This section is for setting TLS transport or some general transport configuratio
 
 The timeout \(seconds\) to set `SO_LINGER`.
 
-The default value `0` is to send RST rather than FIN to avoid lots of connections sitting in TIME_WAIT on closing.
+The default value `0` is to send RST rather than FIN to avoid lots of connections sitting in TIME_WAIT on closing on non-Windows.
 
-You can set positive value to send FIN on closing.
+You can set positive value to send FIN on closing on non-Windows.
+
+(On Windows, Fluentd sends FIN when `linger_timeout` is `0` too).
 
 ```text
 <source>

diff --git a/plugin-helper-overview/api-plugin-helper-server.md b/plugin-helper-overview/api-plugin-helper-server.md
@@ -170,9 +170,11 @@ end
 
 The timeout \(seconds\) to set `SO_LINGER`.
 
-The default value `0` is to send RST rather than FIN to avoid lots of connections sitting in TIME_WAIT on closing.
+The default value `0` is to send RST rather than FIN to avoid lots of connections sitting in TIME_WAIT on closing on non-Windows.
 
-You can set positive value to send FIN on closing.
+You can set positive value to send FIN on closing on non-Windows.
+
+(On Windows, Fluentd sends FIN when `linger_timeout` is `0` too).
 
 ```text
 <source>