SyslogClient

Forward information as syslog messages to a syslog server

List of commands:

A list of all available queries (check commands)

Command Description
submit_syslog Submit information to the remote syslog server.

Configuration Keys:

Path / Section Key Description
/settings/syslog/client channel CHANNEL
/settings/syslog/client hostname HOSTNAME
Path / Section Description
/settings/syslog/client/handlers CLIENT HANDLER SECTION
/settings/syslog/client/targets REMOTE TARGET DEFINITIONS

Queries

A quick reference for all available queries (check commands) in the SyslogClient module.

submit_syslog

Submit information to the remote syslog server.

Command-line Arguments

Option Default Value Description
help N/A Show help screen (this screen)
help-pb N/A Show help screen as a protocol buffer payload
show-default N/A Show default values for a given command
help-short N/A Show help screen (short format).
host The host of the host running the server
port The port of the host running the server
address The address (host:port) of the host running the server
timeout Number of seconds before connection times out (default=10)
target Target to use (lookup connection info from config)
retry Number of times ti retry a failed connection attempt (default=2)
retries legacy version of retry
source-host Source/sender host name (default is auto which means use the name of the actual host)
sender-host Source/sender host name (default is auto which means use the name of the actual host)
command The name of the command that the remote daemon should run
alias Same as command
message Message
result Result code either a number or OK, WARN, CRIT, UNKNOWN
separator Separator to use for the batch command (default is
batch Add multiple records using the separator format is: command
path
severity Severity of error message
unknown-severity Severity of error message
ok-severity Severity of error message
warning-severity Severity of error message
critical-severity Severity of error message
facility Facility of error message
tag template Tag template (TODO)
message template Message template (TODO)

Configuration

SYSLOG CLIENT SECTION

Section for SYSLOG passive check module.

Key Default Value Description
channel syslog CHANNEL
hostname auto HOSTNAME
# Section for SYSLOG passive check module.
[/settings/syslog/client]
channel=syslog
hostname=auto

CHANNEL

The channel to listen to.

Key Description
Path: /settings/syslog/client
Key: channel
Default value: syslog
Used by: SyslogClient

Sample:

[/settings/syslog/client]
# CHANNEL
channel=syslog

HOSTNAME

The host name of the monitored computer. Set this to auto (default) to use the windows name of the computer.

auto Hostname ${host} Hostname ${host_lc} Hostname in lowercase ${host_uc} Hostname in uppercase ${domain} Domainname ${domain_lc} Domainname in lowercase ${domain_uc} Domainname in uppercase

Key Description
Path: /settings/syslog/client
Key: hostname
Default value: auto
Used by: SyslogClient

Sample:

[/settings/syslog/client]
# HOSTNAME
hostname=auto

CLIENT HANDLER SECTION

This is a section of objects. This means that you will create objects below this point by adding sections which all look the same.

REMOTE TARGET DEFINITIONS

This is a section of objects. This means that you will create objects below this point by adding sections which all look the same.

Keys:

Key Default Value Description
address TARGET ADDRESS
host TARGET HOST
port TARGET PORT
retries 3 RETRIES
timeout 30 TIMEOUT

Sample:

# An example of a REMOTE TARGET DEFINITIONS section
[/settings/syslog/client/targets/sample]
#address=...
#host=...
#port=...
retries=3
timeout=30