Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
206 lines (130 sloc) 12.4 KB

CheckNet

Network related check such as check_ping.

Queries

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

List of commands:

A list of all available queries (check commands)

Command Description
check_ping Ping another host and check the result.

check_ping

Ping another host and check the result.

#### Command-line Arguments
Option Default Value Description
filter Filter which marks interesting items.
warning time > 60 or loss > 5% Filter which marks items which generates a warning state.
warn Short alias for warning
critical time > 100 or loss > 10% Filter which marks items which generates a critical state.
crit Short alias for critical.
ok Filter which marks items which generates an ok state.
debug N/A Show debugging information in the log
show-all N/A Show details for all matches regardless of status (normally details are only showed for warnings and criticals).
empty-state unknown Return status to use when nothing matched filter.
perf-config Performance data generation configuration
escape-html N/A Escape any < and > characters to prevent HTML encoding
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).
top-syntax ${status}: ${ok_count}/${count} (${problem_list}) Top level syntax.
ok-syntax %(status): All %(count) hosts are ok ok syntax.
empty-syntax No hosts found Empty syntax.
detail-syntax ${ip} Packet loss = ${loss}%, RTA = ${time}ms Detail level syntax.
perf-syntax ${host} Performance alias syntax.
host The host to check (or multiple hosts).
total N/A Include the total of all matching hosts
hosts The host to check (or multiple hosts).
count 1 Number of packets to send.
timeout 500 Timeout in milliseconds.
filter:

Filter which marks interesting items. Interesting items are items which will be included in the check. They do not denote warning or critical state instead it defines which items are relevant and you can remove unwanted items.

warning:

Filter which marks items which generates a warning state. If anything matches this filter the return status will be escalated to warning.

Default Value: time > 60 or loss > 5%

critical:

Filter which marks items which generates a critical state. If anything matches this filter the return status will be escalated to critical.

Default Value: time > 100 or loss > 10%

ok:

Filter which marks items which generates an ok state. If anything matches this any previous state for this item will be reset to ok.

empty-state:

Return status to use when nothing matched filter. If no filter is specified this will never happen unless the file is empty.

Default Value: unknown

perf-config:

Performance data generation configuration TODO: obj ( key: value; key: value) obj (key:valuer;key:value)

top-syntax:

Top level syntax. Used to format the message to return can include text as well as special keywords which will include information from the checks. To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).

Default Value: ${status}: ${ok_count}/${count} (${problem_list})

ok-syntax:

ok syntax. DEPRECATED! This is the syntax for when an ok result is returned. This value will not be used if your syntax contains %(list) or %(count).

Default Value: %(status): All %(count) hosts are ok

empty-syntax:

Empty syntax. DEPRECATED! This is the syntax for when nothing matches the filter.

Default Value: No hosts found

detail-syntax:

Detail level syntax. Used to format each resulting item in the message. %(list) will be replaced with all the items formated by this syntax string in the top-syntax. To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).

Default Value: ${ip} Packet loss = ${loss}%, RTA = ${time}ms

perf-syntax:

Performance alias syntax. This is the syntax for the base names of the performance data.

Default Value: ${host}

count:

Number of packets to send.

Default Value: 1

timeout:

Timeout in milliseconds.

Default Value: 500

#### Filter keywords
Option Description
count Number of items matching the filter. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
host The host name or ip address (as given on command line)
ip The ip address name
list A list of all items which matched the filter. Common option for all checks.
loss Packet loss
ok_count Number of items matched the ok criteria. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
recv Number of packets received from the host
sent Number of packets sent to the host
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
time Round trip time in ms
timeout Number of packets which timed out from the host
total Total number of items. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
You can’t perform that action at this time.