系统主题

EMQX 周期性发布自身运行状态、消息统计、客户端上下线事件到以 $SYS/ 开头系统主题。

$SYS 主题路径以 $SYS/brokers/{node}/ 开头。{node} 是指产生该 事件 / 消息 所在的节点名称，例如:

$SYS/brokers/emqx@127.0.0.1/version
$SYS/brokers/emqx@127.0.0.1/uptime

$SYS 系统消息发布周期配置项：

broker.sys_interval = 1m

提示

EMQX 默认只允许本机的 MQTT 客户端订阅 $SYS 主题，请参照 ACL File 修改发布订阅 ACL 规则。

EMQX 中 $SYS 主题中绝大部分数据都可以通过其他更耦合性更低的方式获取， 设备上下线状态可通过规则引擎获取。

集群状态信息

客户端上下线事件

$SYS 主题前缀：$SYS/brokers/${node}/clients/

本事件默认为开启状态，关闭请参照sys_topics.sys_event_messages。

connected 事件消息的 Payload 解析成 JSON 格式如下:

{
    "username": "foo",
    "ts": 1625572213873,
    "sockport": 1883,
    "proto_ver": 4,
    "proto_name": "MQTT",
    "keepalive": 60,
    "ipaddress": "127.0.0.1",
    "expiry_interval": 0,
    "connected_at": 1625572213873,
    "connack": 0,
    "clientid": "emqtt-8348fe27a87976ad4db3",
    "clean_start": true
}

disconnected 事件消息的 Payload 解析成 JSON 格式如下:

{
    "username": "foo",
    "ts": 1625572213873,
    "sockport": 1883,
    "reason": "tcp_closed",
    "proto_ver": 4,
    "proto_name": "MQTT",
    "ipaddress": "127.0.0.1",
    "disconnected_at": 1625572213873,
    "clientid": "emqtt-8348fe27a87976ad4db3"
}

客户端订阅与取消订阅事件

本事件默认为关闭状态，开启请参照sys_topics.sys_event_messages。

$SYS 主题前缀：$SYS/brokers/${node}/clients/

subscribed 事件消息的 Payload 解析成 JSON 格式如下:

{
    "username":"foo",
    "ts":1625572213878,
    "topic":"/the/best/mqtt/broker/is/emqx",
    "subopts":{
        "sub_props":{},
        "rh":0,
        "rap":0,
        "qos":0,
        "nl":0,
        "is_new":true
    },
    "protocol":"mqtt",
    "clientid":"emqtt-8348fe27a87976ad4db3"
}

unsubscribed 事件消息的 Payload 解析成 JSON 格式如下:

{
    "username":"foo",
    "ts":1625572213899,
    "topic":"/the/best/mqtt/broker/is/emqx",
    "protocol":"mqtt",
    "clientid":"emqtt-8348fe27a87976ad4db3"
}

系统统计

系统主题前缀：$SYS/brokers/${node}/stats/

客户端统计

订阅统计

主题统计

路由统计

topics/count 和 topics/max 与 routes/count 和 routes/max 数值上是相等的。

收发流量、报文、消息统计

系统主题前缀：$SYS/brokers/${node}/metrics/

收发流量统计

MQTT 报文收发统计

MQTT 消息收发统计

系统告警

系统主题前缀：$SYS/brokers/${node}/alarms/

系统监控

系统主题前缀：$SYS/brokers/${node}/sysmon/