Suricata and AWS Timestream 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.
The AWS Timestream Telegraf plugin enables users to send metrics directly to Amazon’s Timestream service, which is designed for time series data management. This plugin offers a variety of configuration options for authentication, data organization, and retention settings.
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.
AWS Timestream
This plugin is designed to efficiently write metrics to Amazon’s Timestream service, a time series database optimized for IoT and operational applications. With this plugin Telegraf can send data collected from various sources and supports a flexible configuration for authentication, data organization, and retention management. It utilizes a credential chain for authentication, allowing various methods such as web identity, assumed roles, and shared profiles. Users can define how metrics are organized in Timestream—whether to use a single table or multiple tables, alongside control over aspect such as retention periods for both magnetic and memory stores. A key feature is its ability to handle multi-measure records, enabling efficient data ingestion and helping to reduce the overhead of multiple writes. In terms of error handling, the plugin includes mechanisms for addressing common issues related to AWS errors during data writes, such as retry logic for throttling and the ability to create tables as needed.
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
AWS Timestream
[[outputs.timestream]]
## Amazon Region
region = "us-east-1"
## Amazon Credentials
## Credentials are loaded in the following order:
## 1) Web identity provider credentials via STS if role_arn and web_identity_token_file are specified
## 2) Assumed credentials via STS if role_arn is specified
## 3) explicit credentials from 'access_key' and 'secret_key'
## 4) shared profile from 'profile'
## 5) environment variables
## 6) shared credentials file
## 7) EC2 Instance Profile
#access_key = ""
#secret_key = ""
#token = ""
#role_arn = ""
#web_identity_token_file = ""
#role_session_name = ""
#profile = ""
#shared_credential_file = ""
## Endpoint to make request against, the correct endpoint is automatically
## determined and this option should only be set if you wish to override the
## default.
## ex: endpoint_url = "http://localhost:8000"
# endpoint_url = ""
## Timestream database where the metrics will be inserted.
## The database must exist prior to starting Telegraf.
database_name = "yourDatabaseNameHere"
## Specifies if the plugin should describe the Timestream database upon starting
## to validate if it has access necessary permissions, connection, etc., as a safety check.
## If the describe operation fails, the plugin will not start
## and therefore the Telegraf agent will not start.
describe_database_on_start = false
## Specifies how the data is organized in Timestream.
## Valid values are: single-table, multi-table.
## When mapping_mode is set to single-table, all of the data is stored in a single table.
## When mapping_mode is set to multi-table, the data is organized and stored in multiple tables.
## The default is multi-table.
mapping_mode = "multi-table"
## Specifies if the plugin should create the table, if the table does not exist.
create_table_if_not_exists = true
## Specifies the Timestream table magnetic store retention period in days.
## Check Timestream documentation for more details.
## NOTE: This property is valid when create_table_if_not_exists = true.
create_table_magnetic_store_retention_period_in_days = 365
## Specifies the Timestream table memory store retention period in hours.
## Check Timestream documentation for more details.
## NOTE: This property is valid when create_table_if_not_exists = true.
create_table_memory_store_retention_period_in_hours = 24
## Specifies how the data is written into Timestream.
## Valid values are: true, false
## When use_multi_measure_records is set to true, all of the tags and fields are stored
## as a single row in a Timestream table.
## When use_multi_measure_record is set to false, Timestream stores each field in a
## separate table row, thereby storing the tags multiple times (once for each field).
## The recommended setting is true.
## The default is false.
use_multi_measure_records = "false"
## Specifies the measure_name to use when sending multi-measure records.
## NOTE: This property is valid when use_multi_measure_records=true and mapping_mode=multi-table
measure_name_for_multi_measure_records = "telegraf_measure"
## Specifies the name of the table to write data into
## NOTE: This property is valid when mapping_mode=single-table.
# single_table_name = ""
## Specifies the name of dimension when all of the data is being stored in a single table
## and the measurement name is transformed into the dimension value
## (see Mapping data from Influx to Timestream for details)
## NOTE: This property is valid when mapping_mode=single-table.
# single_table_dimension_name_for_telegraf_measurement_name = "namespace"
## Only valid and optional if create_table_if_not_exists = true
## Specifies the Timestream table tags.
## Check Timestream documentation for more details
# create_table_tags = { "foo" = "bar", "environment" = "dev"}
## Specify the maximum number of parallel go routines to ingest/write data
## If not specified, defaulted to 1 go routines
max_write_go_routines = 25
## Please see README.md to know how line protocol data is mapped to Timestream
##
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.
AWS Timestream
-
IoT Data Metrics: Use the Timestream plugin to send real-time metrics from IoT devices to Timestream, allowing for quick analysis and visualization of sensor data. By organizing device readings into a time series format, users can track trends, identify anomalies, and streamline operational decisions based on device performance.
-
Application Performance Monitoring: Leverage Timestream alongside application monitoring tools to send metrics about service performance over time. This integration enables engineers to perform historical analysis of application performance, correlate it with business metrics, and optimize resource allocation based on usage patterns viewed over time.
-
Automated Data Archiving: Configure the Timestream plugin to write data to Timestream while simultaneously managing retention periods. This setup can automate archiving strategies, ensuring that older data is preserved according to predefined criteria. This is especially useful for compliance and historical analysis, allowing businesses to maintain their data lifecycle with minimal manual intervention.
-
Multi-Application Metrics Aggregation: Utilize the Timestream plugin to aggregate metrics from multiple applications into Timestream. By creating a unified database of performance metrics, organizations can gain holistic insights across various services, improving visibility into system-wide performance and facilitating cross-application troubleshooting.
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