Suricata and Redis Integration

Input and output integration overview

This plugin reports internal performance counters of the Suricata IDS/IPS engine and processes the incoming data to fit Telegraf’s format.

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

Suricata

The Suricata plugin captures and reports internal performance metrics from the Suricata IDS/IPS engine, which includes a wide range of statistics such as traffic volume, memory usage, uptime, and counters for flows and alerts. This plugin listens for JSON-formatted log outputs from Suricata, allowing it to parse and format the data for integration with Telegraf. It operates as a service input plugin, meaning it actively waits for metrics or events from Suricata rather than collecting metrics at predefined intervals. The plugin supports configurations for different metrics versions allowing for enhanced flexibility and detailed data gathering.

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

Suricata

[[inputs.suricata]]
  ## Source
  ## Data sink for Suricata stats log. This is expected to be a filename of a
  ## unix socket to be created for listening.
  # source = "/var/run/suricata-stats.sock"

  ## Delimiter
  ## Used for flattening field keys, e.g. subitem "alert" of "detect" becomes
  ## "detect_alert" when delimiter is "_".
  # delimiter = "_"

  ## Metric version
  ## Version 1 only collects stats and optionally will look for alerts if
  ## the configuration setting alerts is set to true.
  ## Version 2 parses any event type message by default and produced metrics
  ## under a single metric name using a tag to differentiate between event
  ## types. The timestamp for the message is applied to the generated metric.
  ## Additional tags and fields are included as well.
  # version = "1"

  ## Alerts
  ## In metric version 1, only status is captured by default, alerts must be
  ## turned on with this configuration option. This option does not apply for
  ## metric version 2.
  # alerts = false

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

Suricata

1. Network Traffic Analysis: Utilize the Suricata plugin to track detailed metrics about network intrusion attempts and performance, aiding in real-time threat detection and response. By visualizing captured alerts and flow statistics, security teams can quickly pinpoint vulnerabilities and mitigate risks.

2. Performance Monitoring Dashboard: Create a dashboard using the Suricata Telegraf plugin metrics to monitor the health and performance of the IDS/IPS engine. This use case provides an overview of memory usage, captured packets, and alert statistics, allowing teams to maintain optimal operating conditions.

3. Automated Security Reporting: Leverage the plugin to generate regular reports on alert statistics and traffic patterns, helping security analysts to identify long-term trends and prepare strategic defense initiatives. Automated reports also ensure that the security posture of the network is continually assessed.

4. Real-time Alert Handling: Integrate Suricata’s alert metrics within a broader incident response automation framework. By incorporating the inputs from the Suricata plugin, organizations can develop smart triggers for alerting and automated response workflows that enhance reaction times to potential threats.

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.