Check wildfly-version¶
Overview¶
Checks if a newer version of WildFly is available by comparing the installed version, queried from the HTTP management API, against the latest release on the GitHub releases API. Alerts when the installed version is outdated. The plugin supports both standalone mode and domain mode.
Important Notes:
--usernameand--passwordof a management user are required (sameManagementRealmuser the other WildFly plugins use).- Only stable releases are considered. GitHub's "latest release" endpoint returns the most recent non-prerelease, non-draft release, and WildFly flags its
.Beta,.CRand.Alphatags as prereleases, so they are skipped. - The comparison ignores the version qualifier (
.Final), so40.0.0.Finalis compared as40.0.0.
Data Collection:
- Queries the WildFly management API for
product-version(falls back torelease-versionifproduct-versionis not available) - Authenticates via HTTP Digest Auth (
--username,--password) - Queries the GitHub releases API for the latest release of
wildfly/wildfly - Caches the latest version information locally to reduce API calls (default: 24 hours)
Fact Sheet¶
| Fact | Value |
|---|---|
| Check Plugin Download | https://github.com/Linuxfabrik/monitoring-plugins/tree/main/check-plugins/wildfly-version |
| Nagios/Icinga Check Name | check_wildfly_version |
| Check Interval Recommendation | Every day |
| Can be called without parameters | No (--username and --password are required) |
| Runs on | Cross-platform |
| Compiled for Windows | No (runs with Python interpreter) |
| Uses State File | $TEMP/linuxfabrik-monitoring-plugins-cache.db |
Help¶
usage: wildfly-version [-h] [-V] [--always-ok] [--cache-expire CACHE_EXPIRE]
[--insecure] [--instance INSTANCE]
[--mode {standalone,domain}] [--no-perfdata]
[--no-proxy] [--node NODE] -p PASSWORD [--proxy PROXY]
[--timeout TIMEOUT] [--url URL] --username USERNAME
Checks if a newer version of WildFly is available by comparing the installed
version, queried from the HTTP management API, against the latest release on
the GitHub releases 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.
--cache-expire CACHE_EXPIRE
The amount of time after which the credential/data
cache expires, in minutes. Default: 24
--insecure This option explicitly allows insecure SSL
connections.
--instance INSTANCE WildFly instance (server-config) to check when running
in domain mode.
--mode {standalone,domain}
WildFly server mode. Default: standalone
--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`.
--node NODE WildFly node (host) when running in domain mode.
-p, --password PASSWORD
WildFly management API password.
--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: 8 (seconds)
--url URL WildFly management API URL. Default:
http://localhost:9990
--username USERNAME WildFly management API username. Default: wildfly-
monitoring
Documentation:
https://linuxfabrik.github.io/monitoring-plugins/check-plugins/wildfly-version/
Usage Examples¶
./wildfly-version --url=http://wildfly:9990 --username=wildfly-monitoring --password=password
Output:
WildFly v40.0.0.Final is up to date
WildFly v26.1.3.Final installed, WildFly v40.0.0.Final available
States¶
- OK if the installed version is up to date.
- WARN if a newer version is available.
--always-oksuppresses all alerts and always returns OK.
Perfdata / Metrics¶
| Name | Type | Description |
|---|---|---|
| wildfly-version | Number | Installed WildFly version as float. |
Credits, License¶
- Authors: Linuxfabrik GmbH, Zurich
- License: The Unlicense, see LICENSE file.