SyslogClient
Forward information as syslog messages to a syslog server

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  

Queries

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

submit_syslog

SyslogClientsubmit_syslog
Submit information to the remote syslog server.

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)    

Arguments

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

/ settings/ syslog/ client

/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 uppercase

Path: /settings/syslog/client

Key: hostname

Default value: auto

Used by: SyslogClient

Sample:

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

… / handlers

/settings/syslog/client/handlers (SyslogClient)

CLIENT HANDLER SECTION

Sample:

# CLIENT HANDLER SECTION
#
[/settings/syslog/client/handlers]

… / targets

/settings/syslog/client/targets (SyslogClient)

REMOTE TARGET DEFINITIONS

Sample:

# REMOTE TARGET DEFINITIONS
#
[/settings/syslog/client/targets]

… / targets / default

/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 address

Path: /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 port

Advanced (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

… / targets / sample

/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 address

Path: /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 port

Advanced (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
comments powered by Disqus