SyslogClient
SyslogClient
— SyslogClient¶Forward information as syslog messages to a syslog server
Queries (Overview):
A list of all available queries (check commands)
Command | Description |
---|---|
submit_syslog |
Submit information to the remote syslog server. |
Commands (Overview):
TODO: Add a list of all external commands (this is not check commands)
Configuration (Overview):
Common Keys:
Path / Section | Key | Description |
---|---|---|
/settings/syslog/client |
channel |
CHANNEL |
/settings/syslog/client |
hostname |
HOSTNAME |
/settings/syslog/client/targets/default |
address |
TARGET ADDRESS |
/settings/syslog/client/targets/default |
retries |
RETRIES |
/settings/syslog/client/targets/default |
timeout |
TIMEOUT |
Advanced keys:
Path / Section | Key | Default Value | Description |
---|---|---|---|
/settings/syslog/client/targets/default |
host |
TARGET HOST | |
/settings/syslog/client/targets/default |
port |
TARGET PORT |
Sample keys:
Path / Section | Key | Default Value | Description |
---|---|---|---|
/settings/syslog/client/targets/sample |
address |
TARGET ADDRESS | |
/settings/syslog/client/targets/sample |
host |
TARGET HOST | |
/settings/syslog/client/targets/sample |
port |
TARGET PORT | |
/settings/syslog/client/targets/sample |
retries |
RETRIES | |
/settings/syslog/client/targets/sample |
timeout |
TIMEOUT |
A quick reference for all available queries (check commands) in the SyslogClient module.
submit_syslog
¶SyslogClient
submit_syslog
Usage:
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 | result | message | |
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) |
help
(SyslogClient, submit_syslog)¶help-pb
(SyslogClient, submit_syslog)¶show-default
(SyslogClient, submit_syslog)¶help-short
(SyslogClient, submit_syslog)¶host
(SyslogClient, submit_syslog)¶port
(SyslogClient, submit_syslog)¶address
(SyslogClient, submit_syslog)¶timeout
(SyslogClient, submit_syslog)¶target
(SyslogClient, submit_syslog)¶retry
(SyslogClient, submit_syslog)¶retries
(SyslogClient, submit_syslog)¶source-host
(SyslogClient, submit_syslog)¶sender-host
(SyslogClient, submit_syslog)¶command
(SyslogClient, submit_syslog)¶alias
(SyslogClient, submit_syslog)¶message
(SyslogClient, submit_syslog)¶result
(SyslogClient, submit_syslog)¶batch
(SyslogClient, submit_syslog)¶path
(SyslogClient, submit_syslog)¶severity
(SyslogClient, submit_syslog)¶unknown-severity
(SyslogClient, submit_syslog)¶ok-severity
(SyslogClient, submit_syslog)¶warning-severity
(SyslogClient, submit_syslog)¶critical-severity
(SyslogClient, submit_syslog)¶facility
(SyslogClient, submit_syslog)¶tag template
(SyslogClient, submit_syslog)¶message template
(SyslogClient, submit_syslog)¶/settings/syslog/client
(SyslogClient)¶SYSLOG CLIENT SECTION
Section for SYSLOG passive check module.
Key Default Value Description channel
syslog CHANNEL hostname
auto HOSTNAME Sample:
# SYSLOG CLIENT SECTION # Section for SYSLOG passive check module. [/settings/syslog/client] channel=syslog hostname=auto
channel
(SyslogClient, /settings/syslog/client)¶CHANNEL
The channel to listen to.Path: /settings/syslog/client
Key: channel
Default value: syslog
Used by:
SyslogClient
Sample:
[/settings/syslog/client] # CHANNEL channel=syslog
hostname
(SyslogClient, /settings/syslog/client)¶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 uppercasePath: /settings/syslog/client
Key: hostname
Default value: auto
Used by:
SyslogClient
Sample:
[/settings/syslog/client] # HOSTNAME hostname=auto
/settings/syslog/client/handlers
(SyslogClient)¶CLIENT HANDLER SECTION
Sample:
# CLIENT HANDLER SECTION # [/settings/syslog/client/handlers]
/settings/syslog/client/targets
(SyslogClient)¶REMOTE TARGET DEFINITIONS
Sample:
# REMOTE TARGET DEFINITIONS # [/settings/syslog/client/targets]
/settings/syslog/client/targets/default
(SyslogClient)¶TARGET
Target definition for: default
Key Default Value Description address
TARGET ADDRESS host
TARGET HOST port
TARGET PORT retries
3 RETRIES timeout
30 TIMEOUT Sample:
# TARGET # Target definition for: default [/settings/syslog/client/targets/default] address= host= port= retries=3 timeout=30
address
(SyslogClient, /settings/syslog/client/targets/default)¶TARGET ADDRESS
Target host addressPath: /settings/syslog/client/targets/default
Key: address
Default value:
Used by:
SyslogClient
Sample:
[/settings/syslog/client/targets/default] # TARGET ADDRESS address=
host
(SyslogClient, /settings/syslog/client/targets/default)¶TARGET HOST
The target server to report results to.Advanced (means it is not commonly used)
Path: /settings/syslog/client/targets/default
Key: host
Default value:
Used by:
SyslogClient
Sample:
[/settings/syslog/client/targets/default] # TARGET HOST host=
port
(SyslogClient, /settings/syslog/client/targets/default)¶TARGET PORT
The target server portAdvanced (means it is not commonly used)
Path: /settings/syslog/client/targets/default
Key: port
Default value:
Used by:
SyslogClient
Sample:
[/settings/syslog/client/targets/default] # TARGET PORT port=
retries
(SyslogClient, /settings/syslog/client/targets/default)¶RETRIES
Number of times to retry sending.Path: /settings/syslog/client/targets/default
Key: retries
Default value: 3
Used by:
SyslogClient
Sample:
[/settings/syslog/client/targets/default] # RETRIES retries=3
timeout
(SyslogClient, /settings/syslog/client/targets/default)¶TIMEOUT
Timeout when reading/writing packets to/from sockets.Path: /settings/syslog/client/targets/default
Key: timeout
Default value: 30
Used by:
SyslogClient
Sample:
[/settings/syslog/client/targets/default] # TIMEOUT timeout=30
/settings/syslog/client/targets/sample
(SyslogClient)¶TARGET
Target definition for: sample
Key Default Value Description address
TARGET ADDRESS host
TARGET HOST port
TARGET PORT retries
3 RETRIES timeout
30 TIMEOUT Sample:
# TARGET # Target definition for: sample [/settings/syslog/client/targets/sample] address= host= port= retries=3 timeout=30
address
(SyslogClient, /settings/syslog/client/targets/sample)¶TARGET ADDRESS
Target host addressPath: /settings/syslog/client/targets/sample
Key: address
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
SyslogClient
Sample:
[/settings/syslog/client/targets/sample] # TARGET ADDRESS address=
host
(SyslogClient, /settings/syslog/client/targets/sample)¶TARGET HOST
The target server to report results to.Advanced (means it is not commonly used)
Path: /settings/syslog/client/targets/sample
Key: host
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
SyslogClient
Sample:
[/settings/syslog/client/targets/sample] # TARGET HOST host=
port
(SyslogClient, /settings/syslog/client/targets/sample)¶TARGET PORT
The target server portAdvanced (means it is not commonly used)
Path: /settings/syslog/client/targets/sample
Key: port
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
SyslogClient
Sample:
[/settings/syslog/client/targets/sample] # TARGET PORT port=
retries
(SyslogClient, /settings/syslog/client/targets/sample)¶RETRIES
Number of times to retry sending.Path: /settings/syslog/client/targets/sample
Key: retries
Default value: 3
Sample key: This key is provided as a sample to show how to configure objects
Used by:
SyslogClient
Sample:
[/settings/syslog/client/targets/sample] # RETRIES retries=3
timeout
(SyslogClient, /settings/syslog/client/targets/sample)¶TIMEOUT
Timeout when reading/writing packets to/from sockets.Path: /settings/syslog/client/targets/sample
Key: timeout
Default value: 30
Sample key: This key is provided as a sample to show how to configure objects
Used by:
SyslogClient
Sample:
[/settings/syslog/client/targets/sample] # TIMEOUT timeout=30