Documentation

Statusengine decouples a Nagios or Naemon core from its database by putting a message queue between them. Two components do the work:

Broker module

C++ event broker module. Runs inside the monitoring core, publishes JSON to Gearman or RabbitMQ.

Worker

Go daemon. Consumes the queue, writes MySQL, forwards performance data to Graphite.

Once those two are running, the data is in the database. The web interface is what makes it visible, and how an operator acts on it:

Web Interface

Single binary with the frontend built in. Dashboards, history, performance graphs and external commands.

The worker also exposes an HTTP surface of its own — a live event stream, an endpoint for external commands and Prometheus metrics:

Worker API

The worker’s OpenAPI document: /ws, /commands and /metrics, with schemas and examples.

Which order to install in

Install the broker module first. This ensure that your monitoring core starts publishing events to the queue. They will pile up while you install and configure the Statusengine Worker and database. The web interface comes last: it needs a database with data in it before it has anything to show.

Already running Statusengine 3? It is an in-place upgrade. The queues and almost all of the tables are the same, but version 4 dropped several backends, so start here rather than with the installation:

Migrating from Statusengine 3

What version 4 removed, retiring the PHP worker’s service and cronjob, the schema changes, and moving the database off utf8_general_ci.

Choosing a queue

The broker and the worker both speak Gearman and RabbitMQ, and both are configured with a single key. Pick one and use it on both sides:

Gearman

The lighter option. Run gearmand on the same node as the monitoring core so publishing stays a loopback operation.

RabbitMQ

Pick this if you already run RabbitMQ, need TLS between core and queue, or want its management UI for queue depth.

ℹ️

Queues buffer in memory in both cases. The broker publishes RabbitMQ messages as transient, so a queue server restart drops whatever has not been consumed yet.