Skip to content

Commit 4da4e0d

Browse files
committed
docs: regenerate READMEs and Director baskets after lib v3.0.0 HELP_TEXTS
Rerun `tools/update-readmes` and `tools/check2basket --auto` to pick up cascaded changes from earlier commits in this series: - lib v3.0.0 added a central `--test` HELP_TEXTS entry, so all plugins that accept `--test` now show the same standardized help line. The regenerated READMEs reflect the new help output. - cpu-usage and disk-io DESCRIPTIONs had typographic minus signs and curly apostrophes replaced with plain ASCII (RUF001 fix in the ruff cleanup commit). The regenerated Director baskets pick up the sanitized text. - sap-open-concur-com's `--service` parameter gained a fixed allowed-values list, so its Director basket now exposes a Datalist-typed field plus a new service-name list instead of a free-form string. No plugin code change in this commit; all diffs are auto-generated artifacts catching up with previously committed code.
1 parent e4d4985 commit 4da4e0d

File tree

32 files changed

+186
-44
lines changed

32 files changed

+186
-44
lines changed

check-plugins/apache-httpd-version/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Checks the installed Apache httpd version against the endoflife.date API and ale
3636
usage: apache-httpd-version [-h] [-V] [--always-ok] [--check-major]
3737
[--check-minor] [--check-patch] [--insecure]
3838
[--no-proxy] [--offset-eol OFFSET_EOL]
39-
[--timeout TIMEOUT]
39+
[--test TEST] [--timeout TIMEOUT]
4040
4141
Checks the installed Apache httpd version against the endoflife.date API and
4242
alerts if the version is end-of-life or if newer major, minor, or patch
@@ -63,6 +63,8 @@ options:
6363
--offset-eol OFFSET_EOL
6464
Alert n days before ("-30") or after an EOL date ("30"
6565
or "+30"). Default: -30 days
66+
--test TEST For unit tests. Needs "path-to-stdout-file,path-to-
67+
stderr-file,expected-retc".
6668
--timeout TIMEOUT Network timeout in seconds. Default: 8 (seconds)
6769
```
6870

check-plugins/apache-solr-version/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Checks the installed Apache Solr version against the endoflife.date API and aler
3535
usage: apache-solr-version [-h] [-V] [--always-ok] [--check-major]
3636
[--check-minor] [--check-patch] [--insecure]
3737
[--no-proxy] [--offset-eol OFFSET_EOL]
38-
[--path PATH] [--timeout TIMEOUT]
38+
[--path PATH] [--test TEST] [--timeout TIMEOUT]
3939
4040
Checks the installed Apache Solr version against the endoflife.date API and
4141
alerts if the version is end-of-life or if newer major, minor, or patch
@@ -64,6 +64,8 @@ options:
6464
or "+30"). Default: -30 days
6565
--path PATH Local path to your Apache Solr binary. Default:
6666
/opt/solr/bin/solr
67+
--test TEST For unit tests. Needs "path-to-stdout-file,path-to-
68+
stderr-file,expected-retc".
6769
--timeout TIMEOUT Network timeout in seconds. Default: 8 (seconds)
6870
```
6971

check-plugins/composer-version/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Checks the installed Composer version against the endoflife.date API and alerts
3636
usage: composer-version [-h] [-V] [--always-ok] [--check-major]
3737
[--check-minor] [--check-patch] [--insecure]
3838
[--no-proxy] [--offset-eol OFFSET_EOL] [--path PATH]
39-
[--timeout TIMEOUT]
39+
[--test TEST] [--timeout TIMEOUT]
4040
4141
Checks the installed Composer version against the endoflife.date API and
4242
alerts if the version is end-of-life or if newer major, minor, or patch
@@ -65,6 +65,8 @@ options:
6565
or "+30"). Default: -30 days
6666
--path PATH Local path to your composer binary. Default:
6767
/usr/bin/composer
68+
--test TEST For unit tests. Needs "path-to-stdout-file,path-to-
69+
stderr-file,expected-retc".
6870
--timeout TIMEOUT Network timeout in seconds. Default: 8 (seconds)
6971
```
7072

check-plugins/cpu-usage/icingaweb2-module-director/cpu-usage.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@
146146
"tpl-service-generic"
147147
],
148148
"max_check_attempts": 5,
149-
"notes": "Reports CPU utilization percentages for all available time categories (user, system, idle, nice, iowait, irq, softirq, steal, guest, guest_nice) plus the overall cpu-usage (100 \u2212 idle \u2212 nice). Thresholds (WARN/CRIT) are checked against user, system, iowait, and cpu-usage. An alert is raised only if the threshold is exceeded for COUNT consecutive runs, suppressing short spikes and focusing on sustained load. Perfdata is emitted for every field to enable full graphing. Extended stats (context switches, interrupts, etc.) are included if supported on this platform. This check is cross-platform and works on Linux, Windows, and all psutil-supported systems. The check stores its short trend state locally in an SQLite DB to evaluate sustained load across runs.",
149+
"notes": "Reports CPU utilization percentages for all available time categories (user, system, idle, nice, iowait, irq, softirq, steal, guest, guest_nice) plus the overall cpu-usage (100 - idle - nice). Thresholds (WARN/CRIT) are checked against user, system, iowait, and cpu-usage. An alert is raised only if the threshold is exceeded for COUNT consecutive runs, suppressing short spikes and focusing on sustained load. Perfdata is emitted for every field to enable full graphing. Extended stats (context switches, interrupts, etc.) are included if supported on this platform. This check is cross-platform and works on Linux, Windows, and all psutil-supported systems. The check stores its short trend state locally in an SQLite DB to evaluate sustained load across runs.",
150150
"notes_url": "https://linuxfabrik.github.io/monitoring-plugins/check-plugins/cpu-usage/",
151151
"object_name": "tpl-service-cpu-usage",
152152
"object_type": "template",
@@ -195,7 +195,7 @@
195195
"tpl-service-generic"
196196
],
197197
"max_check_attempts": 5,
198-
"notes": "Reports CPU utilization percentages for all available time categories (user, system, idle, nice, iowait, irq, softirq, steal, guest, guest_nice) plus the overall cpu-usage (100 \u2212 idle \u2212 nice). Thresholds (WARN/CRIT) are checked against user, system, iowait, and cpu-usage. An alert is raised only if the threshold is exceeded for COUNT consecutive runs, suppressing short spikes and focusing on sustained load. Perfdata is emitted for every field to enable full graphing. Extended stats (context switches, interrupts, etc.) are included if supported on this platform. This check is cross-platform and works on Linux, Windows, and all psutil-supported systems. The check stores its short trend state locally in an SQLite DB to evaluate sustained load across runs.",
198+
"notes": "Reports CPU utilization percentages for all available time categories (user, system, idle, nice, iowait, irq, softirq, steal, guest, guest_nice) plus the overall cpu-usage (100 - idle - nice). Thresholds (WARN/CRIT) are checked against user, system, iowait, and cpu-usage. An alert is raised only if the threshold is exceeded for COUNT consecutive runs, suppressing short spikes and focusing on sustained load. Perfdata is emitted for every field to enable full graphing. Extended stats (context switches, interrupts, etc.) are included if supported on this platform. This check is cross-platform and works on Linux, Windows, and all psutil-supported systems. The check stores its short trend state locally in an SQLite DB to evaluate sustained load across runs.",
199199
"notes_url": "https://linuxfabrik.github.io/monitoring-plugins/check-plugins/cpu-usage/",
200200
"object_name": "tpl-service-cpu-usage-windows",
201201
"object_type": "template",

check-plugins/deb-updates/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ bind9-dnsutils/stable,stable-security 1:9.18.33-1~deb12u2 amd64 [upgradable from
4545

4646
```text
4747
usage: deb-updates [-h] [-V] [--always-ok] [--only-critical] [--query QUERY]
48-
[--timeout TIMEOUT] [-w WARN]
48+
[--test TEST] [--timeout TIMEOUT] [-w WARN]
4949
5050
Checks for available APT package updates on Debian, Ubuntu, and compatible
5151
systems. Reports the number of pending updates and upgrades, and alerts when
@@ -63,6 +63,8 @@ options:
6363
updates is printed. Have a look at the README for a list
6464
of available columns. Example: `--query='package like
6565
"bind9-%"'`. Default: 1
66+
--test TEST For unit tests. Needs "path-to-stdout-file,path-to-
67+
stderr-file,expected-retc".
6668
--timeout TIMEOUT Network timeout in seconds. Default: 60 (seconds)
6769
-w, --warning WARN Minimum number of pending packages to trigger a WARNING.
6870
Default: 1

check-plugins/disk-io/icingaweb2-module-director/disk-io.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@
210210
"tpl-service-generic"
211211
],
212212
"max_check_attempts": 5,
213-
"notes": "Checks disk I/O bandwidth over time and alerts on sustained saturation, not short spikes. The check records per-disk read/write counters and then derives current (R1/W1) and period averages (R{COUNT}/W{COUNT}). It compares the period\u2019s total bandwidth against the maximum ever observed for that disk (RWmax). WARN/CRIT trigger if the period average exceeds the configured percentage of RWmax for COUNT consecutive runs. On Linux, the check also monitors the system-wide iowait percentage (CPU time spent waiting for I/O). The raw iowait value is normalized by multiplying it with the number of logical CPUs, so that 100% always means one CPU core is fully I/O-saturated, regardless of the total number of CPUs. This makes the default thresholds (80/90%) work consistently across different hardware. Like bandwidth alerts, iowait alerts require COUNT consecutive threshold violations. Perfdata is emitted for each disk (busy_time, read_bytes, read_time, write_bytes, write_time) and for iowait, so you can graph trends. On Linux the check automatically focuses on \"real\" block devices with mountpoints; on Windows it uses psutil\u2019s disk counters. Optionally, `--top` lists the processes that generated the most I/O traffic (read/write totals) to help identify offenders. This check is cross-platform and works on Linux, Windows, and all psutil-supported systems. The check stores its short trend state locally in an SQLite DB to evaluate sustained load across runs.",
213+
"notes": "Checks disk I/O bandwidth over time and alerts on sustained saturation, not short spikes. The check records per-disk read/write counters and then derives current (R1/W1) and period averages (R{COUNT}/W{COUNT}). It compares the period's total bandwidth against the maximum ever observed for that disk (RWmax). WARN/CRIT trigger if the period average exceeds the configured percentage of RWmax for COUNT consecutive runs. On Linux, the check also monitors the system-wide iowait percentage (CPU time spent waiting for I/O). The raw iowait value is normalized by multiplying it with the number of logical CPUs, so that 100% always means one CPU core is fully I/O-saturated, regardless of the total number of CPUs. This makes the default thresholds (80/90%) work consistently across different hardware. Like bandwidth alerts, iowait alerts require COUNT consecutive threshold violations. Perfdata is emitted for each disk (busy_time, read_bytes, read_time, write_bytes, write_time) and for iowait, so you can graph trends. On Linux the check automatically focuses on \"real\" block devices with mountpoints; on Windows it uses psutil's disk counters. Optionally, `--top` lists the processes that generated the most I/O traffic (read/write totals) to help identify offenders. This check is cross-platform and works on Linux, Windows, and all psutil-supported systems. The check stores its short trend state locally in an SQLite DB to evaluate sustained load across runs.",
214214
"notes_url": "https://linuxfabrik.github.io/monitoring-plugins/check-plugins/disk-io/",
215215
"object_name": "tpl-service-disk-io",
216216
"object_type": "template",
@@ -263,7 +263,7 @@
263263
"tpl-service-generic"
264264
],
265265
"max_check_attempts": 5,
266-
"notes": "Checks disk I/O bandwidth over time and alerts on sustained saturation, not short spikes. The check records per-disk read/write counters and then derives current (R1/W1) and period averages (R{COUNT}/W{COUNT}). It compares the period\u2019s total bandwidth against the maximum ever observed for that disk (RWmax). WARN/CRIT trigger if the period average exceeds the configured percentage of RWmax for COUNT consecutive runs. On Linux, the check also monitors the system-wide iowait percentage (CPU time spent waiting for I/O). The raw iowait value is normalized by multiplying it with the number of logical CPUs, so that 100% always means one CPU core is fully I/O-saturated, regardless of the total number of CPUs. This makes the default thresholds (80/90%) work consistently across different hardware. Like bandwidth alerts, iowait alerts require COUNT consecutive threshold violations. Perfdata is emitted for each disk (busy_time, read_bytes, read_time, write_bytes, write_time) and for iowait, so you can graph trends. On Linux the check automatically focuses on \"real\" block devices with mountpoints; on Windows it uses psutil\u2019s disk counters. Optionally, `--top` lists the processes that generated the most I/O traffic (read/write totals) to help identify offenders. This check is cross-platform and works on Linux, Windows, and all psutil-supported systems. The check stores its short trend state locally in an SQLite DB to evaluate sustained load across runs.",
266+
"notes": "Checks disk I/O bandwidth over time and alerts on sustained saturation, not short spikes. The check records per-disk read/write counters and then derives current (R1/W1) and period averages (R{COUNT}/W{COUNT}). It compares the period's total bandwidth against the maximum ever observed for that disk (RWmax). WARN/CRIT trigger if the period average exceeds the configured percentage of RWmax for COUNT consecutive runs. On Linux, the check also monitors the system-wide iowait percentage (CPU time spent waiting for I/O). The raw iowait value is normalized by multiplying it with the number of logical CPUs, so that 100% always means one CPU core is fully I/O-saturated, regardless of the total number of CPUs. This makes the default thresholds (80/90%) work consistently across different hardware. Like bandwidth alerts, iowait alerts require COUNT consecutive threshold violations. Perfdata is emitted for each disk (busy_time, read_bytes, read_time, write_bytes, write_time) and for iowait, so you can graph trends. On Linux the check automatically focuses on \"real\" block devices with mountpoints; on Windows it uses psutil's disk counters. Optionally, `--top` lists the processes that generated the most I/O traffic (read/write totals) to help identify offenders. This check is cross-platform and works on Linux, Windows, and all psutil-supported systems. The check stores its short trend state locally in an SQLite DB to evaluate sustained load across runs.",
267267
"notes_url": "https://linuxfabrik.github.io/monitoring-plugins/check-plugins/disk-io/",
268268
"object_name": "tpl-service-disk-io-windows",
269269
"object_type": "template",

check-plugins/disk-usage/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ usage: disk-usage [-h] [-V] [--always-ok] [-c CRIT]
4141
[--exclude-regex EXCLUDE_REGEX] [--fstype FSTYPE]
4242
[--include-pattern INCLUDE_PATTERN]
4343
[--include-regex INCLUDE_REGEX] [--list-fstypes]
44-
[--perfdata-regex PERFDATA_REGEX] [-w WARN]
44+
[--perfdata-regex PERFDATA_REGEX] [--test TEST] [-w WARN]
4545
4646
Checks used or free disk space for each mounted partition. By default, only
4747
physical devices are checked (hard disks, USB drives), ignoring pseudo and
@@ -94,6 +94,8 @@ options:
9494
Only emit perfdata keys matching this Python regex.
9595
For a list of perfdata keys, see the README or run
9696
this plugin. Can be specified multiple times.
97+
--test TEST For unit tests. Needs "path-to-stdout-file,path-to-
98+
stderr-file,expected-retc".
9799
-w, --warning WARN WARN threshold in the form `<number>[unit][method]`.
98100
Unit is one of `%|K|M|G|T|P` (default: `%`). `K` means
99101
kibibyte etc. Method is one of `USED|FREE` (default:

check-plugins/file-descriptors/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Checks the system-wide file descriptor usage as a percentage of the kernel maxim
2929

3030
```text
3131
usage: file-descriptors [-h] [-V] [--always-ok] [-c CRIT] [--top TOP]
32-
[-w WARN]
32+
[--test TEST] [-w WARN]
3333
3434
Checks the system-wide file descriptor usage as a percentage of the kernel
3535
maximum. Also lists the top processes consuming the most file descriptors to
@@ -44,6 +44,8 @@ options:
4444
Default: 95
4545
--top TOP Number of top processes to list by open file
4646
descriptors. Default: 5
47+
--test TEST For unit tests. Needs "path-to-stdout-file,path-to-
48+
stderr-file,expected-retc".
4749
-w, --warning WARN WARN threshold for file descriptor usage in percent.
4850
Default: 90
4951
```

check-plugins/grafana-version/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ Checks the installed Grafana version against the endoflife.date API and alerts i
3434
```text
3535
usage: grafana-version [-h] [-V] [--always-ok] [--check-major] [--check-minor]
3636
[--check-patch] [--insecure] [--no-proxy]
37-
[--offset-eol OFFSET_EOL] [--timeout TIMEOUT]
37+
[--offset-eol OFFSET_EOL] [--test TEST]
38+
[--timeout TIMEOUT]
3839
3940
Checks the installed Grafana version against the endoflife.date API and alerts
4041
if the version is end-of-life or if newer major, minor, or patch releases are
@@ -61,6 +62,8 @@ options:
6162
--offset-eol OFFSET_EOL
6263
Alert n days before ("-30") or after an EOL date ("30"
6364
or "+30"). Default: -30 days
65+
--test TEST For unit tests. Needs "path-to-stdout-file,path-to-
66+
stderr-file,expected-retc".
6467
--timeout TIMEOUT Network timeout in seconds. Default: 8 (seconds)
6568
```
6669

check-plugins/graylog-version/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ Checks the installed Graylog version against the endoflife.date API and alerts i
3434
```text
3535
usage: graylog-version [-h] [-V] [--always-ok] [--check-major] [--check-minor]
3636
[--check-patch] [--insecure] [--no-proxy]
37-
[--offset-eol OFFSET_EOL] [--timeout TIMEOUT]
37+
[--offset-eol OFFSET_EOL] [--test TEST]
38+
[--timeout TIMEOUT]
3839
3940
Checks the installed Graylog version against the endoflife.date API and alerts
4041
if the version is end-of-life or if newer major, minor, or patch releases are
@@ -61,6 +62,8 @@ options:
6162
--offset-eol OFFSET_EOL
6263
Alert n days before ("-30") or after an EOL date ("30"
6364
or "+30"). Default: -30 days
65+
--test TEST For unit tests. Needs "path-to-stdout-file,path-to-
66+
stderr-file,expected-retc".
6467
--timeout TIMEOUT Network timeout in seconds. Default: 8 (seconds)
6568
```
6669

0 commit comments

Comments
 (0)