Skip to content

Commit f10a284

Browse files
eschabelleschabell
authored
Updates for networking doc in configuration options table including new v4.1 released configurations. Fixes #2089. (#2121)
* Removing a readme file this is not standardized in classic-mode directory. Signed-off-by: Eric D. Schabell <[email protected]> * Updated to not use readme file in classic-config directory, but the correct description file. Signed-off-by: Eric D. Schabell <[email protected]> * Updated to better sort some sections and update for missing entries. Fixes #2108. Signed-off-by: Eric D. Schabell <[email protected]> * Updated configuration variables for opentelemetry output plugin, many new ones added. Signed-off-by: Eric D. Schabell <[email protected]> * Updated configuration variables for opentelemetry output plugin, many new ones added. Fixes #2083 Signed-off-by: Eric D. Schabell <[email protected]> * Fixes reqeusted by reviewers for options table for opentelemetry output plugin. Signed-off-by: Eric D. Schabell <[email protected]> * Updates for networking doc in configuration options table including. Fixes #2089. Signed-off-by: Eric D. Schabell <[email protected]> * Updated to quote variable in net.tcp_keepalive_probes description from options table. Applies to #2121. Signed-off-by: Eric D. Schabell <[email protected]> --------- Signed-off-by: Eric D. Schabell <[email protected]>
1 parent e2be724 commit f10a284

File tree

1 file changed

+26
-20
lines changed

1 file changed

+26
-20
lines changed

‎administration/networking.md‎

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -56,19 +56,25 @@ On Linux, the effective backlog value might be capped by the kernel parameter `n
5656

5757
The following table describes the network configuration properties available and their usage in optimizing performance or adjusting configuration needs for plugins that rely on networking I/O:
5858

59-
| Property | Description | Default |
60-
| :------- |:------------|:--------|
61-
| `net.connect_timeout` | Set maximum time expressed in seconds to wait for a TCP connection to be established, including the TLS handshake time. | `10` |
62-
| `net.connect_timeout_log_error` | On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message. | `true` |
63-
| `net.dns.mode` | Select the primary DNS connection type (TCP or UDP). Can be set in the `[SERVICE]` section and overridden on a per plugin basis if desired. | _none_ |
64-
| `net.dns.prefer_ipv4` | Prioritize IPv4 DNS results when trying to establish a connection. | `false` |
65-
| `net.dns.resolver`| Select the primary DNS resolver type (`LEGACY` or `ASYNC`). | _none_ |
66-
| `net.keepalive` | Enable or disable connection keepalive support. Accepts a Boolean value: `on` or `off`.  | `on` |
67-
| `net.keepalive_idle_timeout` | Set maximum time expressed in seconds for an idle keepalive connection. | `30` |
68-
| `net.keepalive_max_recycle` | Set maximum number of times a keepalive connection can be used before it's retired. | `2000` |
69-
| `net.max_worker_connections` | Set maximum number of TCP connections that can be established per worker. | `0` (unlimited) |
70-
| `net.source_address` | Specify network address to bind for data traffic. | _none_ |
71-
| `net.backlog` | Set the maximum number of pending connections for listening sockets. This option requires Fluent Bit version 4.0.4 or later. | `128` |
59+
| Property | Description | Default |
60+
|:--------------------------------|:-------------------------------------------------------------------------------------------------------------------|:--------|
61+
| `net.connect_timeout` | Set maximum time allowed to establish a connection, this time includes the TLS handshake. | `10s` |
62+
| `net.connect_timeout_log_error` | On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message. | `true` |
63+
| `net.io_timeout` | Set maximum time a connection can stay idle while assigned. | `0s` |
64+
| `net.keepalive` | Enable or disable connection keepalive support. | `true` |
65+
| `net.keepalive_idle_timeout` | Set maximum time expressed in seconds for an idle keepalive connection. | `30s` |
66+
| `net.dns.mode` | Select the primary DNS connection type (`TCP` or `UDP`). | _none_ |
67+
| `net.dns.prefer_ipv4` | Prioritize IPv4 DNS results when trying to establish a connection. | `false` |
68+
| `net.dns.prefer_ipv6` | Prioritize IPv6 DNS results when trying to establish a connection. | `false` |
69+
| `net.dns.resolver` | Select the primary DNS resolver type (`LEGACY` or `ASYNC`). | _none_ |
70+
| `net.keepalive_max_recycle` | Set maximum number of times a keepalive connection can be used before it's retired. | `2000` |
71+
| `net.max_worker_connections` | Set maximum number of TCP connections that can be established per worker. | `0` |
72+
| `net.proxy_env_ignore` | Ignore the environment variables `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` when set. | `false` |
73+
| `net.tcp_keepalive` | Enable or disable Keepalive support. | `off` |
74+
| `net.tcp_keepalive_time` | Interval between the last data packet sent and the first TCP keepalive probe. | `-1` |
75+
| `net.tcp_keepalive_interval` | Interval between TCP keepalive probes when no response is received on a `keepidle` probe. | `-1` |
76+
| `net.tcp_keepalive_probes` | Number of unacknowledged probes to consider a connection dead. | `-1` |
77+
| `net.source_address` | Specify network address to bind for data traffic. | _none_ |
7278

7379
## Example
7480

@@ -97,10 +103,10 @@ pipeline:
97103
format: json_lines
98104
# Networking Setup
99105
net.dns.mode: TCP
100-
net.connect_timeout: 5
106+
net.connect_timeout: 5s
101107
net.source_address: 127.0.0.1
102-
net.keepalive: on
103-
net.keepalive_idle_timeout: 10
108+
net.keepalive: true
109+
net.keepalive_idle_timeout: 10s
104110
```
105111
106112
{% endtab %}
@@ -123,10 +129,10 @@ pipeline:
123129
format json_lines
124130
# Networking Setup
125131
net.dns.mode TCP
126-
net.connect_timeout 5
132+
net.connect_timeout 5s
127133
net.source_address 127.0.0.1
128-
net.keepalive on
129-
net.keepalive_idle_timeout 10
134+
net.keepalive true
135+
net.keepalive_idle_timeout 10s
130136
```
131137

132138
{% endtab %}
@@ -152,4 +158,4 @@ $ nc -l 9090
152158

153159
If the `net.keepalive` option isn't enabled, Fluent Bit closes the TCP connection and netcat quits.
154160

155-
After the five records arrive, the connection idles. After 10 seconds, the connection closes due to `net.keepalive_idle_timeout`.
161+
After the five records arrive, the connection idles. After 10 seconds, the connection closes due to `net.keepalive_idle_timeout`.

0 commit comments

Comments
 (0)