Skip to content

Logs and Observability

EMQX provides built-in observability features, external integrations, and production monitoring guidance to help you monitor, manage, and diagnose a deployment. The following pages cover production monitoring, observability data and integrations, and diagnostic tools.

Production Monitoring:

  • Production Monitoring Best Practices

    Design production monitoring and alerts to identify availability, capacity, dependency, and message-delivery risks and support timely maintenance.

Observability and Integrations:

  • Metrics

    EMQX provides metrics monitoring functions, based on which the operation and maintenance personnel can monitor the current service status and troubleshoot possible system malfunctions. Users can use the EMQX Dashboard, HTTP API, and system topics to trace the metrics data.

  • Alarm

    EMQX has offered a built-in monitoring and alarm functionality for monitoring the CPU occupancy, system and process memory occupancy, number of processes, rule engine resource status, cluster partition and healing, and will raise an alarm in case of system malfunctions.

  • Logs

    Logs provide a reliable source of information for troubleshooting and system performance optimization. You can find the record about the access, operating, or network issues from EMQX logs.

  • Integrate with Prometheus

    Prometheus is the monitoring solution open-sourced by SoundCloud, featuring its support for multidimensional data models, flexible query language, and powerful alarm management. EMQX supports integrating with Prometheus to collect system metrics and pushing metrics to pushgateway.

  • Broker Health Indicators

    A curated reference of the most useful Prometheus metrics for monitoring an EMQX broker, organized by system, broker, authentication / authorization, and data integration. Use it together with the Prometheus integration guide to decide what to scrape, alert on, and chart.

  • Integrate with Datadog

    Datadog is an observability platform that provides unified, real-time observability and security solutions for applications. EMQX supports the integration of Datadog to help you understand the EMQX operating status, monitor and troubleshoot system performance issues, and view EMQX metrics on the Datadog console.

Diagnostics:

  • Topic Metrics

    Topic Metrics tracks incoming, outgoing, and dropped messages for selected MQTT topics. You can monitor a specific topic in the Dashboard. Starting from EMQX 6.3, you can also create named collections with wildcard topic filters through the REST API and export their counters to Prometheus.

  • Slow Subscriptions

    Typically, EMQX will finish the message transmission within milliseconds, affected mainly by the network. However, there are cases where the latency of subscription messages is very high on the client side. To solve this problem, EMQX provides a Slow subscriptions feature.

  • Log Trace

    EMQX 5.x has added the Log Trace feature, allowing users only to enable debug-level logs output for specific client IDs, topics or IPs in real-time.

  • Mria Logs and Alarms

    Describes the log messages and alarms reported by the Mria database management system, including how to identify and interpret network partition events and cluster recovery progress.