title: NetBox: Health check
agents: netbox
catalog: app/netbox
license: GPLv2
distribution: check_mk
description:
 Queries the endpoint of the {netbox-healthcheck-plugin}, which reports the
 health of PostgreSQL, the Django cache and both Redis instances (the cache
 Redis and the RQ task-queue Redis). A component is healthy when it reports
 "working" (django-health-check 3.x) or "OK" (the 4.x rewrite); any other
 value is its error text and sets the service to {CRIT} by default.

 NetBox core has no health endpoint, so this requires the separate plugin
 {netbox-healthcheck-plugin} to be installed and listed in {PLUGINS} in
 NetBox's configuration.py. If the endpoint answers with HTTP 404 the service
 reports {WARN} and says so explicitly - that is a configuration gap on the
 NetBox side, not an outage.

 All states and the endpoint path are configurable (rule "NetBox health check"
 and the special agent rule). The check is opt-in.

discovery:
 One service per host when health monitoring is enabled in the special agent
 rule.
