Consul and Redis 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 Redis plugin enables users to send metrics collected by Telegraf directly to Redis. This integration is ideal for applications that require robust time series data storage and analysis.

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.

Redis

The Redis Telegraf plugin is designed for writing metrics to RedisTimeSeries, a specialized Redis database module for time series data. This plugin facilitates the integration of Telegraf with RedisTimeSeries, allowing for the efficient storage and retrieval of timestamped data. With RedisTimeSeries, users can take advantage of enhanced capabilities for managing time series data, including aggregated views and range queries. The plugin offers various configuration options to enable the flexibility needed to connect securely to your Redis database, including support for Authentication, Timeouts, data type conversions, and TLS configurations. The underlying technology leverages Redis’ efficiency and scalability, making it an excellent choice for high-volume metric environments, where real-time processing is essential.

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

Redis

[[outputs.redistimeseries]]
  ## The address of the RedisTimeSeries server.
  address = "127.0.0.1:6379"

  ## Redis ACL credentials
  # username = ""
  # password = ""
  # database = 0

  ## Timeout for operations such as ping or sending metrics
  # timeout = "10s"

  ## Enable attempt to convert string fields to numeric values
  ## If "false" or in case the string value cannot be converted the string
  ## field will be dropped.
  # convert_string_fields = true

  ## Optional TLS Config
  # 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.

Redis

1. Monitoring IoT Sensor Data: Utilize the Redis Telegraf plugin to collect and store data from IoT sensors in real-time. By connecting the plugin to a RedisTimeSeries database, users can analyze trends in temperature, humidity, or other environmental factors. The ability to query historical sensor data efficiently will aid in predictive maintenance and help in resource management.

2. Financial Market Data Aggregation: Employ this plugin to track and store time-sensitive financial data from various sources. By sending metrics to Redis, financial institutions can aggregate and analyze market trends or price changes over time, providing them with actionable insights derived from reliable time series analytics.

3. Application Performance Monitoring (APM): Implement the Redis plugin for gathering application performance metrics such as response times and CPU usage. Users can visualize their application’s performance over time with RedisTimeSeries, allowing them to identify bottlenecks and optimize resource allocation swiftly.

4. Energy Consumption Tracking: Leverage this plugin to monitor energy usage in buildings over time. By integrating with smart meters and sending data to RedisTimeSeries, municipalities or enterprises can analyze energy consumption patterns, helping to implement energy-saving measures and sustainability practices.

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.