Skip to content

Commit bceb8ac

Browse files
committed
fix(docs): restrict Compatibility to platform only, fix false Linux-only claims, update CONTRIBUTING
1 parent 61a6613 commit bceb8ac

File tree

118 files changed

+343
-110
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

118 files changed

+343
-110
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -912,7 +912,7 @@ Each plugin README follows a fixed structure. See [check-plugins/example/README.
912912
1. **Overview**: Describes *what* the plugin does. A leading sentence stating the main purpose. This must include at least the text from the plugin's `DESCRIPTION` variable. Followed by subsections:
913913

914914
* **Data Collection**: How data is gathered (shell command, API, psutil, etc.), filtering options, SQLite usage, non-blocking measurement.
915-
* **Compatibility**: Supported platforms, required tools or modules.
915+
* **Compatibility**: Supported platforms only (Linux, Windows, Cross-platform). Use "Cross-platform" by default since Python runs everywhere. Only use "Linux" if the plugin uses Linux-specific APIs (`/proc`, `systemd`, `dmesg`, `dnf`/`apt`/`yum`, `journalctl`, etc.). The absence of a `.windows` file does not mean the plugin is Linux-only - it just means we do not compile it for Windows. No version requirements, no tool dependencies, no module requirements - those belong in Important Notes or the Fact Sheet.
916916
* **Important Notes** (optional): Operational edge cases the admin must know before deploying, for example: "Requires sudo", "Only works with Redis 3.0+", "First run returns OK with 'Waiting for more data.'", "After a reboot, counters reset and the check waits for a new baseline". No implementation details - only things that affect deployment and daily operations.
917917

918918
2. **Fact Sheet**: Key properties as a table (download link, check name, check interval, parameters required, Windows support, 3rd party modules, state file path, etc.). Only list applicable rows.

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,12 @@ Monitors Apache httpd performance via the mod_status endpoint (server-status?aut
1313

1414
**Compatibility:**
1515

16-
* Works with any Apache httpd version that provides `mod_status`
17-
* Some metrics (connection stats, load averages, processes) are only available in newer versions of `mod_status`
16+
* Cross-platform
1817

1918
**Important Notes:**
2019

20+
* Works with any Apache httpd version that provides `mod_status`
21+
* Some metrics (connection stats, load averages, processes) are only available in newer versions of `mod_status`
2122
* `mod_status` must be loaded and `ExtendedStatus On` must be set in the Apache configuration for full metrics. Without `ExtendedStatus`, only worker counts and scoreboard data are reported.
2223
* The check alerts on the percentage of busy workers relative to the total number of worker slots (busy + idle + free)
2324
* Workers in the "Gracefully finishing" (G) state are counted as idle workers, not busy workers

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,15 @@ Checks the installed Apache httpd version against the endoflife.date API and ale
1212

1313
**Compatibility:**
1414

15+
* Cross-platform
16+
17+
**Important Notes:**
18+
1519
* Runs on all systems where the Apache binary is named either `httpd` or `apache2`
1620
* Must run on the Apache httpd server itself to detect the installed version
1721

1822

23+
1924
## Fact Sheet
2025

2126
| Fact | Value |

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,14 @@ Checks the installed Apache Solr version against the endoflife.date API and aler
1212

1313
**Compatibility:**
1414

15+
* Cross-platform
16+
17+
**Important Notes:**
18+
1519
* Must run on the Apache Solr server itself to detect the installed version
1620

1721

22+
1823
## Fact Sheet
1924

2025
| Fact | Value |

check-plugins/atlassian-statuspage/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,14 @@ Monitors a public Atlassian Statuspage for incidents and maintenance windows. Re
1212

1313
**Compatibility:**
1414

15+
* Cross-platform
16+
17+
**Important Notes:**
18+
1519
* Works with any public status page powered by Atlassian Statuspage (e.g. GitHub, Cloudflare, Datadog)
1620

1721

22+
1823
## Fact Sheet
1924

2025
| Fact | Value |

check-plugins/axenita-stats/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,14 @@ Monitors the health and performance of an Axenita/Achilles installation by query
1414

1515
**Compatibility:**
1616

17+
* Cross-platform
18+
19+
**Important Notes:**
20+
1721
* Requires network access to the Axenita/Achilles API (default: `http://localhost:10000/achilles/ar`)
1822

1923

24+
2025
## Fact Sheet
2126

2227
| Fact | Value |

check-plugins/by-ssh/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,12 @@ Executes a command on a remote host via SSH and evaluates the result. Returns ST
1414

1515
**Compatibility:**
1616

17-
* Requires SSH access to the remote host
18-
* Requires the `sshpass` command-line tool if password-based authentication is used
17+
* Cross-platform
1918

2019
**Important Notes:**
2120

21+
* Requires SSH access to the remote host
22+
* Requires the `sshpass` command-line tool if password-based authentication is used
2223
* Password-based authentication (`--password`) is not recommended. If used, `ps` will expose the SSH password on the monitoring host.
2324
* The `--shell` option enables shell expansion for environment variables and file globs but can be a security hazard. Without it, only simple commands without globs or pipes are supported.
2425
* Supports multiple `--identity` files and `--ssh-option` parameters for fine-grained SSH configuration

check-plugins/by-winrm/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ This plugin executes PowerShell commands or scripts on remote Windows hosts via
1616
**Compatibility:**
1717

1818
* Runs on Linux and connects to remote Windows hosts
19-
* Supports NTLM, Kerberos, CredSSP, Basic, and plaintext transports
20-
* JEA endpoints are only supported with `pypsrp` (via `--winrm-configuration-name`)
2119

2220
**Important Notes:**
2321

22+
* Supports NTLM, Kerberos, CredSSP, Basic, and plaintext transports
23+
* JEA endpoints are only supported with `pypsrp` (via `--winrm-configuration-name`)
2424
* This plugin is ideal for retrieving Windows-specific metrics, running custom PowerShell-based health checks (such as inventory, backup status, or failover cluster queries), and accessing systems like Active Directory, Exchange, SQL Server, or Hyper-V
2525
* It is especially useful in environments where installing a monitoring agent is not possible or desired
2626
* For Kerberos transport, configure `/etc/krb5.conf` and obtain a ticket via `kinit` before running the plugin. When Kerberos credentials are present in the cache, `--winrm-username` and `--winrm-password` can be omitted.

check-plugins/cometsystem/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,11 @@ Reads sensor data from Comet System Web Sensors via their JSON API endpoint. Mon
1212

1313
**Compatibility:**
1414

15-
* Works with any Comet System Web Sensor that exposes a `/values.json` endpoint
15+
* Cross-platform
1616

1717
**Important Notes:**
1818

19+
* Works with any Comet System Web Sensor that exposes a `/values.json` endpoint
1920
* The repeating `--severity` parameter can be set in different ways:
2021

2122
* `--severity ok|warn|crit|unknown`: High and low alarm severity for all channels and all alarm modes.

check-plugins/crypto-policy/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,14 @@ Verifies that the system-wide cryptographic policy (as reported by update-crypto
1111

1212
**Compatibility:**
1313

14+
* Cross-platform
15+
16+
**Important Notes:**
17+
1418
* RHEL/CentOS/Fedora and other distributions that ship `update-crypto-policies`
1519

1620

21+
1722
## Fact Sheet
1823

1924
| Fact | Value |

0 commit comments

Comments
 (0)