Skip to content

Commit e08751f

Browse files
eschabelleschabell
authored
Merge branch 'master' into erics_log_metrics_filter_updates
Signed-off-by: Eric D. Schabell <[email protected]>
2 parents e1b9032 + 13f1738 commit e08751f

File tree

4 files changed

+116
-57
lines changed

4 files changed

+116
-57
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`.

‎administration/transport-security.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Both input and output plugins that perform Network I/O can optionally enable TLS
88
| Property | Description | Default |
99
|:----------------------|:----------------------------------------------------------------------------------------------------------------------------------------|:--------|
1010
| `tls` | Enable or disable TLS support. | `off` |
11-
| `tls.debug` | Set TLS debug verbosity level. Accepted values: `0` (No debug), `1` (Error), `2` (State change), `3` (Informational) and `4`. (Verbose) | `1` |
11+
| `tls.debug` | Set TLS debug verbosity level. Accepted values: `0` (No debug), `1` (Error), `2` (State change), `3` (Informational) and `4` (Verbose). | `1` |
1212
| `tls.ca_file` | Absolute path to CA certificate file. | _none_ |
1313
| `tls.ca_path` | Absolute path to scan for certificate files. | _none_ |
1414
| `tls.ciphers` | Specify TLS ciphers up to TLSv1.2. | _none_ |

‎pipeline/inputs/prometheus-textfile.md‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,21 @@ The _Prometheus text file_ input plugin allows Fluent Bit to read metrics from P
44

55
## Configuration parameters
66

7-
| Key | Description | Default |
8-
|-----|-------------|---------|
9-
| `path` | File or directory path pattern. Supports glob patterns with `*` wildcard (for example, `/var/lib/prometheus/*.prom`). | _none_ |
10-
| `scrape_interval` | Interval in seconds between file scans. | `10s` |
7+
| Key | Description | Default |
8+
|-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
9+
| `alias` | Sets an alias, useful for multiple instances of the same input plugin. If no alias is specified, a default name will be assigned using the plugin name followed by a dot and a sequence number (`cpu.0`, `cpu.1`). | _none_ |
10+
| `log_level` | Specifies the log level for output plugin. If not set here, plugin uses global log level in `service` section. | `info` |
11+
| `log_supress_interval` | Suppresses log messages from output plugin that appear similar within a specified time interval. `0` no suppression. | `0` |
12+
| `mem_buf_limit` | Set a memory buffer limit for the input plugin. If the limit is reached, the plugin will pause until the buffer is drained. The value is in bytes. If set to 0, the buffer limit is disabled. | `0` |
13+
| `path` | File or directory path pattern. Supports glob patterns with `*` wildcard (for example, `/var/lib/prometheus/*.prom`). | _none_ |
14+
| `routable` | If set to `true`, the data generated by the plugin will be routable, meaning that it can be forwarded to other plugins or outputs. If set to `false`, the data will be discarded. | `true` |
15+
| `scrape_interval` | Interval in seconds between file scans. | `10s` |
16+
| `storage.pause_on_chunks_overlimit` | Enable pausing on an input when they reach their chunks limit. | _none_ |
17+
| `storage.type` | Sets the storage type for this input, one of: `filesystem`, `memory` or `memrb`. | `memory` |
18+
| `tag` | Set a tag for the events generated by this input plugin. | _none_ |
19+
| `threaded` | Enable threading on an input. | `false` |
20+
| `thread.ring_buffer.capacity` | Set custom ring buffer capacity when the input runs in threaded mode. | `1024` |
21+
| `thread.ring_buffer.window` | Set custom ring buffer window percentage for threaded inputs. | `5` |
1122

1223
## Get started
1324

0 commit comments

Comments
 (0)