Telemetry

Get telemetry data

get/telemetry/data

Request

  • Base URL: https://docs.emqx.com/api/v5
  • URL: https://docs.emqx.com/api/v5/telemetry/data
  • Auth: one of:
    • HTTP basic
    • bearerAuth (a scheme the document does not define)

Response

Get telemetry data

emqx_versionstring

Get emqx version

licenseobject

Get license information

os_namestring

Get OS name

os_versionstring

Get OS version

otp_versionstring

Get Erlang OTP version

up_timeinteger

Get uptime

uuidstring

Get UUID

nodes_uuidstring[]

Get nodes UUID

active_pluginsstring[]

Get active plugins

active_modulesstring[]

Get active modules

num_clientsinteger

Get number of clients

messages_receivedinteger

Get number of messages received

messages_sentinteger

Get number of messages sent

Example response

{
  "emqx_version": "5.0.0-beta.3-32d1547c",
  "license": {
    "edition": "opensource"
  },
  "os_name": "Linux",
  "os_version": "20.04",
  "otp_version": "24",
  "up_time": 20220113,
  "uuid": "AAAAAAAA-BBBB-CCCC-2022-DDDDEEEEFFF",
  "nodes_uuid": [
    "AAAAAAAA-BBBB-CCCC-2022-DDDDEEEEFFF",
    "ZZZZZZZZ-CCCC-BBBB-2022-DDDDEEEEFFF"
  ],
  "active_plugins": [
    "Plugin A",
    "Plugin B"
  ],
  "active_modules": [
    "Module A",
    "Module B"
  ],
  "num_clients": 20220113,
  "messages_received": 2022,
  "messages_sent": 2022
}

Changes

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