You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: in_syslog: fix descriptions and typos in config params (#2356)
- Rewrite buffer_chunk_size description for clarity
- Fix "TCP port" to "port" (applies to both TCP and UDP modes)
- Fix typo "OS-dependant" to "OS-dependent"
- Add missing comma in parser description
- Remove redundant "(set in code)" from buffer_chunk_size default
Fixes#2355
Signed-off-by: Eric D. Schabell <eric@schabell.org>
|`buffer_chunk_size`|By default, the buffer to store the incoming `syslog` messages. Doesn't allocate the maximum memory allowed, instead it allocates memory when required. The rounds of allocations are set by `buffer_chunk_size`. There are considerations when using `udp` or `unix_udp` mode. |`32KB`(set in code)|
11
+
|`buffer_chunk_size`|Set the buffer size to store incoming `syslog` messages. Memory is allocated on demand in chunks of this size rather than allocating the maximum allowed upfront. When using `udp` or `unix_udp` mode, this also sets the maximum message size. |`32KB`|
12
12
|`buffer_max_size`| Specify the maximum buffer size to receive a `syslog` message. If not set, the default size is the value of `buffer_chunk_size`. |_none_|
13
13
|`format`| Specify the TCP framing format. Set to `octet_counting` for RFC 6587 compliant octet-counting framing, or `newline` for newline-delimited framing. Only applies to TCP modes (`tcp` or `unix_tcp`). |`newline`|
14
14
|`listen`| If `mode` is set to `tcp` or `udp`, specify the network interface to bind. |`0.0.0.0`|
15
15
|`mode`| Defines transport protocol mode: UDP over Unix socket (`unix_udp`), TCP over Unix socket (`unix_tcp`), `tcp`, or `udp`|`unix_udp`|
16
-
|`parser`| Specify an alternative parser for the message. If `mode` is set to `tcp` or `udp` then the default parser is `syslog-rfc5424`. Otherwise, `syslog-rfc3164-local` is used. If your syslog messages have fractional seconds set this parser value to `syslog-rfc5424` instead. |_none_|
16
+
|`parser`| Specify an alternative parser for the message. If `mode` is set to `tcp` or `udp`, the default parser is `syslog-rfc5424`. Otherwise, `syslog-rfc3164-local` is used. If your syslog messages have fractional seconds, set this parser value to `syslog-rfc5424` instead. |_none_|
17
17
|`path`| If `mode` is set to `unix_tcp` or `unix_udp`, set the absolute path to the Unix socket file. |_none_|
18
-
|`port`| If `mode` is set to `tcp` or `udp`, specify the TCP port to listen for incoming connections.|`5140`|
18
+
|`port`| If `mode` is set to `tcp` or `udp`, specify the port to listen for incoming messages. |`5140`|
19
19
|`raw_message_key`| Specify the key where the original raw `syslog` message will be preserved. |_none_|
20
-
|`receive_buffer_size`| Specify the maximum socket receive buffer size. If not set, the default value is OS-dependant, but generally too low to accept thousands of syslog messages per second without loss on `udp` or `unix_udp` sockets. For Linux, the value is capped by `sysctl net.core.rmem_max`. |_none_|
20
+
|`receive_buffer_size`| Specify the maximum socket receive buffer size. If not set, the default value is OS-dependent, but generally too low to accept thousands of syslog messages per second without loss on `udp` or `unix_udp` sockets. On Linux, the value is capped by `sysctl net.core.rmem_max`.|_none_|
21
21
|`source_address_key`| Specify the key where the source address will be injected. |_none_|
22
22
|`threaded`| Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). |`false`|
23
23
|`unix_perm`| If `mode` is set to `unix_tcp` or `unix_udp`, set the permission of the Unix socket file. |`0644`|
0 commit comments