MQTT and Datadog Integration

Input and output integration overview

The MQTT plugin reads from the specified topics and creates metrics using the supported input data formats.

This plugin writes to the Datadog Metrics API and requires an apikey which can be obtained for the account. This plugin supports the v1 API.

Integration details

MQTT

This plugin allows Telegraf to consume metrics from specified MQTT topics. It supports a variety of configuration options to connect to MQTT brokers and manage message subscriptions, including features for handling startup errors and using TLS for secure connections.

Datadog

Datadog metric names are formed by joining the Telegraf metric name and the field key with a . character.

Field values are converted to floating point numbers. Strings and floats that cannot be sent over JSON, namely NaN and Inf, are ignored.

Setting rate_interval to non-zero will convert count metrics to rate and divide its value by this interval before submitting to Datadog. This allows Telegraf to submit metrics alongside Datadog agents when their rate intervals are the same (Datadog defaults to 10s). Note that this only supports metrics ingested via inputs.statsd given the dependency on the metric_type tag it creates. There is only support for counter metrics, and count values from timing and histogram metrics.

Configuration

MQTT

[[inputs.mqtt_consumer]]
  servers = ["tcp://127.0.0.1:1883"]
  topics = [
    "telegraf/host01/cpu",
    "telegraf/+/mem",
    "sensors/#",
  ]
  # topic_tag = "topic"
  # qos = 0
  # connection_timeout = "30s"
  # keepalive = "60s"
  # ping_timeout = "10s"
  # max_undelivered_messages = 1000
  # persistent_session = false
  # client_id = ""
  # username = "telegraf"
  # password = "metricsmetricsmetricsmetrics"
  # tls_ca = "/etc/telegraf/ca.pem"
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"
  # insecure_skip_verify = false
  # client_trace = false
  data_format = "influx"
  # [[inputs.mqtt_consumer.topic_parsing]]
  #   topic = ""
  #   measurement = ""
  #   tags = ""
  #   fields = ""
  #   [inputs.mqtt_consumer.topic_parsing.types]
  #      key = type

Datadog

[[outputs.datadog]]
  ## Datadog API key
  apikey = "my-secret-key"

  ## Connection timeout.
  # timeout = "5s"

  ## Write URL override; useful for debugging.
  ## This plugin only supports the v1 API currently due to the authentication
  ## method used.
  # url = "https://app.datadoghq.com/api/v1/series"

  ## Set http_proxy
  # use_system_proxy = false
  # http_proxy_url = "http://localhost:8888"

  ## Override the default (none) compression used to send data.
  ## Supports: "zlib", "none"
  # compression = "none"

  ## When non-zero, converts count metrics submitted by inputs.statsd
  ## into rate, while dividing the metric value by this number.
  ## Note that in order for metrics to be submitted simultaenously alongside
  ## a Datadog agent, rate_interval has to match the interval used by the
  ## agent - which defaults to 10s
  # rate_interval = 0s

Input and output integration examples

MQTT

1. Basic Configuration: This example connects to a local MQTT broker, subscribes to specific topics for CPU and memory metrics, and outputs using the Influx data format.

2. Topic Parsing: Extracts tag values from MQTT topics for better data organization and analysis, allowing metrics to be categorized based on their topics.

3. Field Pivoting: Demonstrates how to pivot single-valued metrics into a multi-field metric. This is useful for consolidating data from multiple sensors into a single metric.

Datadog

1. Basic Metric Submission: Utilize the Datadog Output Plugin to transmit metrics from your Telegraf instance to Datadog. By configuring the apikey and enabling necessary metrics, you can easily monitor application performance over time.
2. Debugging Write URL: In cases where you need to troubleshoot your metric submissions, you can override the default write URL with a custom endpoint to debug the metrics being sent, ensuring that they are reaching the correct destination.
3. Proxy Configuration: If your network setup requires routing through a proxy for outgoing requests, use the http_proxy_url option to set the appropriate proxy. This allows for seamless integration in restrictive network environments.

Feedback

Thank you for being part of our community! If you have any general feedback or found any bugs on these pages, we welcome and encourage your input. Please submit your feedback in the InfluxDB community Slack.