CheckSystem
CheckSystem
— CheckSystem¶Various system related checks, such as CPU load, process state, service state memory usage and PDH counters.
Queries (Overview):
A list of all available queries (check commands)
Command | Description |
---|---|
check_cpu |
Check that the load of the CPU(s) are within bounds. |
check_memory |
Check free/used memory on the system. |
check_os_version |
Check the version of the underlaying OS. |
check_pagefile |
Check the size of the system pagefile(s). |
check_pdh |
Check the value of a performance (PDH) counter. |
check_process |
Check state/metrics of one or more of the processes running on the computer. |
check_service |
Check the state of one or more of the computer services. |
check_uptime |
Check time since last server re-boot. |
checkcounter |
Legacy version of check_pdh |
checkcpu |
Legacy version of check_cpu |
checkmem |
Legacy version of check_mem |
checkprocstate |
Legacy version of check_process |
checkservicestate |
Legacy version of check_service |
checkuptime |
Legacy version of check_uptime |
Aliases (Overview):
A list of all short hand aliases for queries (check commands)
Command | Description |
---|---|
check_counter | Alias for: check_pdh |
Commands (Overview):
TODO: Add a list of all external commands (this is not check commands)
Configuration (Overview):
Common Keys:
Path / Section | Key | Description |
---|---|---|
/settings/system/windows |
default buffer length |
DEFAULT LENGTH |
Advanced keys:
Path / Section | Key | Default Value | Description |
---|---|---|---|
/settings/system/windows |
subsystem |
PDH SUBSYSTEM |
Sample keys:
A quick reference for all available queries (check commands) in the CheckSystem module.
check_cpu
¶CheckSystem
check_cpu
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). |
debug |
N/A | Show debugging information in the log |
show-all |
N/A | Show debugging information in the log |
filter |
core = ‘total’ | Filter which marks interesting items. |
warning |
load > 80 | Filter which marks items which generates a warning state. |
warn |
Short alias for warning | |
critical |
load > 90 | Filter which marks items which generates a critical state. |
crit |
Short alias for critical. | |
ok |
Filter which marks items which generates an ok state. | |
empty-state |
ignored | Return status to use when nothing matched filter. |
perf-config |
Performance data generation configuration | |
top-syntax |
${status}: ${problem_list} | Top level syntax. |
ok-syntax |
%(status): CPU load is ok. | ok syntax. |
empty-syntax |
Empty syntax. | |
detail-syntax |
${time}: ${load}% | Detail level syntax. |
perf-syntax |
${core} ${time} | Performance alias syntax. |
time |
The time to check |
Default check:
check_cpu
CPU Load ok
'total 5m load'=0%;80;90 'total 1m load'=0%;80;90 'total 5s load'=7%;80;90
Checking all cores by adding filter=none (disabling the filter):
check_cpu filter=none “warn=load > 80” “crit=load > 90” CPU Load ok ‘core 0 5m kernel’=1%;10;0 ‘core 0 5m load’=3%;80;90 ‘core 1 5m kernel’=0%;10;0 ‘core 1 5m load’=0%;80;90 ... ‘core 7 5s load’=15%;80;90 ‘total 5s kernel’=3%;10;0 ‘total 5s load’=7%;80;90
Adding kernel times to the check:
check_cpu filter=none "warn=kernel > 10 or load > 80" "crit=load > 90" "top-syntax=${list}"
core 0 > 3, core 1 > 0, core 2 > 0, core ... , core 7 > 15, total > 7
'core 0 5m kernel'=1%;10;0 'core 0 5m load'=3%;80;90 'core 1 5m kernel'=0%;10;0 'core 1 5m load'=0%;80;90 ... 'core 7 5s load'=15%;80;90 'total 5s kernel'=3%;10;0 'total 5s load'=7%;80;90
Default check via NRPE:
check_nscp --host 192.168.56.103 --command check_cpu
CPU Load ok|'total 5m'=16%;80;90 'total 1m'=13%;80;90 'total 5s'=13%;80;90
help
(CheckSystem, check_cpu)¶help-pb
(CheckSystem, check_cpu)¶show-default
(CheckSystem, check_cpu)¶help-short
(CheckSystem, check_cpu)¶debug
(CheckSystem, check_cpu)¶show-all
(CheckSystem, check_cpu)¶filter
(CheckSystem, check_cpu)¶Key | Value |
core | The core to check (total or core ##) |
core_id | The core to check (total or core_##) |
idle | The current idle load for a given core |
kernel | The current kernel load for a given core |
load | The current load for a given core |
time | The time frame to check |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
warning
(CheckSystem, check_cpu)¶Key | Value |
core | The core to check (total or core ##) |
core_id | The core to check (total or core_##) |
idle | The current idle load for a given core |
kernel | The current kernel load for a given core |
load | The current load for a given core |
time | The time frame to check |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
warn
(CheckSystem, check_cpu)¶critical
(CheckSystem, check_cpu)¶Key | Value |
core | The core to check (total or core ##) |
core_id | The core to check (total or core_##) |
idle | The current idle load for a given core |
kernel | The current kernel load for a given core |
load | The current load for a given core |
time | The time frame to check |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
crit
(CheckSystem, check_cpu)¶ok
(CheckSystem, check_cpu)¶Key | Value |
core | The core to check (total or core ##) |
core_id | The core to check (total or core_##) |
idle | The current idle load for a given core |
kernel | The current kernel load for a given core |
load | The current load for a given core |
time | The time frame to check |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
empty-state
(CheckSystem, check_cpu)¶perf-config
(CheckSystem, check_cpu)¶top-syntax
(CheckSystem, check_cpu)¶Key | Value |
%(core) | The core to check (total or core ##) |
%(core_id) | The core to check (total or core_##) |
%(idle) | The current idle load for a given core |
%(kernel) | The current kernel load for a given core |
%(load) | The current load for a given core |
%(time) | The time frame to check |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
ok-syntax
(CheckSystem, check_cpu)¶empty-syntax
(CheckSystem, check_cpu)¶Key | Value |
%(core) | The core to check (total or core ##) |
%(core_id) | The core to check (total or core_##) |
%(idle) | The current idle load for a given core |
%(kernel) | The current kernel load for a given core |
%(load) | The current load for a given core |
%(time) | The time frame to check |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
detail-syntax
(CheckSystem, check_cpu)¶Key | Value |
%(core) | The core to check (total or core ##) |
%(core_id) | The core to check (total or core_##) |
%(idle) | The current idle load for a given core |
%(kernel) | The current kernel load for a given core |
%(load) | The current load for a given core |
%(time) | The time frame to check |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
perf-syntax
(CheckSystem, check_cpu)¶Key | Value |
%(core) | The core to check (total or core ##) |
%(core_id) | The core to check (total or core_##) |
%(idle) | The current idle load for a given core |
%(kernel) | The current kernel load for a given core |
%(load) | The current load for a given core |
%(time) | The time frame to check |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
time
(CheckSystem, check_cpu)¶check_memory
¶CheckSystem
check_memory
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). |
debug |
N/A | Show debugging information in the log |
show-all |
N/A | Show debugging information in the log |
filter |
Filter which marks interesting items. | |
warning |
used > 80% | Filter which marks items which generates a warning state. |
warn |
Short alias for warning | |
critical |
used > 90% | Filter which marks items which generates a critical state. |
crit |
Short alias for critical. | |
ok |
Filter which marks items which generates an ok state. | |
empty-state |
ignored | Return status to use when nothing matched filter. |
perf-config |
Performance data generation configuration | |
top-syntax |
${status}: ${list} | Top level syntax. |
ok-syntax |
ok syntax. | |
empty-syntax |
Empty syntax. | |
detail-syntax |
${type} = ${used} | Detail level syntax. |
perf-syntax |
${type} | Performance alias syntax. |
type |
The type of memory to check (physical = Physical memory (RAM), committed = total memory (RAM+PAGE) |
Default check:
check_memory
OK memory within bounds.
'page used'=8G;19;21 'page used %'=33%;79;89 'physical used'=7G;9;10 'physical used %'=65%;79;89
Using –show-all to show the result:
check_memory "warn=free < 20%" "crit=free < 10G" --show-all
page = 8.05G, physical = 7.85G
'page free'=15G;4;2 'page free %'=66%;19;9 'physical free'=4G;2;1 'physical free %'=34%;19;9
Changing the return syntax to include more information:
check_memory "top-syntax=${list}" "detail-syntax=${type} free: ${free} used: ${used} size: ${size}"
page free: 16G used: 7.98G size: 24G, physical free: 4.18G used: 7.8G size: 12G
Default check via NRPE:
check_nrpe --host 192.168.56.103 --command check_memory
OK memory within bounds.|'page'=531G;3;3;0;3 'page %'=12%;79;89;0;100 'physical'=530G;1;1;0;1 'physical %'=25%;79;89;0;100
help
(CheckSystem, check_memory)¶help-pb
(CheckSystem, check_memory)¶show-default
(CheckSystem, check_memory)¶help-short
(CheckSystem, check_memory)¶debug
(CheckSystem, check_memory)¶show-all
(CheckSystem, check_memory)¶filter
(CheckSystem, check_memory)¶Key | Value |
free | Free memory in bytes (g,m,k,b) or percentages % |
free_pct | % free memory |
size | Total size of memory |
type | The type of memory to check |
used | Used memory in bytes (g,m,k,b) or percentages % |
used_pct | % used memory |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
warning
(CheckSystem, check_memory)¶Key | Value |
free | Free memory in bytes (g,m,k,b) or percentages % |
free_pct | % free memory |
size | Total size of memory |
type | The type of memory to check |
used | Used memory in bytes (g,m,k,b) or percentages % |
used_pct | % used memory |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
warn
(CheckSystem, check_memory)¶critical
(CheckSystem, check_memory)¶Key | Value |
free | Free memory in bytes (g,m,k,b) or percentages % |
free_pct | % free memory |
size | Total size of memory |
type | The type of memory to check |
used | Used memory in bytes (g,m,k,b) or percentages % |
used_pct | % used memory |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
crit
(CheckSystem, check_memory)¶ok
(CheckSystem, check_memory)¶Key | Value |
free | Free memory in bytes (g,m,k,b) or percentages % |
free_pct | % free memory |
size | Total size of memory |
type | The type of memory to check |
used | Used memory in bytes (g,m,k,b) or percentages % |
used_pct | % used memory |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
empty-state
(CheckSystem, check_memory)¶perf-config
(CheckSystem, check_memory)¶top-syntax
(CheckSystem, check_memory)¶Key | Value |
%(free) | Free memory in bytes (g,m,k,b) or percentages % |
%(free_pct) | % free memory |
%(size) | Total size of memory |
%(type) | The type of memory to check |
%(used) | Used memory in bytes (g,m,k,b) or percentages % |
%(used_pct) | % used memory |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
ok-syntax
(CheckSystem, check_memory)¶empty-syntax
(CheckSystem, check_memory)¶Key | Value |
%(free) | Free memory in bytes (g,m,k,b) or percentages % |
%(free_pct) | % free memory |
%(size) | Total size of memory |
%(type) | The type of memory to check |
%(used) | Used memory in bytes (g,m,k,b) or percentages % |
%(used_pct) | % used memory |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
detail-syntax
(CheckSystem, check_memory)¶Key | Value |
%(free) | Free memory in bytes (g,m,k,b) or percentages % |
%(free_pct) | % free memory |
%(size) | Total size of memory |
%(type) | The type of memory to check |
%(used) | Used memory in bytes (g,m,k,b) or percentages % |
%(used_pct) | % used memory |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
perf-syntax
(CheckSystem, check_memory)¶Key | Value |
%(free) | Free memory in bytes (g,m,k,b) or percentages % |
%(free_pct) | % free memory |
%(size) | Total size of memory |
%(type) | The type of memory to check |
%(used) | Used memory in bytes (g,m,k,b) or percentages % |
%(used_pct) | % used memory |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
type
(CheckSystem, check_memory)¶check_os_version
¶CheckSystem
check_os_version
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). |
debug |
N/A | Show debugging information in the log |
show-all |
N/A | Show debugging information in the log |
filter |
Filter which marks interesting items. | |
warning |
version <= 50 | Filter which marks items which generates a warning state. |
warn |
Short alias for warning | |
critical |
version <= 50 | Filter which marks items which generates a critical state. |
crit |
Short alias for critical. | |
ok |
Filter which marks items which generates an ok state. | |
empty-state |
ignored | Return status to use when nothing matched filter. |
perf-config |
Performance data generation configuration | |
top-syntax |
${status}: ${list} | Top level syntax. |
ok-syntax |
ok syntax. | |
empty-syntax |
Empty syntax. | |
detail-syntax |
${version} (${major}.${minor}.${build}) | Detail level syntax. |
perf-syntax |
version | Performance alias syntax. |
Default check:
check_os_Version
L client CRITICAL: Windows 7 (6.1.7601)
L client Performance data: 'version'=61;50;50
Making sure the OS version is Windows 8:
check_os_Version "warn=version < 62"
L client WARNING: Windows 7 (6.1.7601)
L client Performance data: 'version'=61;62;0
Default check via NRPE:
check_nrpe --host 192.168.56.103 --command check_os_version
Windows 2012 (6.2.9200)|'version'=62;50;50
help
(CheckSystem, check_os_version)¶help-pb
(CheckSystem, check_os_version)¶show-default
(CheckSystem, check_os_version)¶help-short
(CheckSystem, check_os_version)¶debug
(CheckSystem, check_os_version)¶show-all
(CheckSystem, check_os_version)¶filter
(CheckSystem, check_os_version)¶Key | Value |
build | Build version number |
major | Major version number |
minor | Minor version number |
version | The system version |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
warning
(CheckSystem, check_os_version)¶Key | Value |
build | Build version number |
major | Major version number |
minor | Minor version number |
version | The system version |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
warn
(CheckSystem, check_os_version)¶critical
(CheckSystem, check_os_version)¶Key | Value |
build | Build version number |
major | Major version number |
minor | Minor version number |
version | The system version |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
crit
(CheckSystem, check_os_version)¶ok
(CheckSystem, check_os_version)¶Key | Value |
build | Build version number |
major | Major version number |
minor | Minor version number |
version | The system version |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
empty-state
(CheckSystem, check_os_version)¶perf-config
(CheckSystem, check_os_version)¶top-syntax
(CheckSystem, check_os_version)¶Key | Value |
%(build) | Build version number |
%(major) | Major version number |
%(minor) | Minor version number |
%(version) | The system version |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
ok-syntax
(CheckSystem, check_os_version)¶empty-syntax
(CheckSystem, check_os_version)¶Key | Value |
%(build) | Build version number |
%(major) | Major version number |
%(minor) | Minor version number |
%(version) | The system version |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
detail-syntax
(CheckSystem, check_os_version)¶Key | Value |
%(build) | Build version number |
%(major) | Major version number |
%(minor) | Minor version number |
%(version) | The system version |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
perf-syntax
(CheckSystem, check_os_version)¶Key | Value |
%(build) | Build version number |
%(major) | Major version number |
%(minor) | Minor version number |
%(version) | The system version |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
check_pagefile
¶CheckSystem
check_pagefile
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). |
debug |
N/A | Show debugging information in the log |
show-all |
N/A | Show debugging information in the log |
filter |
Filter which marks interesting items. | |
warning |
used > 60% | Filter which marks items which generates a warning state. |
warn |
Short alias for warning | |
critical |
used > 80% | Filter which marks items which generates a critical state. |
crit |
Short alias for critical. | |
ok |
Filter which marks items which generates an ok state. | |
empty-state |
ignored | Return status to use when nothing matched filter. |
perf-config |
Performance data generation configuration | |
top-syntax |
${status}: ${list} | Top level syntax. |
ok-syntax |
ok syntax. | |
empty-syntax |
Empty syntax. | |
detail-syntax |
${name} ${used} (${size}) | Detail level syntax. |
perf-syntax |
${name} | Performance alias syntax. |
Default options:
check_pagefile
L client WARNING: \Device\HarddiskVolume2\pagefile.sys 24.3M (32M)
L client Performance data: '\??\D:\pagefile.sys'=1G;14;19;0;23 '\??\D:\pagefile.sys %'=6%;59;79;0;100 '\Device\HarddiskVolume2\pagefile.sys'=24M;19;25;0;32 '\Device\HarddiskVolume2\pagefile.sys %'=75%;59;79;0;100 'total'=1G;14;19;0;23 'total %'=6%;59;79;0;100
Only showing the total amount of pagefile usage:
check_pagefile "filter=name = 'total'" "top-syntax=${list}"
OK: total 1.66G (24G)
Performance data: 'total'=1G;14;19;0;23 'total %'=6%;59;79;0;100
Getting help on avalible options:
check_pagefile help
...
filter=ARG Filter which marks interesting items.
Interesting items are items which will be included in
the check.
They do not denote warning or critical state but they
are checked use this to filter out unwanted items.
Avalible options:
free Free memory in bytes (g,m,k,b) or percentages %
name The name of the page file (location)
size Total size of pagefile
used Used memory in bytes (g,m,k,b) or percentages %
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
...
help
(CheckSystem, check_pagefile)¶help-pb
(CheckSystem, check_pagefile)¶show-default
(CheckSystem, check_pagefile)¶help-short
(CheckSystem, check_pagefile)¶debug
(CheckSystem, check_pagefile)¶show-all
(CheckSystem, check_pagefile)¶filter
(CheckSystem, check_pagefile)¶Key | Value |
free | Free memory in bytes (g,m,k,b) or percentages % |
free_pct | % free memory |
name | The name of the page file (location) |
size | Total size of pagefile |
used | Used memory in bytes (g,m,k,b) or percentages % |
used_pct | % used memory |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
warning
(CheckSystem, check_pagefile)¶Key | Value |
free | Free memory in bytes (g,m,k,b) or percentages % |
free_pct | % free memory |
name | The name of the page file (location) |
size | Total size of pagefile |
used | Used memory in bytes (g,m,k,b) or percentages % |
used_pct | % used memory |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
warn
(CheckSystem, check_pagefile)¶critical
(CheckSystem, check_pagefile)¶Key | Value |
free | Free memory in bytes (g,m,k,b) or percentages % |
free_pct | % free memory |
name | The name of the page file (location) |
size | Total size of pagefile |
used | Used memory in bytes (g,m,k,b) or percentages % |
used_pct | % used memory |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
crit
(CheckSystem, check_pagefile)¶ok
(CheckSystem, check_pagefile)¶Key | Value |
free | Free memory in bytes (g,m,k,b) or percentages % |
free_pct | % free memory |
name | The name of the page file (location) |
size | Total size of pagefile |
used | Used memory in bytes (g,m,k,b) or percentages % |
used_pct | % used memory |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
empty-state
(CheckSystem, check_pagefile)¶perf-config
(CheckSystem, check_pagefile)¶top-syntax
(CheckSystem, check_pagefile)¶Key | Value |
%(free) | Free memory in bytes (g,m,k,b) or percentages % |
%(free_pct) | % free memory |
%(name) | The name of the page file (location) |
%(size) | Total size of pagefile |
%(used) | Used memory in bytes (g,m,k,b) or percentages % |
%(used_pct) | % used memory |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
ok-syntax
(CheckSystem, check_pagefile)¶empty-syntax
(CheckSystem, check_pagefile)¶Key | Value |
%(free) | Free memory in bytes (g,m,k,b) or percentages % |
%(free_pct) | % free memory |
%(name) | The name of the page file (location) |
%(size) | Total size of pagefile |
%(used) | Used memory in bytes (g,m,k,b) or percentages % |
%(used_pct) | % used memory |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
detail-syntax
(CheckSystem, check_pagefile)¶Key | Value |
%(free) | Free memory in bytes (g,m,k,b) or percentages % |
%(free_pct) | % free memory |
%(name) | The name of the page file (location) |
%(size) | Total size of pagefile |
%(used) | Used memory in bytes (g,m,k,b) or percentages % |
%(used_pct) | % used memory |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
perf-syntax
(CheckSystem, check_pagefile)¶Key | Value |
%(free) | Free memory in bytes (g,m,k,b) or percentages % |
%(free_pct) | % free memory |
%(name) | The name of the page file (location) |
%(size) | Total size of pagefile |
%(used) | Used memory in bytes (g,m,k,b) or percentages % |
%(used_pct) | % used memory |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
check_pdh
¶CheckSystem
check_pdh
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). |
debug |
N/A | Show debugging information in the log |
show-all |
N/A | Show debugging information in the log |
filter |
Filter which marks interesting items. | |
warning |
Filter which marks items which generates a warning state. | |
warn |
Short alias for warning | |
critical |
Filter which marks items which generates a critical state. | |
crit |
Short alias for critical. | |
ok |
Filter which marks items which generates an ok state. | |
empty-state |
unknown | Return status to use when nothing matched filter. |
perf-config |
Performance data generation configuration | |
top-syntax |
${status}: ${list} | Top level syntax. |
ok-syntax |
ok syntax. | |
empty-syntax |
Empty syntax. | |
detail-syntax |
${alias} = ${value} | Detail level syntax. |
perf-syntax |
${alias} | Performance alias syntax. |
counter |
Performance counter to check | |
expand-index |
N/A | Expand indexes in counter strings |
instances |
N/A | Expand wildcards and fetch all instances |
reload |
N/A | Reload counters on errors (useful to check counters which are not added at boot) |
averages |
N/A | Check average values (ie. wait for 1 second to collecting two samples) |
time |
Timeframe to use for named rrd counters | |
flags |
Extra flags to configure the counter (nocap100, 1000, noscale) | |
type |
large | Format of value (double, long, large) |
Checking specific Counter (SystemSystem Up Time)
check_pdh "counter=\\System\\System Up Time" "warn=value > 5" "crit=value > 9999"
\System\System Up Time = 204213
'\System\System Up Time value'=204213;5;9999
Using the expand index to check for translated counters:
check_pdh "counter=\\4\\30" "warn=value > 5" "crit=value > 9999" expand-index
Everything looks good
'\Minne\Dedikationsgräns value'=-2147483648;5;9999
Checking translated counters without expanding indexes:
check_pdh "counter=\\4\\30" "warn=value > 5" "crit=value > 9999"
Everything looks good
'\4\30 value'=-2147483648;5;9999
Checking large values using the type=large keyword:
check_pdh "counter=\\4\\30" "warn=value > 5" "crit=value > 9999" flags=nocap100 expand-index type=large
\Minne\Dedikationsgräns = 25729224704
'\Minne\Dedikationsgräns value'=25729224704;5;9999
Using real-time checks to check avergae values over time.
Here we configure a counter to be checked at regular intervals and the value is added to a rrd buffer. The configuration from nsclient.ini:
[/settings/system/windows/counters/foo]
collection strategy=rrd
type=large
counter=\Processor(_total)\% Processor Time
Then we can check the value (current snapshot):
check_pdh "counter=foo" "warn=value > 80" "crit=value > 90"
Everything looks good
'foo value'=18;80;90
To check averages from the same counter we need to specify the time option:
check_pdh "counter=foo" "warn=value > 80" "crit=value > 90" time=30s
Everything looks good
'foo value'=3;80;90
Checking all instances of a given counter:
check_pdh "counter=\Processor(*)\% processortid" instances
L client OK: \\MIME-LAPTOP\Processor(0)\% processortid = 100, \\MIME-LAPTOP\Processor(1)\% processortid = 100, \\MIME-LAPTOP\Processor(2)\% processortid = 100, \\MIME-LAPTOP\Processor(3)\% processortid = 100, \\MIME-LAPTOP\Processor(4)\% processortid = 100, \\MIME-LAPTOP\Processor(5)\% processortid = 100, \\MIME-LAPTOP\Processor(6)\% processortid = 100, \\MIME-LAPTOP\Processor(7)\% processortid = 100, \\MIME-LAPTOP\Processor(_Total)\% processortid = 100
L client Performance data: '\Processor(*)\% processortid_0'=100;0;0 '\Processor(*)\% processortid_1'=100;0;0 '\Processor(*)\% processortid_2'=100;0;0 '\Processor(*)\% processortid_3'=100;0;0 '\Processor(*)\% processortid_4'=100;0;0 '\Processor(*)\% processortid_5'=100;0;0 '\Processor(*)\% processortid_6'=100;0;0 '\Processor(*)\% processortid_7'=100;0;0 '\Processor(*)\% processortid__Total'=100;0;0
help
(CheckSystem, check_pdh)¶help-pb
(CheckSystem, check_pdh)¶show-default
(CheckSystem, check_pdh)¶help-short
(CheckSystem, check_pdh)¶debug
(CheckSystem, check_pdh)¶show-all
(CheckSystem, check_pdh)¶filter
(CheckSystem, check_pdh)¶Key | Value |
alias | The counter alias |
counter | The counter name |
time | The time for rrd checks |
value | The counter value |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
warning
(CheckSystem, check_pdh)¶Key | Value |
alias | The counter alias |
counter | The counter name |
time | The time for rrd checks |
value | The counter value |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
warn
(CheckSystem, check_pdh)¶critical
(CheckSystem, check_pdh)¶Key | Value |
alias | The counter alias |
counter | The counter name |
time | The time for rrd checks |
value | The counter value |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
crit
(CheckSystem, check_pdh)¶ok
(CheckSystem, check_pdh)¶Key | Value |
alias | The counter alias |
counter | The counter name |
time | The time for rrd checks |
value | The counter value |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
empty-state
(CheckSystem, check_pdh)¶perf-config
(CheckSystem, check_pdh)¶top-syntax
(CheckSystem, check_pdh)¶Key | Value |
%(alias) | The counter alias |
%(counter) | The counter name |
%(time) | The time for rrd checks |
%(value) | The counter value |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
ok-syntax
(CheckSystem, check_pdh)¶empty-syntax
(CheckSystem, check_pdh)¶Key | Value |
%(alias) | The counter alias |
%(counter) | The counter name |
%(time) | The time for rrd checks |
%(value) | The counter value |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
detail-syntax
(CheckSystem, check_pdh)¶Key | Value |
%(alias) | The counter alias |
%(counter) | The counter name |
%(time) | The time for rrd checks |
%(value) | The counter value |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
perf-syntax
(CheckSystem, check_pdh)¶Key | Value |
%(alias) | The counter alias |
%(counter) | The counter name |
%(time) | The time for rrd checks |
%(value) | The counter value |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
counter
(CheckSystem, check_pdh)¶expand-index
(CheckSystem, check_pdh)¶instances
(CheckSystem, check_pdh)¶reload
(CheckSystem, check_pdh)¶averages
(CheckSystem, check_pdh)¶time
(CheckSystem, check_pdh)¶flags
(CheckSystem, check_pdh)¶type
(CheckSystem, check_pdh)¶check_process
¶CheckSystem
check_process
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). |
debug |
N/A | Show debugging information in the log |
show-all |
N/A | Show debugging information in the log |
filter |
state != ‘unreadable’ | Filter which marks interesting items. |
warning |
state not in (‘started’) | Filter which marks items which generates a warning state. |
warn |
Short alias for warning | |
critical |
state = ‘stopped’ or count = 0 | Filter which marks items which generates a critical state. |
crit |
Short alias for critical. | |
ok |
Filter which marks items which generates an ok state. | |
empty-state |
unknown | Return status to use when nothing matched filter. |
perf-config |
Performance data generation configuration | |
top-syntax |
${status}: ${problem_list} | Top level syntax. |
ok-syntax |
%(status): all processes are ok. | ok syntax. |
empty-syntax |
%(status): No processes found | Empty syntax. |
detail-syntax |
${exe}=${state} | Detail level syntax. |
perf-syntax |
${exe} | Performance alias syntax. |
process |
The service to check, set this to * to check all services | |
scan-info |
If all process metrics should be fetched (otherwise only status is fetched) | |
scan-16bit |
If 16bit processes should be included | |
delta |
Calculate delta over one elapsed second. | |
scan-unreadable |
If unreadable processes should be included (will not have information) |
Default check:
check_process
SetPoint.exe=hung
Performance data: 'taskhost.exe'=1;1;0 'dwm.exe'=1;1;0 'explorer.exe'=1;1;0 ... 'chrome.exe'=1;1;0 'vcpkgsrv.exe'=1;1;0 'vcpkgsrv.exe'=1;1;0
Default check via NRPE:
check_nrpe --host 192.168.56.103 --command check_process
SetPoint.exe=hung|'smss.exe state'=1;0;0 'csrss.exe state'=1;0;0...
Check that specific process are running:
check_process process=explorer.exe process=foo.exe
foo.exe=stopped
Performance data: 'explorer.exe'=1;1;0 'foo.exe'=0;1;0
Check memory footprint from specific processes:
check_process process=explorer.exe "warn=working_set > 70m"
explorer.exe=started
Performance data: 'explorer.exe ws_size'=73M;70;0
Extend the syntax to display the attributes we are interested in:
check_process process=explorer.exe "warn=working_set > 70m" "detail-syntax=${exe} ws:${working_set}, handles: ${handles}, user time:${user}s"
explorer.exe ws:77271040, handles: 800, user time:107s
Performance data: 'explorer.exe ws_size'=73M;70;0
List all processes which use more then 200m virtual memory Default check via NRPE:
check_nrpe --host 192.168.56.103 --command check_process --arguments "filter=virtual > 200m"
OK all processes are ok.|'csrss.exe state'=1;0;0 'svchost.exe state'=1;0;0 'AvastSvc.exe state'=1;0;0 ...
help
(CheckSystem, check_process)¶help-pb
(CheckSystem, check_process)¶show-default
(CheckSystem, check_process)¶help-short
(CheckSystem, check_process)¶debug
(CheckSystem, check_process)¶show-all
(CheckSystem, check_process)¶filter
(CheckSystem, check_process)¶Key | Value |
command_line | Command line of process (not always available) |
creation | Creation time |
error | Any error messages associated with fetching info |
exe | The name of the executable |
filename | Name of process (with path) |
gdi_handles | Number of handles |
handles | Number of handles |
hung | Process is hung |
kernel | Kernel time in seconds |
legacy_state | Get process status (for legacy use via check_nt only) |
page_fault | Page fault count |
pagefile | Peak page file use in bytes |
peak_pagefile | Page file usage in bytes |
peak_virtual | Peak virtual size in bytes |
peak_working_set | Peak working set in bytes |
pid | Process id |
started | Process is started |
state | The current state (started, stopped hung) |
stopped | Process is stopped |
time | User-kernel time in seconds |
user | User time in seconds |
user_handles | Number of handles |
virtual | Virtual size in bytes |
working_set | Working set in bytes |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
warning
(CheckSystem, check_process)¶Key | Value |
command_line | Command line of process (not always available) |
creation | Creation time |
error | Any error messages associated with fetching info |
exe | The name of the executable |
filename | Name of process (with path) |
gdi_handles | Number of handles |
handles | Number of handles |
hung | Process is hung |
kernel | Kernel time in seconds |
legacy_state | Get process status (for legacy use via check_nt only) |
page_fault | Page fault count |
pagefile | Peak page file use in bytes |
peak_pagefile | Page file usage in bytes |
peak_virtual | Peak virtual size in bytes |
peak_working_set | Peak working set in bytes |
pid | Process id |
started | Process is started |
state | The current state (started, stopped hung) |
stopped | Process is stopped |
time | User-kernel time in seconds |
user | User time in seconds |
user_handles | Number of handles |
virtual | Virtual size in bytes |
working_set | Working set in bytes |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
warn
(CheckSystem, check_process)¶critical
(CheckSystem, check_process)¶Key | Value |
command_line | Command line of process (not always available) |
creation | Creation time |
error | Any error messages associated with fetching info |
exe | The name of the executable |
filename | Name of process (with path) |
gdi_handles | Number of handles |
handles | Number of handles |
hung | Process is hung |
kernel | Kernel time in seconds |
legacy_state | Get process status (for legacy use via check_nt only) |
page_fault | Page fault count |
pagefile | Peak page file use in bytes |
peak_pagefile | Page file usage in bytes |
peak_virtual | Peak virtual size in bytes |
peak_working_set | Peak working set in bytes |
pid | Process id |
started | Process is started |
state | The current state (started, stopped hung) |
stopped | Process is stopped |
time | User-kernel time in seconds |
user | User time in seconds |
user_handles | Number of handles |
virtual | Virtual size in bytes |
working_set | Working set in bytes |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
crit
(CheckSystem, check_process)¶ok
(CheckSystem, check_process)¶Key | Value |
command_line | Command line of process (not always available) |
creation | Creation time |
error | Any error messages associated with fetching info |
exe | The name of the executable |
filename | Name of process (with path) |
gdi_handles | Number of handles |
handles | Number of handles |
hung | Process is hung |
kernel | Kernel time in seconds |
legacy_state | Get process status (for legacy use via check_nt only) |
page_fault | Page fault count |
pagefile | Peak page file use in bytes |
peak_pagefile | Page file usage in bytes |
peak_virtual | Peak virtual size in bytes |
peak_working_set | Peak working set in bytes |
pid | Process id |
started | Process is started |
state | The current state (started, stopped hung) |
stopped | Process is stopped |
time | User-kernel time in seconds |
user | User time in seconds |
user_handles | Number of handles |
virtual | Virtual size in bytes |
working_set | Working set in bytes |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
empty-state
(CheckSystem, check_process)¶perf-config
(CheckSystem, check_process)¶top-syntax
(CheckSystem, check_process)¶Key | Value |
%(command_line) | Command line of process (not always available) |
%(creation) | Creation time |
%(error) | Any error messages associated with fetching info |
%(exe) | The name of the executable |
%(filename) | Name of process (with path) |
%(gdi_handles) | Number of handles |
%(handles) | Number of handles |
%(hung) | Process is hung |
%(kernel) | Kernel time in seconds |
%(legacy_state) | Get process status (for legacy use via check_nt only) |
%(page_fault) | Page fault count |
%(pagefile) | Peak page file use in bytes |
%(peak_pagefile) | Page file usage in bytes |
%(peak_virtual) | Peak virtual size in bytes |
%(peak_working_set) | Peak working set in bytes |
%(pid) | Process id |
%(started) | Process is started |
%(state) | The current state (started, stopped hung) |
%(stopped) | Process is stopped |
%(time) | User-kernel time in seconds |
%(user) | User time in seconds |
%(user_handles) | Number of handles |
%(virtual) | Virtual size in bytes |
%(working_set) | Working set in bytes |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
ok-syntax
(CheckSystem, check_process)¶empty-syntax
(CheckSystem, check_process)¶Key | Value |
%(command_line) | Command line of process (not always available) |
%(creation) | Creation time |
%(error) | Any error messages associated with fetching info |
%(exe) | The name of the executable |
%(filename) | Name of process (with path) |
%(gdi_handles) | Number of handles |
%(handles) | Number of handles |
%(hung) | Process is hung |
%(kernel) | Kernel time in seconds |
%(legacy_state) | Get process status (for legacy use via check_nt only) |
%(page_fault) | Page fault count |
%(pagefile) | Peak page file use in bytes |
%(peak_pagefile) | Page file usage in bytes |
%(peak_virtual) | Peak virtual size in bytes |
%(peak_working_set) | Peak working set in bytes |
%(pid) | Process id |
%(started) | Process is started |
%(state) | The current state (started, stopped hung) |
%(stopped) | Process is stopped |
%(time) | User-kernel time in seconds |
%(user) | User time in seconds |
%(user_handles) | Number of handles |
%(virtual) | Virtual size in bytes |
%(working_set) | Working set in bytes |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
detail-syntax
(CheckSystem, check_process)¶Key | Value |
%(command_line) | Command line of process (not always available) |
%(creation) | Creation time |
%(error) | Any error messages associated with fetching info |
%(exe) | The name of the executable |
%(filename) | Name of process (with path) |
%(gdi_handles) | Number of handles |
%(handles) | Number of handles |
%(hung) | Process is hung |
%(kernel) | Kernel time in seconds |
%(legacy_state) | Get process status (for legacy use via check_nt only) |
%(page_fault) | Page fault count |
%(pagefile) | Peak page file use in bytes |
%(peak_pagefile) | Page file usage in bytes |
%(peak_virtual) | Peak virtual size in bytes |
%(peak_working_set) | Peak working set in bytes |
%(pid) | Process id |
%(started) | Process is started |
%(state) | The current state (started, stopped hung) |
%(stopped) | Process is stopped |
%(time) | User-kernel time in seconds |
%(user) | User time in seconds |
%(user_handles) | Number of handles |
%(virtual) | Virtual size in bytes |
%(working_set) | Working set in bytes |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
perf-syntax
(CheckSystem, check_process)¶Key | Value |
%(command_line) | Command line of process (not always available) |
%(creation) | Creation time |
%(error) | Any error messages associated with fetching info |
%(exe) | The name of the executable |
%(filename) | Name of process (with path) |
%(gdi_handles) | Number of handles |
%(handles) | Number of handles |
%(hung) | Process is hung |
%(kernel) | Kernel time in seconds |
%(legacy_state) | Get process status (for legacy use via check_nt only) |
%(page_fault) | Page fault count |
%(pagefile) | Peak page file use in bytes |
%(peak_pagefile) | Page file usage in bytes |
%(peak_virtual) | Peak virtual size in bytes |
%(peak_working_set) | Peak working set in bytes |
%(pid) | Process id |
%(started) | Process is started |
%(state) | The current state (started, stopped hung) |
%(stopped) | Process is stopped |
%(time) | User-kernel time in seconds |
%(user) | User time in seconds |
%(user_handles) | Number of handles |
%(virtual) | Virtual size in bytes |
%(working_set) | Working set in bytes |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
process
(CheckSystem, check_process)¶scan-info
(CheckSystem, check_process)¶scan-16bit
(CheckSystem, check_process)¶delta
(CheckSystem, check_process)¶scan-unreadable
(CheckSystem, check_process)¶check_service
¶CheckSystem
check_service
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). |
debug |
N/A | Show debugging information in the log |
show-all |
N/A | Show debugging information in the log |
filter |
Filter which marks interesting items. | |
warning |
not state_is_perfect() | Filter which marks items which generates a warning state. |
warn |
Short alias for warning | |
critical |
not state_is_ok() | Filter which marks items which generates a critical state. |
crit |
Short alias for critical. | |
ok |
Filter which marks items which generates an ok state. | |
empty-state |
unknown | Return status to use when nothing matched filter. |
perf-config |
Performance data generation configuration | |
top-syntax |
${status}: ${crit_list}, delayed (${warn_list}) | Top level syntax. |
ok-syntax |
%(status): All %(count) service(s) are ok. | ok syntax. |
empty-syntax |
%(status): No services found | Empty syntax. |
detail-syntax |
${name}=${state} (${start_type}) | Detail level syntax. |
perf-syntax |
${name} | Performance alias syntax. |
computer |
THe name of the remote computer to check | |
service |
The service to check, set this to * to check all services | |
exclude |
A list of services to ignore (mainly usefull in combination with service=*) | |
type |
service | The types of services to enumerate available types are driver, file-system-driver, kernel-driver, service, service-own-process, service-share-process |
state |
all | The types of services to enumerate available states are active, inactive or all |
Default check:
check_service
OK all services are ok.
Excluding services using exclude:
check_service "exclude=clr_optimization_v4.0.30319_32" "exclude=clr_optimization_v4.0.30319_64"
WARNING: gupdate=stopped (auto), Net Driver HPZ12=stopped (auto), NSClientpp=stopped (auto), nscp=stopped (auto), Pml Driver HPZ12=stopped (auto), SkypeUpdate=stopped (auto), sppsvc=stopped (auto)
Show all service by changing the syntax:
check_service "top-syntax=${list}" "detail-syntax=${name}:${state}"
AdobeActiveFileMonitor10.0:running, AdobeARMservice:running, AdobeFlashPlayerUpdateSvc:stopped, ..., WwanSvc:stopped
Excluding services using the filter:
check_service "filter=start_type = 'auto' and name not in ('Bonjour Service', 'Net Driver HPZ12')"
AdobeActiveFileMonitor10.0: running, AdobeARMservice: running, AMD External Events Utility: running, ... wuauserv: running
Default check via NRPE:
check_nrpe --host 192.168.56.103 --command check_service
WARNING: DPS=stopped (auto), MSDTC=stopped (auto), sppsvc=stopped (auto), UALSVC=stopped (auto)
Check that a service is not started:
check_service service=nscp "crit=state = 'started'" warn=none
help
(CheckSystem, check_service)¶help-pb
(CheckSystem, check_service)¶show-default
(CheckSystem, check_service)¶help-short
(CheckSystem, check_service)¶debug
(CheckSystem, check_service)¶show-all
(CheckSystem, check_service)¶filter
(CheckSystem, check_service)¶Key | Value |
delayed | If the service is delayed |
desc | Service description |
is_trigger | If the service is has associated triggers |
legacy_state | Get legacy state (deprecated and only used by check_nt) |
name | Service name |
pid | Process id |
start_type | The configured start type () |
state | The current state () |
triggers | The number of associated triggers for this service |
state_is_ok() | Check if the state is ok, i.e. all running services are runningelayed services are allowed to be stopped) |
state_is_perfect() | Check if the state is ok, i.e. all running services are running |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
warning
(CheckSystem, check_service)¶Key | Value |
delayed | If the service is delayed |
desc | Service description |
is_trigger | If the service is has associated triggers |
legacy_state | Get legacy state (deprecated and only used by check_nt) |
name | Service name |
pid | Process id |
start_type | The configured start type () |
state | The current state () |
triggers | The number of associated triggers for this service |
state_is_ok() | Check if the state is ok, i.e. all running services are runningelayed services are allowed to be stopped) |
state_is_perfect() | Check if the state is ok, i.e. all running services are running |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
warn
(CheckSystem, check_service)¶critical
(CheckSystem, check_service)¶Key | Value |
delayed | If the service is delayed |
desc | Service description |
is_trigger | If the service is has associated triggers |
legacy_state | Get legacy state (deprecated and only used by check_nt) |
name | Service name |
pid | Process id |
start_type | The configured start type () |
state | The current state () |
triggers | The number of associated triggers for this service |
state_is_ok() | Check if the state is ok, i.e. all running services are runningelayed services are allowed to be stopped) |
state_is_perfect() | Check if the state is ok, i.e. all running services are running |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
crit
(CheckSystem, check_service)¶ok
(CheckSystem, check_service)¶Key | Value |
delayed | If the service is delayed |
desc | Service description |
is_trigger | If the service is has associated triggers |
legacy_state | Get legacy state (deprecated and only used by check_nt) |
name | Service name |
pid | Process id |
start_type | The configured start type () |
state | The current state () |
triggers | The number of associated triggers for this service |
state_is_ok() | Check if the state is ok, i.e. all running services are runningelayed services are allowed to be stopped) |
state_is_perfect() | Check if the state is ok, i.e. all running services are running |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
empty-state
(CheckSystem, check_service)¶perf-config
(CheckSystem, check_service)¶top-syntax
(CheckSystem, check_service)¶Key | Value |
%(delayed) | If the service is delayed |
%(desc) | Service description |
%(is_trigger) | If the service is has associated triggers |
%(legacy_state) | Get legacy state (deprecated and only used by check_nt) |
%(name) | Service name |
%(pid) | Process id |
%(start_type) | The configured start type () |
%(state) | The current state () |
%(triggers) | The number of associated triggers for this service |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
ok-syntax
(CheckSystem, check_service)¶empty-syntax
(CheckSystem, check_service)¶Key | Value |
%(delayed) | If the service is delayed |
%(desc) | Service description |
%(is_trigger) | If the service is has associated triggers |
%(legacy_state) | Get legacy state (deprecated and only used by check_nt) |
%(name) | Service name |
%(pid) | Process id |
%(start_type) | The configured start type () |
%(state) | The current state () |
%(triggers) | The number of associated triggers for this service |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
detail-syntax
(CheckSystem, check_service)¶Key | Value |
%(delayed) | If the service is delayed |
%(desc) | Service description |
%(is_trigger) | If the service is has associated triggers |
%(legacy_state) | Get legacy state (deprecated and only used by check_nt) |
%(name) | Service name |
%(pid) | Process id |
%(start_type) | The configured start type () |
%(state) | The current state () |
%(triggers) | The number of associated triggers for this service |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
perf-syntax
(CheckSystem, check_service)¶Key | Value |
%(delayed) | If the service is delayed |
%(desc) | Service description |
%(is_trigger) | If the service is has associated triggers |
%(legacy_state) | Get legacy state (deprecated and only used by check_nt) |
%(name) | Service name |
%(pid) | Process id |
%(start_type) | The configured start type () |
%(state) | The current state () |
%(triggers) | The number of associated triggers for this service |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
computer
(CheckSystem, check_service)¶service
(CheckSystem, check_service)¶exclude
(CheckSystem, check_service)¶type
(CheckSystem, check_service)¶state
(CheckSystem, check_service)¶check_uptime
¶CheckSystem
check_uptime
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). |
debug |
N/A | Show debugging information in the log |
show-all |
N/A | Show debugging information in the log |
filter |
Filter which marks interesting items. | |
warning |
uptime < 2d | Filter which marks items which generates a warning state. |
warn |
Short alias for warning | |
critical |
uptime < 1d | Filter which marks items which generates a critical state. |
crit |
Short alias for critical. | |
ok |
Filter which marks items which generates an ok state. | |
empty-state |
ignored | Return status to use when nothing matched filter. |
perf-config |
Performance data generation configuration | |
top-syntax |
${status}: ${list} | Top level syntax. |
ok-syntax |
ok syntax. | |
empty-syntax |
Empty syntax. | |
detail-syntax |
uptime: ${uptime}h, boot: ${boot} (UTC) | Detail level syntax. |
perf-syntax |
uptime | Performance alias syntax. |
Default check:
check_uptime
uptime: -9:02, boot: 2013-aug-18 08:29:13
'uptime uptime'=1376814553s;1376760683;1376803883
Adding warning and critical thresholds:
check_uptime "warn=uptime < -2d" "crit=uptime < -1d"
...
Default check via NRPE:
check_nrpe --host 192.168.56.103 --command check_uptime
uptime: -0:3, boot: 2013-sep-08 18:41:06 (UCT)|'uptime'=1378665666;1378579481;1378622681
help
(CheckSystem, check_uptime)¶help-pb
(CheckSystem, check_uptime)¶show-default
(CheckSystem, check_uptime)¶help-short
(CheckSystem, check_uptime)¶debug
(CheckSystem, check_uptime)¶show-all
(CheckSystem, check_uptime)¶filter
(CheckSystem, check_uptime)¶Key | Value |
boot | System boot time |
uptime | Time since last boot |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
warning
(CheckSystem, check_uptime)¶Key | Value |
boot | System boot time |
uptime | Time since last boot |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
warn
(CheckSystem, check_uptime)¶critical
(CheckSystem, check_uptime)¶Key | Value |
boot | System boot time |
uptime | Time since last boot |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
crit
(CheckSystem, check_uptime)¶ok
(CheckSystem, check_uptime)¶Key | Value |
boot | System boot time |
uptime | Time since last boot |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
empty-state
(CheckSystem, check_uptime)¶perf-config
(CheckSystem, check_uptime)¶top-syntax
(CheckSystem, check_uptime)¶Key | Value |
%(boot) | System boot time |
%(uptime) | Time since last boot |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
ok-syntax
(CheckSystem, check_uptime)¶empty-syntax
(CheckSystem, check_uptime)¶Key | Value |
%(boot) | System boot time |
%(uptime) | Time since last boot |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
detail-syntax
(CheckSystem, check_uptime)¶Key | Value |
%(boot) | System boot time |
%(uptime) | Time since last boot |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
perf-syntax
(CheckSystem, check_uptime)¶Key | Value |
%(boot) | System boot time |
%(uptime) | Time since last boot |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
checkcounter
¶CheckSystem
checkcounter
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). |
Counter |
The time to check | |
ShowAll |
short | Configures display format (if set shows all items not only failures, if set to long shows all cores). |
MaxWarn |
Maximum value before a warning is returned. | |
MaxCrit |
Maximum value before a critical is returned. | |
MinWarn |
Minimum value before a warning is returned. | |
MinCrit |
Minimum value before a critical is returned. |
help
(CheckSystem, checkcounter)¶help-pb
(CheckSystem, checkcounter)¶show-default
(CheckSystem, checkcounter)¶help-short
(CheckSystem, checkcounter)¶Counter
(CheckSystem, checkcounter)¶ShowAll
(CheckSystem, checkcounter)¶MaxWarn
(CheckSystem, checkcounter)¶MaxCrit
(CheckSystem, checkcounter)¶MinWarn
(CheckSystem, checkcounter)¶MinCrit
(CheckSystem, checkcounter)¶checkcpu
¶CheckSystem
checkcpu
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). |
time |
The time to check | |
ShowAll |
short | Configures display format (if set shows all items not only failures, if set to long shows all cores). |
MaxWarn |
Maximum value before a warning is returned. | |
MaxCrit |
Maximum value before a critical is returned. | |
MinWarn |
Minimum value before a warning is returned. | |
MinCrit |
Minimum value before a critical is returned. | |
warn |
Maximum value before a warning is returned. | |
crit |
Maximum value before a critical is returned. |
help
(CheckSystem, checkcpu)¶help-pb
(CheckSystem, checkcpu)¶show-default
(CheckSystem, checkcpu)¶help-short
(CheckSystem, checkcpu)¶time
(CheckSystem, checkcpu)¶ShowAll
(CheckSystem, checkcpu)¶MaxWarn
(CheckSystem, checkcpu)¶MaxCrit
(CheckSystem, checkcpu)¶MinWarn
(CheckSystem, checkcpu)¶MinCrit
(CheckSystem, checkcpu)¶warn
(CheckSystem, checkcpu)¶crit
(CheckSystem, checkcpu)¶checkmem
¶CheckSystem
checkmem
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). |
type |
The types to check | |
ShowAll |
short | Configures display format (if set shows all items not only failures, if set to long shows all cores). |
MaxWarn |
Maximum value before a warning is returned. | |
MaxCrit |
Maximum value before a critical is returned. | |
MinWarn |
Minimum value before a warning is returned. | |
MinCrit |
Minimum value before a critical is returned. | |
warn |
Maximum value before a warning is returned. | |
crit |
Maximum value before a critical is returned. |
help
(CheckSystem, checkmem)¶help-pb
(CheckSystem, checkmem)¶show-default
(CheckSystem, checkmem)¶help-short
(CheckSystem, checkmem)¶type
(CheckSystem, checkmem)¶ShowAll
(CheckSystem, checkmem)¶MaxWarn
(CheckSystem, checkmem)¶MaxCrit
(CheckSystem, checkmem)¶MinWarn
(CheckSystem, checkmem)¶MinCrit
(CheckSystem, checkmem)¶warn
(CheckSystem, checkmem)¶crit
(CheckSystem, checkmem)¶checkprocstate
¶CheckSystem
checkprocstate
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). |
ShowAll |
short | Configures display format (if set shows all items not only failures, if set to long shows all cores). |
MaxWarnCount |
Maximum value before a warning is returned. | |
MaxCritCount |
Maximum value before a critical is returned. | |
MinWarnCount |
Minimum value before a warning is returned. | |
MinCritCount |
Minimum value before a critical is returned. |
help
(CheckSystem, checkprocstate)¶help-pb
(CheckSystem, checkprocstate)¶show-default
(CheckSystem, checkprocstate)¶help-short
(CheckSystem, checkprocstate)¶ShowAll
(CheckSystem, checkprocstate)¶MaxWarnCount
(CheckSystem, checkprocstate)¶MaxCritCount
(CheckSystem, checkprocstate)¶MinWarnCount
(CheckSystem, checkprocstate)¶MinCritCount
(CheckSystem, checkprocstate)¶checkservicestate
¶CheckSystem
checkservicestate
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). |
CheckAll |
true | Check all services. |
exclude |
Exclude services | |
ShowAll |
short | Configures display format (if set shows all items not only failures, if set to long shows all cores). |
help
(CheckSystem, checkservicestate)¶help-pb
(CheckSystem, checkservicestate)¶show-default
(CheckSystem, checkservicestate)¶help-short
(CheckSystem, checkservicestate)¶CheckAll
(CheckSystem, checkservicestate)¶exclude
(CheckSystem, checkservicestate)¶ShowAll
(CheckSystem, checkservicestate)¶checkuptime
¶CheckSystem
checkuptime
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). |
ShowAll |
short | Configures display format (if set shows all items not only failures, if set to long shows all cores). |
MaxWarn |
Maximum value before a warning is returned. | |
MaxCrit |
Maximum value before a critical is returned. | |
MinWarn |
Minimum value before a warning is returned. | |
MinCrit |
Minimum value before a critical is returned. | |
warn |
Maximum value before a warning is returned. | |
crit |
Maximum value before a critical is returned. |
help
(CheckSystem, checkuptime)¶help-pb
(CheckSystem, checkuptime)¶show-default
(CheckSystem, checkuptime)¶help-short
(CheckSystem, checkuptime)¶ShowAll
(CheckSystem, checkuptime)¶MaxWarn
(CheckSystem, checkuptime)¶MaxCrit
(CheckSystem, checkuptime)¶MinWarn
(CheckSystem, checkuptime)¶MinCrit
(CheckSystem, checkuptime)¶warn
(CheckSystem, checkuptime)¶crit
(CheckSystem, checkuptime)¶/settings/system/windows
(CheckSystem)¶WINDOWS CHECK SYSTEM
Section for system checks and system settings
Key Default Value Description default buffer length
1h DEFAULT LENGTH subsystem
default PDH SUBSYSTEM Sample:
# WINDOWS CHECK SYSTEM # Section for system checks and system settings [/settings/system/windows] default buffer length=1h subsystem=default
default buffer length
(CheckSystem, /settings/system/windows)¶DEFAULT LENGTH
Used to define the default interval for range buffer checks (ie. CPU).Path: /settings/system/windows
Key: default buffer length
Default value: 1h
Used by:
CheckSystem
Sample:
[/settings/system/windows] # DEFAULT LENGTH default buffer length=1h
subsystem
(CheckSystem, /settings/system/windows)¶PDH SUBSYSTEM
Set which pdh subsystem to use.Advanced (means it is not commonly used)
Path: /settings/system/windows
Key: subsystem
Default value: default
Used by:
CheckSystem
Sample:
[/settings/system/windows] # PDH SUBSYSTEM subsystem=default
/settings/system/windows/counters
(CheckSystem)¶COUNTERS
Add counters to checkSample:
# COUNTERS # Add counters to check [/settings/system/windows/counters]
/settings/system/windows/real-time
(CheckSystem)¶CONFIGURE REALTIME CHECKING
A set of options to configure the real time checksSample:
# CONFIGURE REALTIME CHECKING # A set of options to configure the real time checks [/settings/system/windows/real-time]
/settings/system/windows/real-time/checks
(CheckSystem)¶REALTIME FILTERS
A set of filters to use in real-time modeSample:
# REALTIME FILTERS # A set of filters to use in real-time mode [/settings/system/windows/real-time/checks]
/settings/system/windows/real-time/checks/sample
(CheckSystem)¶REAL TIME FILTER DEFENITION
Definition for real time filter: sample
Key Default Value Description alias
ALIAS check
cpu TYPE OF CHECK command
COMMAND NAME critical
CRITICAL FILTER debug
0 DEBUG destination
DESTINATION detail syntax
SYNTAX empty message
eventlog found no records EMPTY MESSAGE filter
FILTER is template
0 IS TEMPLATE maximum age
5m MAGIMUM AGE ok
OK FILTER ok syntax
SYNTAX parent
default PARENT perf config
PERF CONFIG severity
SEVERITY target
DESTINATION time
TIME times
FILES top syntax
SYNTAX warning
WARNING FILTER Sample:
# REAL TIME FILTER DEFENITION # Definition for real time filter: sample [/settings/system/windows/real-time/checks/sample] alias= check=cpu command= critical= debug=0 destination= detail syntax= empty message=eventlog found no records filter= is template=0 maximum age=5m ok= ok syntax= parent=default perf config= severity= target= time= times= top syntax= warning=
alias
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶ALIAS
The alias (service name) to report to serverAdvanced (means it is not commonly used)
Path: /settings/system/windows/real-time/checks/sample
Key: alias
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # ALIAS alias=
check
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶TYPE OF CHECK
The type of check cpu or memoryPath: /settings/system/windows/real-time/checks/sample
Key: check
Default value: cpu
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # TYPE OF CHECK check=cpu
command
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶COMMAND NAME
The name of the command (think nagios service name) to report up stream (defaults to alias if not set)Advanced (means it is not commonly used)
Path: /settings/system/windows/real-time/checks/sample
Key: command
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # COMMAND NAME command=
critical
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶CRITICAL FILTER
If any rows match this filter severity will escalated to CRITICALPath: /settings/system/windows/real-time/checks/sample
Key: critical
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # CRITICAL FILTER critical=
debug
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶DEBUG
Enable this to display debug information for this match filterAdvanced (means it is not commonly used)
Path: /settings/system/windows/real-time/checks/sample
Key: debug
Default value: 0
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # DEBUG debug=0
destination
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶DESTINATION
The destination for intercepted messagesAdvanced (means it is not commonly used)
Path: /settings/system/windows/real-time/checks/sample
Key: destination
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # DESTINATION destination=
detail syntax
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶SYNTAX
Format string for datesAdvanced (means it is not commonly used)
Path: /settings/system/windows/real-time/checks/sample
Key: detail syntax
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # SYNTAX detail syntax=
empty message
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶EMPTY MESSAGE
The message to display if nothing matches the filter (generally considered the ok state).Advanced (means it is not commonly used)
Path: /settings/system/windows/real-time/checks/sample
Key: empty message
Default value: eventlog found no records
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # EMPTY MESSAGE empty message=eventlog found no records
filter
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶FILTER
Scan files for matching rows for each matching rows an OK message will be submittedPath: /settings/system/windows/real-time/checks/sample
Key: filter
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # FILTER filter=
is template
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶IS TEMPLATE
Declare this object as a template (this means it will not be available as a separate object)Advanced (means it is not commonly used)
Path: /settings/system/windows/real-time/checks/sample
Key: is template
Default value: 0
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # IS TEMPLATE is template=0
maximum age
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶MAGIMUM AGE
How long before reporting “ok”.If this is set to “false” no periodic ok messages will be reported only errors.Path: /settings/system/windows/real-time/checks/sample
Key: maximum age
Default value: 5m
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # MAGIMUM AGE maximum age=5m
ok
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶OK FILTER
If any rows match this filter severity will escalated down to OKPath: /settings/system/windows/real-time/checks/sample
Key: ok
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # OK FILTER ok=
ok syntax
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶SYNTAX
Format string for datesAdvanced (means it is not commonly used)
Path: /settings/system/windows/real-time/checks/sample
Key: ok syntax
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # SYNTAX ok syntax=
parent
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶PARENT
The parent the target inherits fromAdvanced (means it is not commonly used)
Path: /settings/system/windows/real-time/checks/sample
Key: parent
Default value: default
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # PARENT parent=default
perf config
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶PERF CONFIG
Performance data configurationAdvanced (means it is not commonly used)
Path: /settings/system/windows/real-time/checks/sample
Key: perf config
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # PERF CONFIG perf config=
severity
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶SEVERITY
THe severity of this message (OK, WARNING, CRITICAL, UNKNOWN)Advanced (means it is not commonly used)
Path: /settings/system/windows/real-time/checks/sample
Key: severity
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # SEVERITY severity=
target
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶DESTINATION
Same as destinationPath: /settings/system/windows/real-time/checks/sample
Key: target
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # DESTINATION target=
time
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶TIME
The time to checkPath: /settings/system/windows/real-time/checks/sample
Key: time
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # TIME time=
times
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶FILES
A list of times to check (soma separated)Advanced (means it is not commonly used)
Path: /settings/system/windows/real-time/checks/sample
Key: times
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # FILES times=
top syntax
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶SYNTAX
Format string for datesAdvanced (means it is not commonly used)
Path: /settings/system/windows/real-time/checks/sample
Key: top syntax
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # SYNTAX top syntax=
warning
(CheckSystem, /settings/system/windows/real-time/checks/sample)¶WARNING FILTER
If any rows match this filter severity will escalated to WARNINGPath: /settings/system/windows/real-time/checks/sample
Key: warning
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckSystem
Sample:
[/settings/system/windows/real-time/checks/sample] # WARNING FILTER warning=