title: NetBox: Instance
agents: netbox
catalog: app/netbox
license: GPLv2
distribution: check_mk
description:
 Reports the installed NetBox version (plus the Django, Python and full release
 version and the instance hostname) from {/api/status/} and measures the
 round-trip time of that request. {/api/status/} is the cheapest authenticated
 endpoint NetBox has, which makes its response time a reasonable proxy for
 overall API responsiveness. The service is {CRIT} if the endpoint cannot be
 read at all (unreachable instance, invalid token, HTTP error).

 The version is also reported as a metric, "NetBox version", so it can be
 graphed: its digits concatenated with no separator (4.4.2 becomes 442) - not a
 real quantity, just a number that changes exactly when the installed version
 does, so a step in the graph shows at a glance when an upgrade ran. Because the
 digits are not zero-padded, a jump across a minor/major version whose patch
 number had more digits than the new one (e.g. 4.4.10 -> 4.5.0, 4410 -> 450) can
 read as a decrease even though it is an upgrade - cosmetic only, the step is
 still visible.

 The service additionally reports optional collectors that were enabled in the
 special agent rule but could not run - most commonly the background queue and
 worker endpoints, which NetBox restricts to superusers. Without that line the
 affected services would simply never be discovered, with no visible reason.

 All states and the response-time levels are configurable via the rule
 "NetBox instance".

discovery:
 One service per host as soon as the agent produced the instance section.
