Suricata and Zabbix 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.

This plugin sends metrics to Zabbix via traps, allowing for efficient monitoring of systems and applications. It supports automated configuration and data sending based on dynamic metrics collected by Telegraf.

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.

Zabbix

The Telegraf Zabbix plugin is designed to send metrics to Zabbix, an open-source monitoring solution, using the trap protocol. It supports various versions from 3.0 to 6.0, ensuring compatibility with recent updates. The plugin facilitates easy integration with the Zabbix ecosystem, allowing users to send collected metrics and monitor system performance seamlessly. Key functionalities include the ability to define the address and port of the Zabbix server, options for prefixing keys, determining the type of data sent (active vs. trapper), and features for low-level discovery (LLD) enabling dynamic item creation based on the metrics observed. Configuration options also allow for autoregistration and resending intervals for LLD data, ensuring that the metrics are up-to-date and relevant. Additionally, the trap format used for sending metrics is structured to facilitate efficient data transfer and processing in Zabbix.

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

Zabbix

[[outputs.zabbix]]
  ## Address and (optional) port of the Zabbix server
  address = "zabbix.example.com:10051"

  ## Send metrics as type "Zabbix agent (active)"
  # agent_active = false

  ## Add prefix to all keys sent to Zabbix.
  # key_prefix = "telegraf."

  ## Name of the tag that contains the host name. Used to set the host in Zabbix.
  ## If the tag is not found, use the hostname of the system running Telegraf.
  # host_tag = "host"

  ## Skip measurement prefix to all keys sent to Zabbix.
  # skip_measurement_prefix = false

  ## This field will be sent as HostMetadata to Zabbix Server to autoregister the host.
  ## To enable this feature, this option must be set to a value other than "".
  # autoregister = ""

  ## Interval to resend auto-registration data to Zabbix.
  ## Only applies if autoregister feature is enabled.
  ## This value is a lower limit, the actual resend should be triggered by the next flush interval.
  # autoregister_resend_interval = "30m"

  ## Interval to send LLD data to Zabbix.
  ## This value is a lower limit, the actual resend should be triggered by the next flush interval.
  # lld_send_interval = "10m"

  ## Interval to delete stored LLD known data and start capturing it again.
  ## This value is a lower limit, the actual resend should be triggered by the next flush interval.
  # lld_clear_interval = "1h"

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.

Zabbix

1. Dynamic Monitoring of Containerized Applications: Integration of the Zabbix plugin can be leveraged to monitor Docker containers dynamically. As containers are created and removed, the plugin can automatically update Zabbix with the appropriate metrics, ensuring that monitoring stays current without manual configuration. This enhances visibility into resource usage and performance metrics for microservices orchestrated with Kubernetes or Docker Swarm.

2. Real-Time Performance Monitoring with Auto-registration: By enabling the autoregister feature, the plugin can automatically register hosts in Zabbix based on the metrics received. This scenario provides a streamlined approach to add new hosts to monitoring without manual setup, which is particularly useful in environments where hosts may frequently spin up and down, such as serverless architectures or cloud-based deployments.

3. Leveraging Low-level Discovery for Flexible Metric Capture: Using low-level discovery, this plugin allows Zabbix to adaptively create items for metrics that are not predefined. In a scenario involving multiple network devices reporting different performance metrics, the plugin can dynamically inform Zabbix about new metrics as they appear, thus ensuring comprehensive monitoring capabilities that evolve with the monitored systems.

4. Centralized Monitoring of Distributed Systems: The Zabbix plugin can be utilized in a centralized monitoring setup for distributed systems where multiple Telegraf instances are running across different geographical locations. By sending all metrics to a central Zabbix server, organizations can achieve a holistic view of their infrastructure’s performance and make informed operational decisions.

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.