Skip to content

Commit e61ceca

Browse files
committed
docs: point plugin documentation surfaces to the published docs site
Every plugin is now served as its own page under https://linuxfabrik.github.io/monitoring-plugins/, so the Icinga Director basket and the plugin-group READMEs should link there instead of raw GitHub URLs: - tools/check2basket: emit `notes_url` pointing to the published docs site (https://linuxfabrik.github.io/monitoring-plugins/check-plugins/NAME/) instead of the GitHub tree URL. The Icinga Director "Notes URL" link in every Service Template now opens the rendered plugin page instead of the raw source listing. - Regenerate 236 basket JSONs with `tools/check2basket --auto` to pick up the new notes_url. - Rewrite plugin README links that point to the plugin-group index pages (PLUGINS-KEYCLOAK/MYSQL/ROCKETCHAT/WILDFLY.md) and the #threshold-and-ranges anchor to the docs site (35 READMEs). Each plugin's Fact Sheet "Check Plugin Download" row intentionally stays on GitHub - that row is meant to point at the source listing, not the rendered docs page. Issue-tracker links, the releases Atom feed and linked source files (.php, assets/sudoers) also stay on GitHub.
1 parent f2cd0ff commit e61ceca

File tree

272 files changed

+293
-293
lines changed

Some content is hidden

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

272 files changed

+293
-293
lines changed

check-plugins/about-me/icingaweb2-module-director/about-me.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797
],
9898
"max_check_attempts": 5,
9999
"notes": "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.",
100-
"notes_url": "https://github.com/Linuxfabrik/monitoring-plugins/tree/main/check-plugins/about-me",
100+
"notes_url": "https://linuxfabrik.github.io/monitoring-plugins/check-plugins/about-me/",
101101
"object_name": "tpl-service-about-me",
102102
"object_type": "template",
103103
"retry_interval": 3600,

check-plugins/apache-httpd-status/icingaweb2-module-director/apache-httpd-status.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@
105105
],
106106
"max_check_attempts": 5,
107107
"notes": "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.",
108-
"notes_url": "https://github.com/Linuxfabrik/monitoring-plugins/tree/main/check-plugins/apache-httpd-status",
108+
"notes_url": "https://linuxfabrik.github.io/monitoring-plugins/check-plugins/apache-httpd-status/",
109109
"object_name": "tpl-service-apache-httpd-status",
110110
"object_type": "template",
111111
"retry_interval": 15,

check-plugins/apache-httpd-version/icingaweb2-module-director/apache-httpd-version.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@
113113
],
114114
"max_check_attempts": 5,
115115
"notes": "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.",
116-
"notes_url": "https://github.com/Linuxfabrik/monitoring-plugins/tree/main/check-plugins/apache-httpd-version",
116+
"notes_url": "https://linuxfabrik.github.io/monitoring-plugins/check-plugins/apache-httpd-version/",
117117
"object_name": "tpl-service-apache-httpd-version",
118118
"object_type": "template",
119119
"retry_interval": 300,

check-plugins/apache-solr-version/icingaweb2-module-director/apache-solr-version.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@
121121
],
122122
"max_check_attempts": 5,
123123
"notes": "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.",
124-
"notes_url": "https://github.com/Linuxfabrik/monitoring-plugins/tree/main/check-plugins/apache-solr-version",
124+
"notes_url": "https://linuxfabrik.github.io/monitoring-plugins/check-plugins/apache-solr-version/",
125125
"object_name": "tpl-service-apache-solr-version",
126126
"object_type": "template",
127127
"retry_interval": 60,

check-plugins/atlassian-statuspage/icingaweb2-module-director/atlassian-statuspage.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@
8989
],
9090
"max_check_attempts": 5,
9191
"notes": "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.",
92-
"notes_url": "https://github.com/Linuxfabrik/monitoring-plugins/tree/main/check-plugins/atlassian-statuspage",
92+
"notes_url": "https://linuxfabrik.github.io/monitoring-plugins/check-plugins/atlassian-statuspage/",
9393
"object_name": "tpl-service-atlassian-statuspage",
9494
"object_type": "template",
9595
"retry_interval": 15,

check-plugins/axenita-stats/icingaweb2-module-director/axenita-stats.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@
8989
],
9090
"max_check_attempts": 5,
9191
"notes": "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.",
92-
"notes_url": "https://github.com/Linuxfabrik/monitoring-plugins/tree/main/check-plugins/axenita-stats",
92+
"notes_url": "https://linuxfabrik.github.io/monitoring-plugins/check-plugins/axenita-stats/",
9393
"object_name": "tpl-service-axenita-stats",
9494
"object_type": "template",
9595
"retry_interval": 15,

check-plugins/borgbackup/icingaweb2-module-director/borgbackup.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
],
6666
"max_check_attempts": 5,
6767
"notes": "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.",
68-
"notes_url": "https://github.com/Linuxfabrik/monitoring-plugins/tree/main/check-plugins/borgbackup",
68+
"notes_url": "https://linuxfabrik.github.io/monitoring-plugins/check-plugins/borgbackup/",
6969
"object_name": "tpl-service-borgbackup",
7070
"object_type": "template",
7171
"retry_interval": 180,

check-plugins/by-ssh/icingaweb2-module-director/by-ssh.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@
271271
],
272272
"max_check_attempts": 5,
273273
"notes": "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.",
274-
"notes_url": "https://github.com/Linuxfabrik/monitoring-plugins/tree/main/check-plugins/by-ssh",
274+
"notes_url": "https://linuxfabrik.github.io/monitoring-plugins/check-plugins/by-ssh/",
275275
"object_name": "tpl-service-by-ssh",
276276
"object_type": "template",
277277
"retry_interval": 15,

check-plugins/by-winrm/icingaweb2-module-director/by-winrm.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@
221221
],
222222
"max_check_attempts": 5,
223223
"notes": "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. ",
224-
"notes_url": "https://github.com/Linuxfabrik/monitoring-plugins/tree/main/check-plugins/by-winrm",
224+
"notes_url": "https://linuxfabrik.github.io/monitoring-plugins/check-plugins/by-winrm/",
225225
"object_name": "tpl-service-by-winrm",
226226
"object_type": "template",
227227
"retry_interval": 15,

check-plugins/cometsystem/icingaweb2-module-director/cometsystem.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
],
9999
"max_check_attempts": 5,
100100
"notes": "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\").",
101-
"notes_url": "https://github.com/Linuxfabrik/monitoring-plugins/tree/main/check-plugins/cometsystem",
101+
"notes_url": "https://linuxfabrik.github.io/monitoring-plugins/check-plugins/cometsystem/",
102102
"object_name": "tpl-service-cometsystem",
103103
"object_type": "template",
104104
"retry_interval": 15,

0 commit comments

Comments
 (0)