Skip to content

Fix docs #477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lgmu merged 3 commits into from
Oct 21, 2026
Merged

Fix docs #477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fcdcc90
replace code blocks in cmdline help page with quotes
lgmu Oct 21, 2026
057f53f
always use %() instead of mixing it with ${} in the syntax docs
lgmu Oct 21, 2026
a3b12eb
fix condition parsing with trailing closing bracket
lgmu Oct 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/checks/commands/check_connections.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@ Checks the number of TCP connections.

## Argument Defaults

| Argument | Default Value |
| ------------- | -------------------------------------- |
| filter | inet=total |
| warning | total > 1000 |
| critical | total > 2000 |
| empty-state | 0 (OK) |
| empty-syntax | |
| top-syntax | %(status) - \${list} |
| ok-syntax | |
| detail-syntax | total \${prefix}connections: \${total} |
| Argument | Default Value |
| ------------- | ------------------------------------ |
| filter | inet=total |
| warning | total > 1000 |
| critical | total > 2000 |
| empty-state | 0 (OK) |
| empty-syntax | |
| top-syntax | %(status) - %(list) |
| ok-syntax | |
| detail-syntax | total %(prefix)connections: %(total) |

## Check Specific Arguments

Expand Down
6 changes: 3 additions & 3 deletions docs/checks/commands/check_cpu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ Checks the CPU usage metrics.
| critical | load > 90 |
| empty-state | 3 (UNKNOWN) |
| empty-syntax | check_cpu failed to find anything with this filter. |
| top-syntax | %(status) - \${problem_list} on %{core_num} cores |
| ok-syntax | %(status) - CPU load is ok. %{total:fmt=%d}% on %{core_num} cores |
| detail-syntax | \${time}: \${load}% |
| top-syntax | %(status) - %(problem_list) on %(core_num) cores |
| ok-syntax | %(status) - CPU load is ok. %(total:fmt=%d)% on %(core_num) cores |
| detail-syntax | %(time): %(load)% |

## Check Specific Arguments

Expand Down
4 changes: 2 additions & 2 deletions docs/checks/commands/check_cpu_utilization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ Checks the CPU utilization metrics.
| critical | total > 95 |
| empty-state | 0 (OK) |
| empty-syntax | |
| top-syntax | \${status} - \${list} |
| top-syntax | %(status) - %(list) |
| ok-syntax | |
| detail-syntax | user: \${user}% - system: \${system}% - iowait: \${iowait}% - steal: \${steal}% - guest: \${guest} - idle: %{idle}% |
| detail-syntax | user: %(user)% - system: %(system)% - iowait: %(iowait)% - steal: %(steal)% - guest: %(guest) - idle: %(idle)% |

## Check Specific Arguments

Expand Down
2 changes: 1 addition & 1 deletion docs/checks/commands/check_drivesize.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Checks the disk drive/volumes usage on a host.
| critical | used_pct > 90 |
| empty-state | 3 (UNKNOWN) |
| empty-syntax | %(status) - No drives found |
| top-syntax | %(status) - \${problem_list} |
| top-syntax | %(status) - %(problem_list) |
| ok-syntax | %(status) - All %(count) drive(s) are ok |
| detail-syntax | %(drive_or_name) %(used)/%(size) (%(used_pct \| fmt=%.1f )%) |

Expand Down
2 changes: 1 addition & 1 deletion docs/checks/commands/check_eventlog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ the filter is still applied to the returned events.
| timezone | Sets the timezone for time metrics (default is local time) |
| truncate-message | Maximum length of message for each event log message text |
| unique | Alias for unique-index |
| unique-index | Combination of fields that identifies unique events, set to 0 to disable. Default is "\${log}-\${source}-\${id}" |
| unique-index | Combination of fields that identifies unique events, set to 0 to disable. Default is "%(log)-%(source)-%(id)" |

## Attributes

Expand Down
4 changes: 2 additions & 2 deletions docs/checks/commands/check_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ Returns list of all known checks.
| filter | implemented = 1 |
| empty-state | 3 (UNKNOWN) |
| empty-syntax | no checks found |
| top-syntax | \${list} |
| top-syntax | %(list) |
| ok-syntax | |
| detail-syntax | \${name} |
| detail-syntax | %(name) |

## Check Specific Arguments

Expand Down
16 changes: 8 additions & 8 deletions docs/checks/commands/check_load.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ Checks the CPU load metrics.

## Argument Defaults

| Argument | Default Value |
| ------------- | ------------------------------------------------------- |
| filter | none |
| empty-state | 0 (OK) |
| empty-syntax | |
| top-syntax | %(status) - \${list} on \${cores} cores |
| ok-syntax | |
| detail-syntax | \${type} load average: \${load1}, \${load5}, \${load15} |
| Argument | Default Value |
| ------------- | --------------------------------------------------- |
| filter | none |
| empty-state | 0 (OK) |
| empty-syntax | |
| top-syntax | %(status) - %(list) on %(cores) cores |
| ok-syntax | |
| detail-syntax | %(type) load average: %(load1), %(load5), %(load15) |

## Check Specific Arguments

Expand Down
4 changes: 2 additions & 2 deletions docs/checks/commands/check_mailq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ Checks the mailq.
| critical | active > 10 \|\| active_size > 20MB \|\| deferred > 10 \|\| deferred_size > 20MB |
| empty-state | 3 (UNKNOWN) |
| empty-syntax | %(status) - could not get any mailq data |
| top-syntax | %(status) - \${list} |
| top-syntax | %(status) - %(list) |
| ok-syntax | |
| detail-syntax | \${mta}: active \${active} / deferred \${deferred} |
| detail-syntax | %(mta): active %(active) / deferred %(deferred) |

## Check Specific Arguments

Expand Down
4 changes: 2 additions & 2 deletions docs/checks/commands/check_memory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Read more on Windows virtual address space [here](https://learn.microsoft.com/en
| critical | used > 90% |
| empty-state | 0 (OK) |
| empty-syntax | |
| top-syntax | %(status) - \${list} |
| top-syntax | %(status) - %(list) |
| ok-syntax | |
| detail-syntax | %(type) = %(used)/%(size) (%(used_pct \| fmt=%.1f )%) |

Expand Down Expand Up @@ -72,7 +72,7 @@ these can be used in filters and thresholds (along with the default attributes):

Changing the return syntax to get more information:

check_memory 'top-syntax=${list}' 'detail-syntax=${type} free: ${free} used: ${used} size: ${size}'
check_memory 'top-syntax=%(list)' 'detail-syntax=%(type) free: %(free) used: %(used) size: %(size)'
physical free: 35.00 B used: 7.01 GiB size: 31.09 GiB, committed free: 27.00 B used: 705.57 MiB size: 977.00 MiB |...

### Example using check_snclient and Naemon
Expand Down
6 changes: 3 additions & 3 deletions docs/checks/commands/check_mount.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ Checks the status for a mounted filesystem
| critical | issues like 'not mounted' |
| empty-state | 3 (UNKNOWN) |
| empty-syntax | check_mount failed to find anything with this filter. |
| top-syntax | \${status} - \${problem_list} |
| ok-syntax | \${status} - \${count} mount(s) found |
| detail-syntax | mount \${mount} \${issues} |
| top-syntax | %(status) - %(problem_list) |
| ok-syntax | %(status) - %(count) mount(s) found |
| detail-syntax | mount %(mount) %(issues) |

## Check Specific Arguments

Expand Down
20 changes: 10 additions & 10 deletions docs/checks/commands/check_ntp_offset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@ Checks the NTP offset.

## Argument Defaults

| Argument | Default Value |
| ------------- | -------------------------------------------------- |
| filter | none |
| warning | offset > 50 \|\| offset < -50 |
| critical | offset > 100 \|\| offset < -100 |
| empty-state | 3 (UNKNOWN) |
| empty-syntax | %(status) - could not get any ntp data |
| top-syntax | %(status) - \${list} |
| ok-syntax | |
| detail-syntax | offset \${offset_seconds:duration} from \${server} |
| Argument | Default Value |
| ------------- | ------------------------------------------------ |
| filter | none |
| warning | offset > 50 \|\| offset < -50 |
| critical | offset > 100 \|\| offset < -100 |
| empty-state | 3 (UNKNOWN) |
| empty-syntax | %(status) - could not get any ntp data |
| top-syntax | %(status) - %(list) |
| ok-syntax | |
| detail-syntax | offset %(offset_seconds:duration) from %(server) |

## Check Specific Arguments

Expand Down
4 changes: 2 additions & 2 deletions docs/checks/commands/check_omd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ Check OMD site status.
| critical | state >= 2 |
| empty-state | 3 (UNKNOWN) |
| empty-syntax | check_omd failed to find any site with this filter. |
| top-syntax | \${status} - \${list} |
| top-syntax | %(status) - %(list) |
| ok-syntax | |
| detail-syntax | site \${site}: \${status}\${failed_services_txt} |
| detail-syntax | site %(site): %(status)%(failed_services_txt) |

## Check Specific Arguments

Expand Down
4 changes: 2 additions & 2 deletions docs/checks/commands/check_os_updates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ Checks for OS system updates.
| critical | count_security > 0 |
| empty-state | 0 (OK) |
| empty-syntax | %(status) - no updates available |
| top-syntax | %(status) - %{count_security} security updates / %{count} updates available.\n%{list} |
| top-syntax | %(status) - %(count_security) security updates / %(count) updates available.\n%(list) |
| ok-syntax | |
| detail-syntax | \${prefix}\${package}: \${version} |
| detail-syntax | %(prefix)%(package): %(version) |

## Check Specific Arguments

Expand Down
14 changes: 7 additions & 7 deletions docs/checks/commands/check_os_version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ Checks the os system version.

## Argument Defaults

| Argument | Default Value |
| ------------- | ----------------------------------------- |
| empty-state | 0 (OK) |
| empty-syntax | |
| top-syntax | %(status) - \${list} |
| ok-syntax | |
| detail-syntax | \${platform} \${version} (arch: \${arch}) |
| Argument | Default Value |
| ------------- | -------------------------------------- |
| empty-state | 0 (OK) |
| empty-syntax | |
| top-syntax | %(status) - %(list) |
| ok-syntax | |
| detail-syntax | %(platform) %(version) (arch: %(arch)) |

## Check Specific Arguments

Expand Down
20 changes: 10 additions & 10 deletions docs/checks/commands/check_pagefile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@ Checks the pagefile usage.

## Argument Defaults

| Argument | Default Value |
| ------------- | ------------------------------------------------------ |
| filter | name = 'total' |
| warning | used > 60% |
| critical | used > 80% |
| empty-state | 0 (OK) |
| empty-syntax | |
| top-syntax | %(status) - \${list} |
| ok-syntax | |
| detail-syntax | \${name} \${used}/\${size} (%(used_pct \| fmt=%.1f )%) |
| Argument | Default Value |
| ------------- | --------------------------------------------------- |
| filter | name = 'total' |
| warning | used > 60% |
| critical | used > 80% |
| empty-state | 0 (OK) |
| empty-syntax | |
| top-syntax | %(status) - %(list) |
| ok-syntax | |
| detail-syntax | %(name) %(used)/%(size) (%(used_pct \| fmt=%.1f )%) |

## Check Specific Arguments

Expand Down
20 changes: 10 additions & 10 deletions docs/checks/commands/check_ping.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@ Checks the ICMP ping connection.

## Argument Defaults

| Argument | Default Value |
| ------------- | ----------------------------------------------------------------- |
| filter | none |
| warning | rta > 1000 \|\| pl > 30 |
| critical | rta > 5000 \|\| pl > 80 |
| empty-state | 3 (UNKNOWN) |
| empty-syntax | %(status) - could not get any ping data |
| top-syntax | %(status) - \${list} |
| ok-syntax | |
| detail-syntax | Packet loss = \${pl}%{{ IF rta != '' }}, RTA = \${rta}ms{{ END }} |
| Argument | Default Value |
| ------------- | --------------------------------------------------------------- |
| filter | none |
| warning | rta > 1000 \|\| pl > 30 |
| critical | rta > 5000 \|\| pl > 80 |
| empty-state | 3 (UNKNOWN) |
| empty-syntax | %(status) - could not get any ping data |
| top-syntax | %(status) - %(list) |
| ok-syntax | |
| detail-syntax | Packet loss = %(pl)%{{ IF rta != '' }}, RTA = %(rta)ms{{ END }} |

## Check Specific Arguments

Expand Down
20 changes: 10 additions & 10 deletions docs/checks/commands/check_process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ Checks the state and metrics of one or multiple processes.

## Argument Defaults

| Argument | Default Value |
| ------------- | ------------------------------------------------------------- |
| warning | count = 0 |
| critical | state = 'stopped' or count = 0 |
| empty-state | 2 (CRITICAL) |
| empty-syntax | %(status) - no processes found with this filter. |
| top-syntax | %(status) - \${problem_list \|\| 'found \${count} processes'} |
| ok-syntax | %(status) - all %{count} processes are ok. |
| detail-syntax | \${exe}=\${state} |
| Argument | Default Value |
| ------------- | ----------------------------------------------------------- |
| warning | count = 0 |
| critical | state = 'stopped' or count = 0 |
| empty-state | 2 (CRITICAL) |
| empty-syntax | %(status) - no processes found with this filter. |
| top-syntax | %(status) - %(problem_list \|\| 'found %(count) processes') |
| ok-syntax | %(status) - all %(count) processes are ok. |
| detail-syntax | %(exe)=%(state) |

## Check Specific Arguments

Expand Down Expand Up @@ -79,7 +79,7 @@ Check specific process(es) by name (adding some metrics as well)
process=httpd \
warn='count < 1 || count > 10' \
crit='count < 0 || count > 20' \
top-syntax='%{status} - %{count} processes, memory %{rss|h}B, cpu %{cpu:fmt=%.1f}%, started %{oldest:age|duration} ago'
top-syntax='%(status) - %(count) processes, memory %(rss|h)B, cpu %(cpu:fmt=%.1f)%, started %(oldest:age|duration) ago'
WARNING - 12 processes, memory 62.58 MB, cpu 0.7%, started 01:11h ago |...

If zero is a valid threshold, set thresholds accordingly
Expand Down
Loading
Loading