CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(aggregators): Document default settings for period, delay and grace (#16540)

This commit is contained in:
R290 2025-03-14 14:45:34 +01:00 committed by GitHub
parent 1464e4fcf2
commit e1f7bd8d8b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/CONFIGURATION.md
View File

@ -593,14 +593,17 @@ Parameters that can be used with any aggregator plugin:
- **period**: The period on which to flush & clear each aggregator. All - **period**: The period on which to flush & clear each aggregator. All
metrics that are sent with timestamps outside of this period will be ignored metrics that are sent with timestamps outside of this period will be ignored
by the aggregator. by the aggregator.
The default period is set to 30 seconds.
- **delay**: The delay before each aggregator is flushed. This is to control - **delay**: The delay before each aggregator is flushed. This is to control
how long for aggregators to wait before receiving metrics from input how long for aggregators to wait before receiving metrics from input
plugins, in the case that aggregators are flushing and inputs are gathering plugins, in the case that aggregators are flushing and inputs are gathering
on the same interval. on the same interval.
The default delay is set to 100 ms.
- **grace**: The duration when the metrics will still be aggregated - **grace**: The duration when the metrics will still be aggregated
by the plugin, even though they're outside of the aggregation period. This by the plugin, even though they're outside of the aggregation period. This
is needed in a situation when the agent is expected to receive late metrics is needed in a situation when the agent is expected to receive late metrics
and it's acceptable to roll them up into next aggregation period. and it's acceptable to roll them up into next aggregation period.
The default grace duration is set to 0 s.
- **drop_original**: If true, the original metric will be dropped by the - **drop_original**: If true, the original metric will be dropped by the
aggregator and will not get sent to the output plugins. aggregator and will not get sent to the output plugins.
- **name_override**: Override the base name of the measurement. (Default is - **name_override**: Override the base name of the measurement. (Default is

4
plugins/aggregators/merge/README.md
View File

@ -25,6 +25,10 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
```toml @sample.conf ```toml @sample.conf
# Merge metrics into multifield metrics by series key # Merge metrics into multifield metrics by series key
[[aggregators.merge]] [[aggregators.merge]]
## General Aggregator Arguments:
## The period on which to flush & clear the aggregator.
# period = "30s"
## Precision to round the metric timestamp to ## Precision to round the metric timestamp to
## This is useful for cases where metrics to merge arrive within a small ## This is useful for cases where metrics to merge arrive within a small
## interval and thus vary in timestamp. The timestamp of the resulting metric ## interval and thus vary in timestamp. The timestamp of the resulting metric

4
plugins/aggregators/merge/sample.conf
View File

@ -1,5 +1,9 @@
# Merge metrics into multifield metrics by series key # Merge metrics into multifield metrics by series key
[[aggregators.merge]] [[aggregators.merge]]
## General Aggregator Arguments:
## The period on which to flush & clear the aggregator.
# period = "30s"
## Precision to round the metric timestamp to ## Precision to round the metric timestamp to
## This is useful for cases where metrics to merge arrive within a small ## This is useful for cases where metrics to merge arrive within a small
## interval and thus vary in timestamp. The timestamp of the resulting metric ## interval and thus vary in timestamp. The timestamp of the resulting metric