Check nodebb-version¶
Overview¶
Checks if a newer version of NodeBB is available by comparing the installed version against the latest release, both as reported by the NodeBB API. Alerts when the installed version is outdated.
Important Notes:
- You need to issue a bearer token of type "user" in the NodeBB admin panel: Settings > API Access > Create Token > Specify your User ID and Description (for example "Linuxfabrik API Token"). In NodeBB, a user token is associated with a specific uid, and all calls are made in the name of that user.
- NodeBB Read API: https://docs.nodebb.org/api/read/
- Requires NodeBB v1.14.4+.
Data Collection:
- Queries the NodeBB Read API endpoint
/api/admin/dashboardusing Bearer Authentication - Compares the installed NodeBB version against the latest available version
- Reports the last restart timestamp including the user who triggered it
Fact Sheet¶
| Fact | Value |
|---|---|
| Check Plugin Download | https://github.com/Linuxfabrik/monitoring-plugins/tree/main/check-plugins/nodebb-version |
| Nagios/Icinga Check Name | check_nodebb_version |
| Check Interval Recommendation | Every day |
| Can be called without parameters | Yes |
| Runs on | Cross-platform |
| Compiled for Windows | No (runs with Python interpreter) |
Help¶
usage: nodebb-version [-h] [-V] [--always-ok] [--insecure] [--no-perfdata]
[--no-proxy] [--proxy PROXY] [--timeout TIMEOUT]
[-p TOKEN] [--url URL]
Checks if a newer version of NodeBB is available by comparing the installed
version against the latest release, both as reported by the NodeBB API. Alerts
when the installed version is outdated.
options:
-h, --help show this help message and exit
-V, --version show program's version number and exit
--always-ok Always returns OK.
--insecure This option explicitly allows insecure SSL connections.
--no-perfdata Suppress the performance data section from the output.
The status message and the exit code are unaffected, so
alerting keeps working while trending data is dropped.
--no-proxy Do not use a proxy, not even one the environment names.
Overrides `--proxy`.
--proxy PROXY Proxy to reach the target through. The scheme defaults to
`http` when omitted. Overrides the proxy the environment
names (`http_proxy`, `https_proxy`, `all_proxy`) together
with the exceptions it lists in `no_proxy`, and is itself
overridden by `--no-proxy`. Without either parameter the
environment applies. Credentials belong into the
environment variable rather than here, because a command-
line argument is visible to every user on the host.
Example: `--proxy=http://proxy.example.com:3128`.
--timeout TIMEOUT Network timeout in seconds. Default: 3 (seconds)
-p, --token TOKEN NodeBB API bearer token.
--url URL NodeBB API URL. Default: http://localhost:4567/forum
Documentation:
https://linuxfabrik.github.io/monitoring-plugins/check-plugins/nodebb-version/
Usage Examples¶
./nodebb-version --url=http://localhost:4567/forum --token=bc68eed3-4cff-4a6e-8372-3b41dfa67635
Output:
NodeBB v1.17.1 installed, NodeBB v1.18.1 available [WARNING], Last restart: 2021-08-09 16:03:29 by Linuxfabrik <info at linuxfabrik dot ch> (4W 22h ago)
States¶
- OK if the installed version is up to date.
- WARN if an update is available.
--always-oksuppresses all alerts and always returns OK.
Perfdata / Metrics¶
| Name | Type | Description |
|---|---|---|
| nodebb-version | Number | Installed NodeBB version as float. For example, "1.17.1" becomes "1.017001". |
Credits, License¶
- Authors: Linuxfabrik GmbH, Zurich
- License: The Unlicense, see LICENSE file.