Skip to content

Commit f9d28c8

Browse files
committed
style(docs): normalize blank lines across all READMEs
1 parent 8740782 commit f9d28c8

File tree

244 files changed

+245
-331
lines changed

Some content is hidden

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

244 files changed

+245
-331
lines changed

check-plugins/about-me/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Check about-me
22

3+
34
## Overview
45

56
Collects and displays key system information: OS and kernel version, CPU configuration (physical, logical, and usable cores plus frequency), RAM, disk count, virtualization type, network interfaces, listening ports, systemd services and timers, cron jobs, installed packages, and user accounts. Optionally queries dmidecode for firmware and hardware details, and fetches the public IP address. This check is purely informational and never raises alerts. Requires root or sudo.
@@ -10,7 +11,6 @@ Collects and displays key system information: OS and kernel version, CPU configu
1011
* The `--dmidecode` option requires sudo permissions
1112
* If `psutil` is not installed, some metrics (CPU frequency, network interfaces) will be unavailable
1213

13-
1414
**Data Collection:**
1515

1616
* Gathers hardware and OS data via `psutil` (if available), `lsblk`, `stat`, `/proc/mounts`, and various `systemctl` commands

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Check apache-httpd-status
22

3+
34
## Overview
45

56
Monitors Apache httpd performance via the mod_status endpoint (server-status?auto). Alerts when worker usage exceeds the configured thresholds. Reports busy and idle workers, request rates, bytes served, CPU load, connection states, and system load averages. Requires "ExtendedStatus On" in the Apache configuration for full metrics. Uses a local SQLite database to calculate per-second rates from cumulative counters.
@@ -74,7 +75,6 @@ If you want to configure `/server-status` in a virtual host:
7475
</VirtualHost>
7576
```
7677

77-
7878
**Data Collection:**
7979

8080
* Fetches data from the Apache `mod_status` machine-readable endpoint (`server-status?auto`)

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Check apache-httpd-version
22

3+
34
## Overview
45

56
Checks the installed Apache httpd version against the endoflife.date API and alerts if the version is end-of-life or if newer major, minor, or patch releases are available. By default, alerts 30 days before the official EOL date. The offset is configurable.
@@ -9,8 +10,6 @@ Checks the installed Apache httpd version against the endoflife.date API and ale
910
* Runs on all systems where the Apache binary is named either `httpd` or `apache2`
1011
* Must run on the Apache httpd server itself to detect the installed version
1112

12-
13-
1413
**Data Collection:**
1514

1615
* Detects the installed Apache httpd version by running `httpd -v` (RHEL) or `apache2 -v` (Debian-based systems)

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Check apache-solr-version
22

3+
34
## Overview
45

56
Checks the installed Apache Solr version against the endoflife.date API and alerts if the version is end-of-life or if newer major, minor, or patch releases are available. By default, alerts 30 days before the official EOL date. The offset is configurable.
@@ -8,8 +9,6 @@ Checks the installed Apache Solr version against the endoflife.date API and aler
89

910
* Must run on the Apache Solr server itself to detect the installed version
1011

11-
12-
1312
**Data Collection:**
1413

1514
* Detects the installed Apache Solr version by running `<path> version` (default path: `/opt/solr/bin/solr`)

check-plugins/atlassian-statuspage/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Check atlassian-statuspage
22

3+
34
## Overview
45

56
Monitors a public Atlassian Statuspage for incidents and maintenance windows. Returns OK when no incidents are reported, WARN for minor incidents or scheduled maintenance, and CRIT for major or critical incidents. Works with any Statuspage-powered status page, not just Atlassian's own.
@@ -8,8 +9,6 @@ Monitors a public Atlassian Statuspage for incidents and maintenance windows. Re
89

910
* Works with any public status page powered by Atlassian Statuspage (e.g. GitHub, Cloudflare, Datadog)
1011

11-
12-
1312
**Data Collection:**
1413

1514
* Queries the `/api/v2/status.json` endpoint of the specified Statuspage URL

check-plugins/axenita-stats/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Check axenita-stats
22

3+
34
## Overview
45

56
Monitors the health and performance of an Axenita/Achilles installation by querying four API endpoints: ReadModel state, active user sessions, build information, and maintenance mode status. Alerts if any endpoint returns an error, if the ReadModel initialization is incomplete, or if maintenance mode is active. Axenita Praxissoftware is powered by Axonlab / Axon Lab AG.
@@ -8,8 +9,6 @@ Monitors the health and performance of an Axenita/Achilles installation by query
89

910
* Requires network access to the Axenita/Achilles API (default: `http://localhost:10000/achilles/ar`)
1011

11-
12-
1312
**Data Collection:**
1413

1514
* Queries four Axenita/Achilles REST API endpoints:

check-plugins/borgbackup/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Check borgbackup
22

3+
34
## Overview
45

56
Checks the status of the last borgbackup run by parsing the borg logfile. Alerts on non-zero return codes from the create or prune steps, and warns if the last successful backup is older than a configurable threshold (default: 24 hours). Also detects active borg mounts in /proc/mounts. Requires root or sudo.
@@ -11,7 +12,6 @@ Checks the status of the last borgbackup run by parsing the borg logfile. Alerts
1112
* If the logfile is missing or incomplete (any of the four fields not found), the check exits with UNKNOWN
1213
* Active `borgfs` mounts are reported as WARN immediately, before evaluating the logfile
1314

14-
1515
**Data Collection:**
1616

1717
* Parses `/var/log/borg/borg.log` for four fields: `start`, `end`, `create_retc`, and `prune_retc`

check-plugins/by-ssh/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Check by-ssh
22

3+
34
## Overview
45

56
Executes a command on a remote host via SSH and evaluates the result. Returns STDOUT and, in case of failure, STDERR and the command's exit code. Supports pattern matching on STDOUT to detect specific conditions, with configurable alert severities per match. Can also alert on single numeric return values against warning and critical thresholds.
@@ -12,7 +13,6 @@ Executes a command on a remote host via SSH and evaluates the result. Returns ST
1213
* 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.
1314
* Supports multiple `--identity` files and `--ssh-option` parameters for fine-grained SSH configuration
1415

15-
1616
**Data Collection:**
1717

1818
* Connects to the remote host via SSH and executes the specified command

check-plugins/by-winrm/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Check by-winrm
22

3+
34
## Overview
45

56
This plugin executes PowerShell commands or scripts on remote Windows hosts via WinRM, supporting JEA. It returns standard output (STDOUT) and, in case of failure, standard error (STDERR) along with the command's exit code. By evaluating these results - through threshold checks or pattern matching on STDOUT - the plugin can generate alerts with configurable severity levels.
@@ -13,7 +14,6 @@ This plugin executes PowerShell commands or scripts on remote Windows hosts via
1314
* 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.
1415
* When `--winrm-domain` is set, the username is sent as `user@DOMAIN` for NTLM authentication. Not needed for Kerberos or local accounts.
1516

16-
1717
**Data Collection:**
1818

1919
* Connects to the remote Windows host via WinRM and executes the specified PowerShell command

check-plugins/cometsystem/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Check cometsystem
22

3+
34
## Overview
45

56
Reads sensor data from Comet System Web Sensors via their JSON API endpoint. Monitors channels such as temperature, humidity, and other environmental values. Alarm states are mapped to configurable severity levels using a flexible pattern matching system (e.g. "temp:high:crit", "humi:low:warn").

0 commit comments

Comments
 (0)