Document the new template option

This commit is contained in:
Vitaly Pashkov 2017-12-11 15:12:59 +03:00
parent 26d68ec746
commit 57eb8d4e29
1 changed files with 5 additions and 2 deletions

View File

@ -5,10 +5,13 @@ Simple GELF reader application
This is a simple application which opens a network port (currently UDP only) and receives a GELF input from Graylog or any other application. The primary purpose was to be able to filter some messages from many hosts in Graylog and output it onto this reader. Then you can process this aggregated and filtered log with (for example) fail2ban to block attackers on the router, firewall or hypervisor.
Usage:
`gelf-reader [OPTIONS]`
gelf-reader [OPTIONS]
where options is:
-listen <ip>:<port> - the address and port to listen at
-output <filename> - output to file (stdout if omit)
-template <string> - output template (default "{{TimeUnix}} {{Host}}: {{Short}}")
-version - show version and exit
All template tokens should be surrounded by a "{{" and "}}" pair. Supported template tokens:
Facility, Full, Host, Level, RawExtra, Short, TimeUnix, Version
**WARNING:** There are no authentication nor any other host restriction mechanisms, this should be only used in trusted (private and/or properly firewalled) networks.