Agent Check: HiveMQ

Overview

HiveMQ is a MQTT based messaging platform designed for the fast, efficient and reliable movement of data to and from connected IoT devices. It is a MQTT 3.1, 3.1.1, and 5.0 compliant broker.

Setup

Installation

The HiveMQ check is included in the Datadog Agent package. No additional installation is needed on your server.

Configuration

Host

To configure this check for an Agent running on a host:

Metric collection

1. Edit the hivemq.d/conf.yaml file, in the conf.d/ folder at the root of your Agent's configuration directory to start collecting your HiveMQ performance data. See the sample hivemq.d/conf.yaml for all available configuration options.

   This check has a limit of 350 metrics per instance. The number of returned metrics is indicated in the info page. You can specify the metrics you are interested in by editing the configuration below. To learn how to customize the metrics to collect see the JMX Checks documentation for more detailed instructions. If you need to monitor more metrics, contact Datadog support.

2. Restart the Agent

Log collection

1. Collecting logs is disabled by default in the Datadog Agent, enable it in your datadog.yaml file:

   logs_enabled: true

2. Add the following configuration block to your hivemq.d/conf.yaml file. Change the path and service parameter values based on your environment. See the sample hivemq.d/conf.yaml for all available configuration options.

   logs:
     - type: file
       path: /var/log/hivemq.log
       source: hivemq
       service: <SERVICE>
       log_processing_rules:
         - type: multi_line
           name: log_start_with_date
           pattern: \d{4}\.\d{2}\.\d{2}

3. Restart the Agent.

Containerized

Metric collection

For containerized environments, see the Autodiscovery with JMX guide.

Log collection

Collecting logs is disabled by default in the Datadog Agent. To enable it, see Docker log collection.

Parameter	Value
<LOG_CONFIG>	{"source": "hivemq", "service": "<SERVICE_NAME>"}

Validation

Run the Agent's status subcommand and look for hivemq under the JMXFetch section:

========
JMXFetch
========
  Initialized checks
  ==================
    hivemq
      instance_name : hivemq-localhost-9999
      message :
      metric_count : 46
      service_check_count : 0
      status : OK

Data Collected

Metrics

See metadata.csv for a list of metrics provided by this check.

Service Checks

hivemq.can_connect:
Returns CRITICAL if the Agent is unable to connect to and collect metrics from the monitored HiveMQ instance, otherwise returns OK.

Events

HiveMQ does not include any events.

Service Checks

See service_checks.json for a list of service checks provided by this integration.

Troubleshooting

Need help? Contact Datadog support.