Skip to main content

gnat_aggregate

Synopsis

Aggregates metrics (telemetry) at designated time intervals from Parquet files.

Description

This tool is designed to process GNAT flow records and produce summation of metrics for various fields. It can be used to generate statistics on network traffic, application usage, and other network-related metrics such as protocols, ip addresses, ports, and more. The output can be used for further analysis, visualization, or reporting purposes. It is particularly useful for generating telemetry data that can be used to monitor network performance, detect anomalies, and gain insights into network behavior.

Environment Variables

If the enviroment variable motherduck_token is set and --output is set to md:<table>, the gnat_metrics tool will use the token to authenticate with MotherDuck. Output will be written to the specified table in MotherDuck.

Options

Options are specified using the --options argument and are separated by semicolons.

--options cache=<path/directory>

The --options cache argument specifies a local direcory to be used for caching aggregation data.

`--options retention=days

The --options retention argument specifies the number of days to retain the aggregation data in the cache directory.

Environment Variables

Examples

See Also