mosquitto-exporter

command module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 19, 2026 License: Apache-2.0 Imports: 21 Imported by: 0

README

Mosquitto Exporter

Prometheus exporter for the Mosquitto MQTT message broker.

Maintained by buyfakett. This repository is forked from jryberg/mosquitto-exporter and sapcc/mosquitto-exporter.

Usage

The command line accepts one optional application option. The binary contains default.yaml, and the file passed with --config overrides its values:

mosquitto-exporter --config /etc/mosquitto-exporter/config.yaml

Running without --config monitors tcp://127.0.0.1:1883 and listens on port 9234.

See config.example.yaml for a complete example:

port: 9234

groups:
  - name: "production"
    endpoint: "tcp://mosquitto-prod:1883"
    username: "exporter"
    password: "secret"
    client_id: "mosquitto-exporter-production"

  - name: "staging"
    endpoint: "ssl://mosquitto-staging:8883"
    username: "exporter"
    password: "secret"
    cert: "/etc/mosquitto-exporter/client.crt"
    key: "/etc/mosquitto-exporter/client.key"
    client_id: "mosquitto-exporter-staging"

groups[].user and groups[].pass are also accepted as aliases for username and password. Mapping fields are merged recursively; the groups list replaces the embedded default list when supplied. Each group must have a unique name.

If a group does not set client_id, the exporter generates one from the group name and process ID.

Metrics

Existing metric names are preserved. Metrics from different MQTT groups are distinguished with the name label:

broker_clients_connected{name="production"} 12
broker_clients_connected{name="staging"} 4
mosquitto_exporter_up{name="production"} 1
mosquitto_exporter_sys_messages_total{name="production"} 42

The exporter subscribes to $SYS/#. The dashboard in grafana/mosquitto-exporter.json can be imported directly into Grafana and includes a name selector.

If /metrics only shows mosquitto_exporter_up, the exporter is connected but has not received broker $SYS messages yet. Check the broker's $SYS publishing interval and ACL permissions for $SYS/#.

When a broker connection drops, the exporter resets that group's metrics before retrying.

Docker

docker run --rm \
  -p 9234:9234 \
  -v "$PWD/config.yaml:/config.yaml:ro" \
  buyfakett/mosquitto-exporter:latest \
  --config /config.yaml

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL