Suricata and SQLite Integration
Powerful performance with an easy integration, powered by Telegraf, the open source data connector built by InfluxData.
5B+
Telegraf downloads
#1
Time series database
Source: DB Engines
1B+
Downloads of InfluxDB
2,800+
Contributors
Table of Contents
Powerful Performance, Limitless Scale
Collect, organize, and act on massive volumes of high-velocity data. Any data is more valuable when you think of it as time series data. with InfluxDB, the #1 time series platform built to scale with Telegraf.
See Ways to Get Started
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.
Telegraf’s SQL output plugin stores metrics in an SQL database by creating tables dynamically for each metric type. When configured for SQLite, it utilizes a file-based DSN and a minimal SQL schema tailored for lightweight, embedded database usage.
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.
SQLite
The SQL output plugin writes Telegraf metrics to an SQL database using a dynamic schema where each metric type corresponds to a table. For SQLite, the plugin uses the modernc.org/sqlite driver and requires a DSN in the format of a file URI (e.g., ‘file:/path/to/telegraf.db?cache=shared’). This configuration leverages standard ANSI SQL for table creation and data insertion, ensuring compatibility with SQLite’s capabilities.
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
SQLite
[[outputs.sql]]
## Database driver
## Valid options: mssql (Microsoft SQL Server), mysql (MySQL), pgx (Postgres),
## sqlite (SQLite3), snowflake (snowflake.com), clickhouse (ClickHouse)
driver = "sqlite"
## Data source name
## For SQLite, the DSN is a filename or URL with the scheme "file:".
## Example: "file:/path/to/telegraf.db?cache=shared"
data_source_name = "file:/path/to/telegraf.db?cache=shared"
## Timestamp column name
timestamp_column = "timestamp"
## Table creation template
## Available template variables:
## {TABLE} - table name as a quoted identifier
## {TABLELITERAL} - table name as a quoted string literal
## {COLUMNS} - column definitions (list of quoted identifiers and types)
table_template = "CREATE TABLE {TABLE} ({COLUMNS})"
## Table existence check template
## Available template variables:
## {TABLE} - table name as a quoted identifier
table_exists_template = "SELECT 1 FROM {TABLE} LIMIT 1"
## Initialization SQL (optional)
init_sql = ""
## Maximum amount of time a connection may be idle. "0s" means connections are never closed due to idle time.
connection_max_idle_time = "0s"
## Maximum amount of time a connection may be reused. "0s" means connections are never closed due to age.
connection_max_lifetime = "0s"
## Maximum number of connections in the idle connection pool. 0 means unlimited.
connection_max_idle = 2
## Maximum number of open connections to the database. 0 means unlimited.
connection_max_open = 0
## Metric type to SQL type conversion
## The values on the left are the data types Telegraf has and the values on the right are the SQL types used when writing to SQLite.
#[outputs.sql.convert]
# integer = "INT"
# real = "DOUBLE"
# text = "TEXT"
# timestamp = "TIMESTAMP"
# defaultvalue = "TEXT"
# unsigned = "UNSIGNED"
# bool = "BOOL"
Input and output integration examples
Suricata
-
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.
-
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.
-
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.
-
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.
SQLite
- Local Monitoring Storage: Configure the plugin to write metrics to a local SQLite database file. This is ideal for lightweight deployments where setting up a full-scale database server is not required.
- Embedded Applications: Use SQLite as the backend for applications embedded in edge devices, benefiting from its file-based architecture and minimal resource requirements.
- Quick Setup for Testing: Leverage SQLite’s ease of use to quickly set up a testing environment for Telegraf metrics collection without the need for external database services.
- Custom Schema Management: Adjust the table creation templates to predefine your schema if you require specific column types or indexes, ensuring compatibility with your application’s needs.
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.
Powerful Performance, Limitless Scale
Collect, organize, and act on massive volumes of high-velocity data. Any data is more valuable when you think of it as time series data. with InfluxDB, the #1 time series platform built to scale with Telegraf.
See Ways to Get Started
Related Integrations
Related Integrations
HTTP and InfluxDB Integration
The HTTP plugin collects metrics from one or more HTTP(S) endpoints. It supports various authentication methods and configuration options for data formats.
View IntegrationKafka and InfluxDB Integration
This plugin reads messages from Kafka and allows the creation of metrics based on those messages. It supports various configurations including different Kafka settings and message processing options.
View IntegrationKinesis and InfluxDB Integration
The Kinesis plugin allows for reading metrics from AWS Kinesis streams. It supports multiple input data formats and offers checkpointing features with DynamoDB for reliable message processing.
View Integration