Skip to content

Check wildfly-deployment-status

Overview

Checks the deployment status of applications on a WildFly/JBoss AS server via its HTTP-JSON based management API (JBossAS REST Management API). This approach requires no additional agents or WAR deployments like Jolokia. The plugin supports both standalone mode and domain mode.

Important Notes:

  • Tested with WildFly 11 and WildFly 23+

Data Collection:

  • Queries the WildFly management API at /deployment/* using the read-attribute operation for the status attribute
  • Authenticates via HTTP Digest Auth (--username, --password)
  • Specific deployments can be checked using --deployment (repeatable); if omitted, all deployments are checked

Fact Sheet

Fact Value
Check Plugin Download https://github.com/Linuxfabrik/monitoring-plugins/tree/main/check-plugins/wildfly-deployment-status
Nagios/Icinga Check Name check_wildfly_deployment_status
Check Interval Recommendation Every minute
Can be called without parameters No (--username and --password are required)
Runs on Cross-platform
Compiled for Windows No (runs with Python interpreter)

Help

usage: wildfly-deployment-status [-h] [-V] [--always-ok]
                                 [--deployment DEPLOYMENT] [--insecure]
                                 [--instance INSTANCE]
                                 [--mode {standalone,domain}] [--no-perfdata]
                                 [--no-proxy] [--node NODE] -p PASSWORD
                                 [--proxy PROXY] [--timeout TIMEOUT]
                                 [--url URL] --username USERNAME

Checks the deployment status of applications on a WildFly/JBoss AS server via
its HTTP management API. Alerts when any deployment is not in the expected
enabled state.

options:
  -h, --help            show this help message and exit
  -V, --version         show program's version number and exit
  --always-ok           Always returns OK.
  --deployment DEPLOYMENT
                        Application deployment name to check. Can be specified
                        multiple times. If not specified, all deployments are
                        checked.
  --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: 3 (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-deployment-status/

Usage Examples

Check all deployments:

./wildfly-deployment-status --username=wildfly-monitoring --password=password --url=http://wildfly:9990

Check specific deployments:

./wildfly-deployment-status --username=wildfly-monitoring --password=password --url=http://wildfly:9990 --deployment=MyFirstApp --deployment=MySecondApp

Output:

2 Deployments checked, everything is ok.

* MyFirstApp is OK
* MySecondApp is RUNNING

States

  • OK if deployment state is "OK" or "RUNNING".
  • WARN if deployment state is "STOPPED".
  • CRIT for any other deployment state.
  • --always-ok suppresses all alerts and always returns OK.

Perfdata / Metrics

Name Type Description
deployment-state-NAME Number 0 (OK), 1 (WARN), 2 (CRIT).

Credits, License