Consul and Sumo Logic 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.

The Sumo Logic plugin is designed to facilitate the sending of metrics from Telegraf to Sumo Logic’s HTTP Source. By utilizing this plugin, users can analyze their metric data in the Sumo Logic platform, leveraging various output data formats.

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.

Sumo Logic

This plugin facilitates the transmission of metrics to Sumo Logic’s HTTP Source, employing specified data formats for HTTP messages. Telegraf, which must be version 1.16.0 or higher, can send metrics encoded in several formats, including graphite, carbon2, and prometheus. These formats correspond to different content types recognized by Sumo Logic, ensuring that the metrics are correctly interpreted for analysis. Integration with Sumo Logic allows users to leverage a comprehensive analytics platform, enabling rich visualizations and insights from their metric data. The plugin provides configuration options such as setting URLs for the HTTP Metrics Source, choosing the data format, and specifying additional parameters like timeout and request size, which enhance flexibility and control in data monitoring workflows.

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 = ":"

Sumo Logic

[[outputs.sumologic]]
  ## Unique URL generated for your HTTP Metrics Source.
  ## This is the address to send metrics to.
  # url = "https://events.sumologic.net/receiver/v1/http/"

  ## Data format to be used for sending metrics.
  ## This will set the "Content-Type" header accordingly.
  ## Currently supported formats:
  ## * graphite - for Content-Type of application/vnd.sumologic.graphite
  ## * carbon2 - for Content-Type of application/vnd.sumologic.carbon2
  ## * prometheus - for Content-Type of application/vnd.sumologic.prometheus
  ##
  ## More information can be found at:
  ## https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/HTTP-Source/Upload-Metrics-to-an-HTTP-Source#content-type-headers-for-metrics
  ##
  ## NOTE:
  ## When unset, telegraf will by default use the influx serializer which is currently unsupported
  ## in HTTP Source.
  data_format = "carbon2"

  ## Timeout used for HTTP request
  # timeout = "5s"

  ## Max HTTP request body size in bytes before compression (if applied).
  ## By default 1MB is recommended.
  ## NOTE:
  ## Bear in mind that in some serializer a metric even though serialized to multiple
  ## lines cannot be split any further so setting this very low might not work
  ## as expected.
  # max_request_body_size = 1000000

  ## Additional, Sumo specific options.
  ## Full list can be found here:
  ## https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/HTTP-Source/Upload-Metrics-to-an-HTTP-Source#supported-http-headers

  ## Desired source name.
  ## Useful if you want to override the source name configured for the source.
  # source_name = ""

  ## Desired host name.
  ## Useful if you want to override the source host configured for the source.
  # source_host = ""

  ## Desired source category.
  ## Useful if you want to override the source category configured for the source.
  # source_category = ""

  ## Comma-separated key=value list of dimensions to apply to every metric.
  ## Custom dimensions will allow you to query your metrics at a more granular level.
  # dimensions = ""
</code></pre>

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.

Sumo Logic

1. Real-Time System Monitoring Dashboard: Utilize the Sumo Logic plugin to continuously feed performance metrics from your servers into a Sumo Logic dashboard. This setup allows tech teams to visualize system health and load in real-time, enabling quicker identification of any performance bottlenecks or system failures through detailed graphs and metrics.

2. Automated Alerting System: Configure the plugin to send metrics that trigger alerts in Sumo Logic for specific thresholds such as CPU usage or memory consumption. By setting up automated alerts, teams can proactively address issues before they escalate into critical failures, significantly improving response times and overall system reliability.

3. Cross-System Metrics Aggregation: Integrate multiple Telegraf instances across different environments (development, testing, production) and funnel all metrics to a central Sumo Logic instance using this plugin. This aggregation enables comprehensive analysis across environments, facilitating better monitoring and informed decision-making across the software development lifecycle.

4. Custom Metrics with Dimensions Tracking: Use the Sumo Logic plugin to send customized metrics that include dimensions identifying various aspects of your infrastructure (e.g., environment, service type). This granular tracking allows for more tailored analytics, enabling your team to dissect performance across different application layers or business functions.

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.