Check nodebb-errors

Overview

Get NodeBB server-side errors.

The Plugin uses the Read API and Bearer Authentication. You need to issue a bearer token of type "user" in the NodeBB admin panel in order to grant access to the API. In NodeBB, a user token is associated with a specific uid, and all calls are made in the name of that user.

To create a Bearer Token, do this:

• Settings > API Access > Create Token > Specify your User ID and Description (for example "Linuxfabrik API Token").

Hints:

• NodeBB Read API: https://docs.nodebb.org/api/read/
• Requires NodeBB v1.14.4+.

Fact Sheet

Check Plugin Download	https://github.com/Linuxfabrik/monitoring-plugins/tree/main/check-plugins/nodebb-errors
Check Interval Recommendation	Once a minute
Can be called without parameters	No
Compiled for	Linux, Windows
Requirements	NodeBB v1.14.4+

Help

usage: nodebb-errors [-h] [-V] [--always-ok] [--insecure] [--no-proxy]
                     [--severity {warn,crit}] [--test TEST]
                     [--timeout TIMEOUT] -p TOKEN [--url URL]

Get NodeBB server-side errors.

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 to perform "insecure"
                        SSL connections. Default: False
  --no-proxy            Do not use a proxy. Default: False
  --severity {warn,crit}
                        Severity for alerts that do not depend on thresholds.
                        One of "warn" or "crit". Default: warn
  --test TEST           For unit tests. Needs "path-to-stdout-file,path-to-
                        stderr-file,expected-retc".
  --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

Usage Examples

./nodebb-errors --token edd956be-9ea5-4f2a-94ca-3948a1b9d184 --severity warn

Output:

HTTP Status today: 0x 503 too busy, 1x 404 not found

States

• Alerts according to the given severity (default: WARN) if any HTTP status 503 occured today

Perfdata / Metrics

Name	Type	Description
err404	Continous Counter	404 responses from today
err503	Continous Counter	503 responses from today

Credits, License

• Authors: Linuxfabrik GmbH, Zurich
• License: The Unlicense, see LICENSE file.