Telemetry

EMQ collects information about the usage of EMQX Opensource edition through telemetry. This function is designed to provide us with comprehensive information about users and communities, as well as an understanding of how EMQX opensource edition is used. Sharing these metrics with us can help us better understand how you use our products and can continuously help us improve our products.

It is important to note that telemetry data cannot and will not be used to identify or associate you personally. These statistics do not contain individual data, such as server model, hardware number, IP address, and will never be shared with anyone else.

Disabling Telemetry

Telemetry is enabled by default. Some people may feel uncomfortable collecting such data. You can disable it in the simplest way before startup and during operation.

Disable Before Starting EMQX

You can permanently disable telemetry through the configuration file etc/emqx.conf.

  1. telemetry.enable = false

Or to disable telemetry in this boot via environment variables at startup:

  1. export EMQX_TELEMETRY__ENABLE=false && ./bin/emqx start

Disable While Running EMQX

From Dashboard: click the Settings icon on the ribbon area, and turn off the Enable telemetry option to permanently disable telemetry.

Telemetry Metrics

The telemetry data we collect includes:

  1. hardware specifications of the cluster, not including hardware UUID
  2. cluster topology
  3. EMQX version
  4. some configuration enable state
  5. feature enablement
  6. plug-in usage
  7. metrics

Telemetry reports data to by encrypting HTTP requests https://telemetry.emqx.io/api/telemetryTelemetry - 图1 (opens new window)y. The data is stored securely in our private environment and is not exposed to any public network.

For telemetry data collection codes, please refer to apps/emqx_modules/src/emqx_telemetry.erlTelemetry - 图2 (opens new window). If you have any questions, please click IssuesTelemetry - 图3 (opens new window) to contact us.

The data transferred example is as follows：

  1. {
  2.   "emqx_version": "5.0.9",
  3.   "license": {
  4.     "edition": "opensource"
  5.   },
  6.   "os_name": "macOS",
  7.   "os_version": "12.5",
  8.   "otp_version": "24",
  9.   "up_time": 181903,
  10.   "uuid": "5EAAF3C2-6186-11ED-AD7C-D5AAB80CED2E",
  11.   "cluster_uuid": "5EAAF818-6186-11ED-AC1D-3DFDC18ED1BB",
  12.   "nodes_uuid": [],
  13.   "active_plugins": [],
  14.   "num_clients": 0,
  15.   "messages_received": 0,
  16.   "messages_sent": 0,
  17.   "build_info": {
  18.     "wordsize": 64,
  19.     "relform": "tgz",
  20.     "os": "macos11",
  21.     "erlang": "24.2.1-1",
  22.     "elixir": "none",
  23.     "arch": "x86_64-apple-darwin20.6.0"
  24.   },
  25.   "vm_specs": {
  26.     "num_cpus": 8,
  27.     "total_memory": 8589934592
  28.   },
  29.   "mqtt_runtime_insights": {
  30.     "num_topics": 0,
  31.     "messages_sent_rate": 0,
  32.     "messages_received_rate": 0
  33.   },
  34.   "advanced_mqtt_features": {
  35.     "topic_rewrite": 0,
  36.     "retained": 3,
  37.     "delayed": 0,
  38.     "auto_subscribe": 0
  39.   },
  40.   "authn_authz": {
  41.     "authz": [
  42.       "file"
  43.     ],
  44.     "authn_listener": {},
  45.     "authn": []
  46.   },
  47.   "gateway": {},
  48.   "rule_engine": {
  49.     "num_rules": 1
  50.   },
  51.   "bridge": {
  52.     "num_data_bridges": 1,
  53.     "data_bridge": {
  54.       "webhook": {
  55.         "num_linked_by_rules": 1,
  56.         "num": 1
  57.       }
  58.     }
  59.   },
  60.   "exhook": {
  61.     "servers": [],
  62.     "num_servers": 0
  63.   }
  64. }