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: outputs: gelf: general doc updates and cleanup (#2433)
- Lowercase all config parameter Key column entries
- Fix incorrect default listings in config parameter table
- Sort configuration parameters table alphabetically
- Fix config parameter table column alignment
- Remove trailing spaces on gelf_full_message_key row
- Fix missing space in mode description: "Allowed values:`tls`" -> "Allowed values: `tls`"
- Fix `gelf_timestamp_key` description: "Should be set in GELF." → "This should be set in GELF."
Applies to #2412
Signed-off-by: Eric D. Schabell <eric@schabell.org>
Copy file name to clipboardExpand all lines: pipeline/outputs/gelf.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,20 +9,20 @@ The following instructions assume that you have a fully operational Graylog serv
9
9
According to the [GELF Payload Specification](https://go2docs.graylog.org/5-0/getting_in_log_data/gelf.html?Highlight=Payload#GELFPayloadSpecification), there are mandatory and optional fields used by Graylog in GELF format. These fields are determined by the `Gelf\_*_Key` key in this plugin.
10
10
11
11
| Key | Description | Default |
12
-
| --- | -----------|------- |
13
-
|`Match`|Pattern to match which tags of logs to be outputted by this plugin. |_none_|
14
-
|`Host`|IP address or hostname of the target Graylog server. |`127.0.0.1`|
15
-
|`Port`|The port that your Graylog GELF input is listening on. |`12201`|
16
-
|`Mode`|The protocol to use. Allowed values:`tls`, `tcp`, `udp`.|`udp`|
17
-
|`Gelf_Tag_Key`|Key to be used for tag. (Optional in GELF.)|_none_|
18
-
|`Gelf_Short_Message_Key`|A short descriptive message. Must be set in GELF. |`short_message`|
19
-
|`Gelf_Timestamp_Key`| Your log timestamp. Should be set in GELF. |`timestamp`|
20
-
|`Gelf_Host_Key`|Key which its value is used as the name of the host, source or application that sent this message. Must be set in GELF. |`host`|
21
-
|`Gelf_Full_Message_Key`|Key to use as the long message that can, for example, contain a backtrace. Optional in GELF. |`full_message`|
22
-
|`Gelf_Level_Key`|Key to be used as the log level. Its value must be in [standard syslog levels](https://en.wikipedia.org/wiki/Syslog#Severity_level) (between `0` and `7`). Optional in GELF. |`level`|
23
-
|`Packet_Size`| If transport protocol is `udp`, you can set the size of packets to be sent. |`1420`|
24
-
|`Compress`|If transport protocol is `udp`, you can set this if you want your UDP packets to be compressed. |`true`|
25
-
|`Workers`| The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. |`0`|
12
+
|:--- |:--- |:--- |
13
+
|`compress`|If transport protocol is `udp`, set this to compress UDP packets. |`true`|
14
+
|`gelf_full_message_key`|Key to use as the long message that can, for example, contain a backtrace. Optional in GELF. |_none_|
15
+
|`gelf_host_key`|Key whose value is used as the name of the host, source, or application that sent this message. Must be set in GELF. |_none_|
16
+
|`gelf_level_key`|Key to be used as the log level. Its value must be in [standard syslog levels](https://en.wikipedia.org/wiki/Syslog#Severity_level) (between `0` and `7`). Optional in GELF. |_none_|
17
+
|`gelf_short_message_key`|A short descriptive message. Must be set in GELF. |_none_|
18
+
|`gelf_tag_key`|Key to be used for tag. Optional in GELF. |_none_|
19
+
|`gelf_timestamp_key`| Your log timestamp. This should be set in GELF. |_none_|
20
+
|`host`|IP address or hostname of the target Graylog server. |`127.0.0.1`|
21
+
|`match`|Pattern to match which tags of logs to be sent by this plugin. |_none_|
22
+
|`mode`|The protocol to use. Allowed values: `tls`, `tcp`, `udp`. |`udp`|
23
+
|`packet_size`| If transport protocol is `udp`, you can set the size of packets to be sent. |`1420`|
24
+
|`port`|The port that your Graylog GELF input is listening on. |`12201`|
25
+
|`workers`| The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. |`0`|
0 commit comments