MQTT and ServiceNow Integration

Input and output integration overview

The MQTT Telegraf plugin is designed to read from specified MQTT topics and create metrics, enabling users to leverage MQTT for real-time data collection and monitoring.

This output plugin streams metrics from Telegraf directly to a ServiceNow MID Server via HTTP, leveraging the nowmetric serializer for efficient integration with ServiceNow’s Operational Intelligence and Event Management.

Integration details

MQTT

The MQTT plugin allows for reading metrics from specified MQTT topics, creating metrics using supported input data formats. This plugin operates as a service input, which listens for incoming metrics or events rather than gathering them at set intervals like normal plugins. The flexibility of the plugin is enhanced with support for various broker URLs, topics, and connection features, including Quality of Service (QoS) levels and persistent sessions. Its configuration options incorporate global settings to modify metrics and handle startup errors effectively. It also supports secret-store configurations for securing username and password options, ensuring secure connections to MQTT servers.

ServiceNow

Telegraf can be used to send metric data directly to a ServiceNow MID Server REST endpoint. Metrics are formatted either using ServiceNow’s Operational Intelligence (OI) format or JSONv2 format, enabling seamless integration with ServiceNow’s Event Management and Operational Intelligence platforms. The serializer batches metrics efficiently, reducing network overhead by minimizing the number of HTTP POST requests. This integration allows users to quickly leverage metrics in ServiceNow for enhanced observability, proactive incident management, and performance monitoring, with ServiceNow’s operational intelligence capabilities.

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

ServiceNow

[[outputs.http]]
  ## ServiceNow MID Server metrics endpoint
  url = "http://mid-server.example.com:9082/api/mid/sa/metrics"

  ## HTTP request method
  method = "POST"

  ## Basic Authentication credentials
  username = "evt.integration"
  password = "P@$$w0rd!"

  ## Data serialization format for ServiceNow
  data_format = "nowmetric"

  ## Metric format type: "oi" (default) or "jsonv2"
  nowmetric_format = "oi"

  ## HTTP Headers
  [outputs.http.headers]
    Content-Type = "application/json"
    Accept = "application/json"

  ## Optional timeout
  # timeout = "5s"

  ## TLS configuration options
  # tls_ca = "/etc/telegraf/ca.pem"
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"
  # insecure_skip_verify = false

Input and output integration examples

MQTT

1. Smart Home Monitoring: Use the MQTT Consumer plugin to monitor various sensors in a smart home setup. In this scenario, the plugin can be configured to subscribe to topics for different devices, such as temperature, humidity, and energy consumption. By aggregating this data, homeowners can visualize trends and receive alerts for unusual patterns, enhancing the overall quality and efficiency of home automation systems.

2. IoT Environmental Sensing: Deploy the MQTT Consumer to gather environmental data from sensors distributed across different locations. For instance, this can include readings from air quality sensors, temperature sensors, and noise level meters. The plugin can be configured to extract relevant tags and fields from the MQTT topics which allows for detailed analyses and reporting on environmental conditions at scale, supporting better decision making for urban planning or environmental initiatives.

3. Real-Time Vehicle Tracking and Telemetry: Integrate the MQTT Consumer plugin within a vehicle telemetry system that collects data from various sensors in real-time. With the plugin, metrics related to vehicle performance, location, and fuel consumption can be sent to a centralized monitoring dashboard. This real-time telemetry data enables fleet managers to optimize routes, reduce fuel costs, and improve vehicle maintenance schedules through proactive data analysis.

4. Agricultural Monitoring System: Leverage this plugin to collect data from agricultural sensors that monitor soil moisture, crop health, and weather conditions. The MQTT Consumer can subscribe to multiple topics associated with farming equipment and environmental sensors, allowing farmers to make data-driven decisions to improve crop yields while also conserving resources, enhancing sustainability in agriculture.

ServiceNow

1. Proactive Incident Management: Utilize the Telegraf and ServiceNow integration to stream infrastructure and application metrics in real-time to ServiceNow Event Management. Automatically trigger incidents or remediation workflows based on thresholds, significantly reducing incident detection and response times.

2. End-to-End Application Monitoring: Deploy Telegraf agents across multiple layers of an application stack, sending performance metrics directly into ServiceNow. Leveraging ServiceNow’s Operational Intelligence, teams can correlate metrics across components, quickly identifying performance bottlenecks.

3. Dynamic CI Performance Tracking: Integrate Telegraf metrics with ServiceNow’s CMDB by using this plugin to push performance data, allowing automatic updates of Configuration Item (CI) health states based on live metrics. This ensures an accurate and current state of infrastructure health in ServiceNow.

4. Cloud Resource Optimization: Collect metrics from hybrid and multi-cloud infrastructures using Telegraf, streaming directly to ServiceNow. Leverage these metrics for real-time analytics, predictive capacity planning, and resource optimization, enabling proactive management and reduced operational costs.

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.