统计指标

GET /api/v4/topic-metrics

返回所有主题统计指标数据。

Path Parameters:

Success Response Body (JSON):

NameTypeDescription
codeInteger0
dataArray of Objects各节点上的统计指标列表
data[0].topicString主题名
data[0].metricsObject主题统计指标数据,详见下面的 metrics:

**metrics: **

NameTypeDescription
messages.qos2.out.rateIntegerQoS 2 消息 5 秒内平均发送速率
messages.qos2.out.countIntegerQoS 2 消息发送数量统计
messages.qos2.in.rateIntegerQoS 2 消息 5 秒内平均接收速率
messages.qos2.in.countIntegerQoS 2 消息接收数量统计
messages.qos1.out.rateIntegerQoS 1 消息 5 秒内平均发送速率
messages.qos1.out.countIntegerQoS 1 消息发送数量统计
messages.qos1.in.rateIntegerQoS 1 消息 5 秒内平均接收速率
messages.qos1.in.countIntegerQoS 1 消息接收数量统计
messages.qos0.out.rateIntegerQoS 0 消息 5 秒内平均发送速率
messages.qos0.out.countIntegerQoS 0 消息发送数量统计
messages.qos0.in.rateIntegerQoS 0 消息 5 秒内平均接收速率
messages.qos0.in.countIntegerQoS 0 消息接收数量统计
messages.out.rateIntegerMQTT 消息 5 秒内平均发送速率
messages.out.countIntegerMQTT 消息发送数量统计
messages.in.rateIntegerMQTT 消息 5 秒内平均接收速率
messages.in.countIntegerMQTT 消息接收数量统计
messages.dropped.rateIntegerMQTT 消息 5 秒内平均丢弃速率
messages.dropped.countIntegerMQTT 消息丢弃数量统计

Examples:

  1. $ curl -i --basic -u admin:public -X GET "http://localhost:8081/api/v4/topic-metrics"
  2. {"data":[],"code":0}
  3. $ curl -i --basic -u admin:public -X POST "http://localhost:8081/api/v4/topic-metrics" -d '{"topic":"a/b/c"}'
  4. {"code":0}
  5. $ curl -i --basic -u admin:public -X GET "http://localhost:8081/api/v4/topic-metrics"
  6. {"data":[{"topic":"a/b/c","metrics":{"messages.qos2.out.rate":0.0,"messages.qos2.out.count":0,"messages.qos2.in.rate":0.0,"messages.qos2.in.count":0,"messages.qos1.out.rate":0.0,"messages.qos1.out.count":0,"messages.qos1.in.rate":0.0,"messages.qos1.in.count":0,"messages.qos0.out.rate":0.0,"messages.qos0.out.count":0,"messages.qos0.in.rate":0.0,"messages.qos0.in.count":0,"messages.out.rate":0.0,"messages.out.count":0,"messages.in.rate":0.0,"messages.in.count":0,"messages.dropped.rate":0.0,"messages.dropped.count":0}}],"code":0}

GET /api/v4/topic-metrics/{topic}

返回指定主题的统计指标数据。

Path Parameters:

Success Response Body (JSON):

NameTypeDescription
codeInteger0
dataObject主题统计指标数据,详见下面的 data:

**data: **

NameTypeDescription
messages.qos2.out.rateIntegerQoS 2 消息 5 秒内平均发送速率
messages.qos2.out.countIntegerQoS 2 消息发送数量统计
messages.qos2.in.rateIntegerQoS 2 消息 5 秒内平均接收速率
messages.qos2.in.countIntegerQoS 2 消息接收数量统计
messages.qos1.out.rateIntegerQoS 1 消息 5 秒内平均发送速率
messages.qos1.out.countIntegerQoS 1 消息发送数量统计
messages.qos1.in.rateIntegerQoS 1 消息 5 秒内平均接收速率
messages.qos1.in.countIntegerQoS 1 消息接收数量统计
messages.qos0.out.rateIntegerQoS 0 消息 5 秒内平均发送速率
messages.qos0.out.countIntegerQoS 0 消息发送数量统计
messages.qos0.in.rateIntegerQoS 0 消息 5 秒内平均接收速率
messages.qos0.in.countIntegerQoS 0 消息接收数量统计
messages.out.rateIntegerMQTT 消息 5 秒内平均发送速率
messages.out.countIntegerMQTT 消息发送数量统计
messages.in.rateIntegerMQTT 消息 5 秒内平均接收速率
messages.in.countIntegerMQTT 消息接收数量统计
messages.dropped.rateIntegerMQTT 消息 5 秒内平均丢弃速率
messages.dropped.countIntegerMQTT 消息丢弃数量统计

Examples:

  1. $ curl -i --basic -u admin:public -X GET "http://localhost:8081/api/v4/topic-metrics/a%2Fb%2Fc"
  2. {"data":{"messages.qos2.out.rate":0.0,"messages.qos2.out.count":0,"messages.qos2.in.rate":0.0,"messages.qos2.in.count":0,"messages.qos1.out.rate":0.0,"messages.qos1.out.count":0,"messages.qos1.in.rate":0.0,"messages.qos1.in.count":0,"messages.qos0.out.rate":0.0,"messages.qos0.out.count":0,"messages.qos0.in.rate":0.0,"messages.qos0.in.count":0,"messages.out.rate":0.0,"messages.out.count":0,"messages.in.rate":0.0,"messages.in.count":0,"messages.dropped.rate":0.0,"messages.dropped.count":0},"code":0}

POST /api/v4/topic-metrics

开启对指定主题的指标统计。

Parameters (json):

NameTypeRequiredDefaultDescription
topicStringRequiredMQTT 主题名

Success Response Body (JSON):

NameTypeDescription
codeInteger0

Examples:

开启对 a/b/c 主题的指标统计

  1. $ curl -i --basic -u admin:public -X POST "http://localhost:8081/api/v4/topic-metrics" -d '{"topic":"a/b/c"}'
  2. {"code":0}

DELETE /api/v4/topic-metrics/{topic}

关闭对指定主题的指标统计。

Path Parameters:

Success Response Body (JSON):

NameTypeDescription
codeInteger0

Examples:

关闭对 a/b/c 主题的指标统计

  1. $ curl -i --basic -u admin:public -X DELETE "http://localhost:8081/api/v4/topic-metrics/a%2Fb%2Fc"
  2. {"code":0}

DELETE /api/v4/topic-metrics

关闭所有主题的指标统计。

Path Parameters:

Success Response Body (JSON):

NameTypeDescription
codeInteger0

Examples:

关闭所有主题的指标统计

  1. $ curl -i --basic -u admin:public -X DELETE "http://localhost:8081/api/v4/topic-metrics"
  2. {"code":0}