SyslogClient.md

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.

List of Configuration

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	Description
/settings/syslog/client/targets/default	host	TARGET HOST
/settings/syslog/client/targets/default	port	TARGET PORT

Sample keys

Path / Section	Key	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

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
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](#submit_syslog_tag template)		Tag template (TODO)
[message template](#submit_syslog_message template)		Message template (TODO)

### help

Description: Show help screen (this screen)

### help-pb

Description: Show help screen as a protocol buffer payload

### show-default

Description: Show default values for a given command

### help-short

Description: Show help screen (short format).

### host

Description: The host of the host running the server

### port

Description: The port of the host running the server

### address

Description: The address (host:port) of the host running the server

### timeout

Description: Number of seconds before connection times out (default=10)

### target

Description: Target to use (lookup connection info from config)

### retry

Description: Number of times ti retry a failed connection attempt (default=2)

### retries

Description: legacy version of retry

### source-host

Description: Source/sender host name (default is auto which means use the name of the actual host)

### sender-host

Description: Source/sender host name (default is auto which means use the name of the actual host)

### command

Description: The name of the command that the remote daemon should run

### alias

Description: Same as command

### message

Description: Message

### result

Description: Result code either a number or OK, WARN, CRIT, UNKNOWN

### separator

Description: Separator to use for the batch command (default is |)

### batch

Description: Add multiple records using the separator format is: command|result|message

### path

Description:

### severity

Description: Severity of error message

### unknown-severity

Description: Severity of error message

### ok-severity

Description: Severity of error message

### warning-severity

Description: Severity of error message

### critical-severity

Description: Severity of error message

### facility

Description: Facility of error message

### tag template

Description: Tag template (TODO)

### message template

Description: Message template (TODO)

Configuration

## SYSLOG CLIENT SECTION

Section for SYSLOG passive check module.

# Section for SYSLOG passive check module.
[/settings/syslog/client]
channel=syslog
hostname=auto

Key	Default Value	Description
channel	syslog	CHANNEL
hostname	auto	HOSTNAME

### channel

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

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

# 
[/settings/syslog/client/handlers]

## REMOTE TARGET DEFINITIONS

# 
[/settings/syslog/client/targets]

## TARGET

Target definition for: default

# Target definition for: default
[/settings/syslog/client/targets/default]
retries=3
timeout=30

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

### address

TARGET ADDRESS

Target host address

Key	Description
Path:	/settings/syslog/client/targets/default
Key:	address
Default value:	N/A
Used by:	SyslogClient

Sample

[/settings/syslog/client/targets/default]
# TARGET ADDRESS
address=

### host

TARGET HOST

The target server to report results to.

Key	Description
Path:	/settings/syslog/client/targets/default
Key:	host
Advanced:	Yes (means it is not commonly used)
Default value:	N/A
Used by:	SyslogClient

Sample

[/settings/syslog/client/targets/default]
# TARGET HOST
host=

### port

TARGET PORT

The target server port

Key	Description
Path:	/settings/syslog/client/targets/default
Key:	port
Advanced:	Yes (means it is not commonly used)
Default value:	N/A
Used by:	SyslogClient

Sample

[/settings/syslog/client/targets/default]
# TARGET PORT
port=

### retries

RETRIES

Number of times to retry sending.

Key	Description
Path:	/settings/syslog/client/targets/default
Key:	retries
Default value:	3
Used by:	SyslogClient

Sample

[/settings/syslog/client/targets/default]
# RETRIES
retries=3

### timeout

TIMEOUT

Timeout when reading/writing packets to/from sockets.

Key	Description
Path:	/settings/syslog/client/targets/default
Key:	timeout
Default value:	30
Used by:	SyslogClient

Sample

[/settings/syslog/client/targets/default]
# TIMEOUT
timeout=30

## TARGET

Target definition for: sample

# Target definition for: sample
[/settings/syslog/client/targets/sample]
retries=3
timeout=30

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

### address

TARGET ADDRESS

Target host address

Key	Description
Path:	/settings/syslog/client/targets/sample
Key:	address
Default value:	N/A
Sample key:	Yes (This section is only to show how this key is used)
Used by:	SyslogClient

Sample

[/settings/syslog/client/targets/sample]
# TARGET ADDRESS
address=

### host

TARGET HOST

The target server to report results to.

Key	Description
Path:	/settings/syslog/client/targets/sample
Key:	host
Advanced:	Yes (means it is not commonly used)
Default value:	N/A
Sample key:	Yes (This section is only to show how this key is used)
Used by:	SyslogClient

Sample

[/settings/syslog/client/targets/sample]
# TARGET HOST
host=

### port

TARGET PORT

The target server port

Key	Description
Path:	/settings/syslog/client/targets/sample
Key:	port
Advanced:	Yes (means it is not commonly used)
Default value:	N/A
Sample key:	Yes (This section is only to show how this key is used)
Used by:	SyslogClient

Sample

[/settings/syslog/client/targets/sample]
# TARGET PORT
port=

### retries

RETRIES

Number of times to retry sending.

Key	Description
Path:	/settings/syslog/client/targets/sample
Key:	retries
Default value:	3
Sample key:	Yes (This section is only to show how this key is used)
Used by:	SyslogClient

Sample

[/settings/syslog/client/targets/sample]
# RETRIES
retries=3

### timeout

TIMEOUT

Timeout when reading/writing packets to/from sockets.

Key	Description
Path:	/settings/syslog/client/targets/sample
Key:	timeout
Default value:	30
Sample key:	Yes (This section is only to show how this key is used)
Used by:	SyslogClient

Sample

[/settings/syslog/client/targets/sample]
# TIMEOUT
timeout=30