CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add info on Graylog GELF spec (#10745) 

Fixes: #10724
This commit is contained in:
Joshua Powers 2022-02-28 09:20:08 -07:00 committed by GitHub
parent c2458fe6b8
commit ffe0b7e184
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
plugins/outputs/graylog/README.md
View File

@ -4,6 +4,23 @@ This plugin writes to a Graylog instance using the "[GELF][]" format.
[GELF]: https://docs.graylog.org/en/3.1/pages/gelf.html#gelf-payload-specification [GELF]: https://docs.graylog.org/en/3.1/pages/gelf.html#gelf-payload-specification
## GELF Fields
The [GELF spec][] spec defines a number of specific fields in a GELF payload.
These fields may have specific requirements set by the spec and users of the
Graylog plugin need to follow these requirements or metrics may be rejected
due to invalid data.
For example, the timestamp field defined in the GELF spec, is required to be
a UNIX timestamp. This output plugin will not modify or check the timestamp
field if one is present and send it as-is to Graylog. If the field is absent
then Telegraf will set the timestamp to the current time.
Any field not defined by the spec will have an underscore (e.g. `_`) prefixed
to the field name.
[GELF spec]: https://docs.graylog.org/docs/gelf#gelf-payload-specification
## Configuration ## Configuration
```toml ```toml