title: NetBox: Background workers
agents: netbox
catalog: app/netbox
license: GPLv2
distribution: check_mk
description:
 One service per RQ worker process from {/api/core/background-workers/}.
 Reports the worker's state ({idle}, {busy}, {started}, {suspended}), the queues
 it listens on, its uptime, total working time and its cumulative successful and
 failed job counters. A suspended worker is {WARN} by default; the state mapping
 is configurable via the rule "NetBox background workers".

 The job counters are cumulative over the worker process's lifetime, so levels
 on the failed count only make sense if you restart workers regularly. They are
 unset by default.

 NetBox restricts this endpoint to {superusers}. With a non-superuser token no
 worker services are created and the "NetBox Instance" service explains why.
 The plain number of running workers is available without a superuser token via
 the "NetBox RQ Workers" service.

item:
 The worker name as reported by RQ, usually {hostname.pid}.

discovery:
 One service per worker reported by NetBox. Service labels carry the queues the
 worker listens on ({netbox/queue}).
