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

docs(aggregators.final): Swap useful statements (#15159)

This commit is contained in:
Joshua Powers 2024-04-18 02:51:46 -06:00 committed by GitHub
parent b2cd9a58ca
commit fa0dbba658
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 10 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
plugins/aggregators/final/README.md
View File

@ -27,18 +27,18 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
[[aggregators.final]] [[aggregators.final]]
## The period on which to flush & clear the aggregator. ## The period on which to flush & clear the aggregator.
period = "30s" period = "30s"
## If true, the original metric will be dropped by the ## 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.
# drop_original = false # drop_original = false
## The time that a series is not updated until considering it final. ## The time that a series is not updated until considering it final. Ignored
## when output_strategy is "periodic".
# series_timeout = "5m" # series_timeout = "5m"
## Output strategy, supported values: ## Output strategy, supported values:
## timeout -- output a metric if no new input arrived for `series_timeout`; ## timeout -- output a metric if no new input arrived for `series_timeout`
## useful for filling gaps in input data ## periodic -- output the last received metric every `period`
## periodic -- output the last received metric every `period`; useful to
## downsample the input data
# output_strategy = "timeout" # output_strategy = "timeout"
``` ```
@ -50,13 +50,10 @@ will not guarantee a regular output of a `final` metric e.g. if the
series-timeout is a multiple of the gathering interval for an input. In this series-timeout is a multiple of the gathering interval for an input. In this
case metric sporadically arrive in the timeout phase of the period and emitting case metric sporadically arrive in the timeout phase of the period and emitting
the `final` metric is suppressed. the `final` metric is suppressed.
This can be helpful to fill in gaps in the data if no input arrived in time.
Contrary to this, `output_strategy = "periodic"` will always output a `final` Contrary to this, `output_strategy = "periodic"` will always output a `final`
metric at the end of the period irrespectively of when the last metric arrived, metric at the end of the period irrespectively of when the last metric arrived,
the `series_timeout` is ignored. the `series_timeout` is ignored.
This is helpful if you for example want to downsample input data arriving at a
high rate and require a periodic output of the `final` metric.
## Metrics ## Metrics

10
plugins/aggregators/final/sample.conf
View File

@ -2,16 +2,16 @@
[[aggregators.final]] [[aggregators.final]]
## The period on which to flush & clear the aggregator. ## The period on which to flush & clear the aggregator.
period = "30s" period = "30s"
## If true, the original metric will be dropped by the ## 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.
# drop_original = false # drop_original = false
## The time that a series is not updated until considering it final. ## The time that a series is not updated until considering it final. Ignored
## when output_strategy is "periodic".
# series_timeout = "5m" # series_timeout = "5m"
## Output strategy, supported values: ## Output strategy, supported values:
## timeout -- output a metric if no new input arrived for `series_timeout`; ## timeout -- output a metric if no new input arrived for `series_timeout`
## useful for filling gaps in input data ## periodic -- output the last received metric every `period`
## periodic -- output the last received metric every `period`; useful to
## downsample the input data
# output_strategy = "timeout" # output_strategy = "timeout"