Nodes

Get node metrics

get/nodes/{node}/metrics

Request

  • Base URL: https://docs.emqx.com/api/v5
  • URL: https://docs.emqx.com/api/v5/nodes/{node}/metrics
  • Auth: one of:
    • HTTP basic
    • bearerAuth (a scheme the document does not define)

Path parameters

nodestring required

Node name

Response

Get node metrics successfully

nodestring

Node name

actions.failureinteger

Number of failure executions of the rule engine action

actions.successinteger

Number of successful executions of the rule engine action

bytes.receivedinteger

Number of bytes received

bytes.sentinteger

Number of bytes sent on this connection

client.auth.anonymousinteger

Number of clients who log in anonymously

client.authenticateinteger

Number of client authentications

client.check_authzinteger

Number of Authorization rule checks

client.connackinteger

Number of CONNACK packet sent

client.connectinteger

Number of client connections

client.connectedinteger

Number of successful client connections

client.disconnectedinteger

Number of client disconnects

client.subscribeinteger

Number of client subscriptions

client.unsubscribeinteger

Number of client unsubscriptions

delivery.droppedinteger

Total number of discarded messages when sending

delivery.dropped.expiredinteger

Number of messages dropped due to message expiration on sending

delivery.dropped.no_localinteger

Number of messages that were dropped due to the No Local subscription option when sending

delivery.dropped.qos0_msginteger

Number of messages with QoS 0 that were dropped because the message queue was full when sending

delivery.dropped.queue_fullinteger

Number of messages with a non-zero QoS that were dropped because the message queue was full when sending

delivery.dropped.too_largeinteger

The number of messages that were dropped because the length exceeded the limit when sending

messages.ackedinteger

Number of received PUBACK and PUBREC packet

messages.delayedinteger

Number of delay-published messages

messages.deliveredinteger

Number of messages forwarded to the subscription process internally

messages.droppedinteger

Total number of messages dropped before forwarding to the subscription process

messages.dropped.await_pubrel_timeoutinteger

Number of messages dropped due to waiting PUBREL timeout

messages.dropped.no_subscribersinteger

Number of messages dropped due to no subscribers

messages.forwardinteger

Number of messages forwarded to other nodes

messages.publishinteger

Number of messages published in addition to system messages

messages.qos0.receivedinteger

Number of QoS 0 messages received from clients

messages.qos0.sentinteger

Number of QoS 0 messages sent to clients

messages.qos1.receivedinteger

Number of QoS 1 messages received from clients

messages.qos1.sentinteger

Number of QoS 1 messages sent to clients

messages.qos2.receivedinteger

Number of QoS 2 messages received from clients

messages.qos2.sentinteger

Number of QoS 2 messages sent to clients

messages.receivedinteger

Number of messages received from the client, equal to the sum of messages.qos0.received messages.qos1.received and messages.qos2.received

messages.retainedinteger

Number of retained messages

messages.sentinteger

Number of messages sent to the client, equal to the sum of messages.qos0.sent messages.qos1.sent and messages.qos2.sent

packets.auth.receivedinteger

Number of received AUTH packet

packets.auth.sentinteger

Number of sent AUTH packet

packets.connack.auth_errorinteger

Number of received CONNECT packet with failed authentication

packets.connack.errorinteger

Number of received CONNECT packet with unsuccessful connections

packets.connack.sentinteger

Number of sent CONNACK packet

packets.connect.receivedinteger

Number of received CONNECT packet

packets.disconnect.receivedinteger

Number of received DISCONNECT packet

packets.disconnect.sentinteger

Number of sent DISCONNECT packet

packets.pingreq.receivedinteger

Number of received PINGREQ packet

packets.pingresp.sentinteger

Number of sent PUBRESP packet

packets.puback.inuseinteger

Number of received PUBACK packet with occupied identifiers

packets.puback.missedinteger

Number of received packet with identifiers.

packets.puback.receivedinteger

Number of received PUBACK packet

packets.puback.sentinteger

Number of sent PUBACK packet

packets.pubcomp.inuseinteger

Number of received PUBCOMP packet with occupied identifiers

packets.pubcomp.missedinteger

Number of missed PUBCOMP packet

packets.pubcomp.receivedinteger

Number of received PUBCOMP packet

packets.pubcomp.sentinteger

Number of sent PUBCOMP packet

packets.publish.auth_errorinteger

Number of received PUBLISH packets with failed the Authorization check

packets.publish.droppedinteger

Number of messages discarded due to the receiving limit

packets.publish.errorinteger

Number of received PUBLISH packet that cannot be published

packets.publish.inuseinteger

Number of received PUBLISH packet with occupied identifiers

packets.publish.receivedinteger

Number of received PUBLISH packet

packets.publish.sentinteger

Number of sent PUBLISH packet

packets.pubrec.inuseinteger

Number of received PUBREC packet with occupied identifiers

packets.pubrec.missedinteger

Number of received PUBREC packet with unknown identifiers

packets.pubrec.receivedinteger

Number of received PUBREC packet

packets.pubrec.sentinteger

Number of sent PUBREC packet

packets.pubrel.missedinteger

Number of received PUBREC packet with unknown identifiers

packets.pubrel.receivedinteger

Number of received PUBREL packet

packets.pubrel.sentinteger

Number of sent PUBREL packet

packets.receivedinteger

Number of received packet

packets.sentinteger

Number of sent packet

packets.suback.sentinteger

Number of sent SUBACK packet

packets.subscribe.auth_errorinteger

Number of received SUBACK packet with failed Authorization check

packets.subscribe.errorinteger

Number of received SUBSCRIBE packet with failed subscriptions

packets.subscribe.receivedinteger

Number of received SUBSCRIBE packet

packets.unsuback.sentinteger

Number of sent UNSUBACK packet

packets.unsubscribe.errorinteger

Number of received UNSUBSCRIBE packet with failed unsubscriptions

packets.unsubscribe.receivedinteger

Number of received UNSUBSCRIBE packet

rules.matchedinteger

Number of rule matched

session.createdinteger

Number of sessions created

session.discardedinteger

Number of sessions dropped because Clean Session or Clean Start is true

session.resumedinteger

Number of sessions resumed because Clean Session or Clean Start is false

session.takenoverinteger

Number of sessions takenover because Clean Session or Clean Start is false

session.terminatedinteger

Number of terminated sessions

Changes

No recorded changes to this operation across all 1 revision of this API.