syslog.md

Syslog

• Category: Syslog
• Website: https://en.wikipedia.org/wiki/Syslog

Table of content

• Syslog
  • Table of content
  • Configuration
  • Example of config.yaml
  • Additional info
  • Screenshots

Configuration

Setting	Env var	Default value	Description
syslog.host	SYSLOG_HOST		Syslog host, if not empty, Syslog output is enabled
syslog.port	SYSLOG_PORT		Syslog endpoint port number
syslog.protocol	SYSLOG_PROTOCOL	tcp	Syslog transport protocol. It can be either tcp or udp
syslog.format	SYSLOG_FORMAT	json	Syslog payload format. It can be either json or cef
syslog.minimumpriority	SYSLOG_MINIMUMPRIORITY	"" (= debug)	Minimum priority of event for using this output, order is emergency,alert,critical,error,warning,notice,informational,debug or ""

Note

The Env var values override the settings from yaml file.

Example of config.yaml

syslog:
  host: "" # Syslog host, if not empty, Syslog output is enabled
  port: "" # Syslog endpoint port number
  # protocol: "" # Syslog transport protocol. It can be either "tcp" or "udp" (default: tcp)
  # format: "" # Syslog payload format. It can be either "json" or "cef" (default: json)
  # minimumpriority: "debug" # minimum priority of event for using this output, order is emergency|alert|critical|error|warning|notice|informational|debug or "" (default)

Additional info

# Recommended version rsyslogd  8.2102 or newer
rsyslogd -v to check the version

Screenshots