Consul and ServiceNow Integration

Input and output integration overview

The Consul Input Plugin collects health check metrics from a Consul server, allowing users to monitor service statuses effectively.

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

Consul

The Consul Input Plugin is designed to gather health check statuses from all services registered with Consul, a tool for service discovery and infrastructure management. By querying the Consul API, this plugin helps users monitor the health of their services and ensure that they are operational and meeting service level agreements. It does not provide telemetry data, but users can utilize StatsD if they want to collect those metrics. The plugin offers configuration options to connect to the Consul server, manage authentication, and specify how to handle tags derived from health checks.

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

Consul

[[inputs.consul]]
  ## Consul server address
  # address = "localhost:8500"

  ## URI scheme for the Consul server, one of "http", "https"
  # scheme = "http"

  ## Metric version controls the mapping from Consul metrics into
  ## Telegraf metrics. Version 2 moved all fields with string values
  ## to tags.
  ##
  ##   example: metric_version = 1; deprecated in 1.16
  ##            metric_version = 2; recommended version
  # metric_version = 1

  ## ACL token used in every request
  # token = ""

  ## HTTP Basic Authentication username and password.
  # username = ""
  # password = ""

  ## Data center to query the health checks from
  # datacenter = ""

  ## Optional TLS Config
  # tls_ca = "/etc/telegraf/ca.pem"
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"
  ## Use TLS but skip chain & host verification
  # insecure_skip_verify = true

  ## Consul checks' tag splitting
  # When tags are formatted like "key:value" with ":" as a delimiter then
  # they will be split and reported as proper key:value in Telegraf
  # tag_delimiter = ":"

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

Consul

1. Service Health Monitoring Dashboard: Utilize the Consul Input Plugin to create a comprehensive health monitoring dashboard for all services registered with Consul. This allows operations teams to visualize the health status in real time, enabling quick identification of service issues and facilitating rapid responses to service outages or performance degradation.

2. Automated Alerting System: Implement an automated alerting system that uses the health check data gathered by the Consul Input Plugin to trigger notifications whenever a service status changes to critical. This setup can integrate with notification systems like Slack or email, ensuring that team members are alerted immediately to address potential issues.

3. Integration with Incident Management: Leverage the health check data from the Consul Input Plugin to feed into incident management systems. By analyzing the health status trends, teams can prioritize incidents based on the criticality of the affected services and streamline their resolution processes, improving overall service reliability and customer satisfaction.

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.