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
Copy file name to clipboardExpand all lines: pipeline/inputs/syslog.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,22 +8,22 @@ The plugin supports the following configuration parameters:
8
8
9
9
| Key | Description | Default |
10
10
| :--- | :--- | :--- |
11
-
|`Mode`| Defines transport protocol mode: UDP over Unix socket (`unix_udp`), TCP over Unix socket (`unix_tcp`), `tcp`, or `udp`|`unix_udp`|
11
+
|`Mode`| Defines transport protocol mode: UDP over Unix socket (`unix_udp`), TCP over Unix socket (`unix_tcp`), `tcp`, or `udp`|`unix_udp`|
12
12
|`Listen`| If `Mode` is set to `tcp` or `udp`, specify the network interface to bind. |`0.0.0.0`|
13
13
|`Port`| If `Mode` is set to `tcp` or `udp`, specify the TCP port to listen for incoming connections. |`5140`|
14
14
|`Path`| If `Mode` is set to `unix_tcp` or `unix_udp`, set the absolute path to the Unix socket file. |_none_|
15
15
|`Unix_Perm`| If `Mode` is set to `unix_tcp` or `unix_udp`, set the permission of the Unix socket file. |`0644`|
16
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_|
17
17
|`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) |
18
18
|`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_|
19
-
|`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_|
19
+
|`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
20
|`Source_Address_Key`| Specify the key where the source address will be injected. |_none_|
21
21
|`Threaded`| Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). |`false`|
22
22
23
23
### Considerations
24
24
25
-
- When using Syslog input plugin, Fluent Bit requires access to the `parsers.conf` file. The path to this file can be specified with the option `-R` or through the `Parsers_File` key in the `[SERVICE]` section.
26
-
- When using `udp` or `unix_udp`, the buffer size to receive messages is configurable only through the `Buffer_Chunk_Size` option which defaults to 32kb.
25
+
- When using the Syslog input plugin, Fluent Bit requires access to the `parsers.conf` file. The path to this file can be specified with the option `-R` or through the `Parsers_File` key in the `[SERVICE]` section.
26
+
- When using `udp` or `unix_udp`, the buffer size to receive messages is configurable only through the `Buffer_Chunk_Size` option, which defaults to 32kb.
27
27
28
28
## Get started
29
29
@@ -37,7 +37,7 @@ From the command line you can let Fluent Bit listen for `Forward` messages with
0 commit comments