English | 简体中文

rmqtt-sys-topic

System topics plugin for RMQTT. Publishes broker metrics as $SYS/ MQTT topics for monitoring.

Overview

Periodically publishes broker statistics to the $SYS/ topic tree, which clients can subscribe to for real-time monitoring. This provides visibility into broker health and operational metrics without external monitoring tools.

Available Metrics

The plugin publishes various broker metrics under the $SYS/ hierarchy, including:

• Client statistics: connected client counts, disconnected sessions
• Message statistics: published, received, and delivered message counts
• Broker uptime: time since broker started
• Version information: RMQTT version and build info

Usage

Add the dependency to Cargo.toml:

rmqtt-sys-topic = "0.22"

Register the plugin in your broker startup code:

rmqtt_sys_topic::register(&scx, true, false).await?;

Configuration

File: rmqtt-sys-topic.toml

Default Configuration

publish_qos = 1
publish_interval = "1m"
message_expiry_interval = "5m"

Dependencies

• rmqtt (feature plugin)

License

MIT OR Apache-2.0