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

chore(aggregators): Comment out default values in sample configs (#15864)

This commit is contained in:
Thomas Casteleyn 2024-09-12 23:00:21 +02:00 committed by GitHub
parent 358224fa02
commit dd9451222b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
14 changed files with 36 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -19,11 +19,11 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
# Keep the aggregate basicstats of each metric passing through. # Keep the aggregate basicstats of each metric passing through.
[[aggregators.basicstats]] [[aggregators.basicstats]]
## 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
## Configures which basic stats to push as fields ## Configures which basic stats to push as fields
# stats = ["count","diff","rate","min","max","mean","non_negative_diff","non_negative_rate","percent_change","stdev","s2","sum","interval","last"] # stats = ["count","diff","rate","min","max","mean","non_negative_diff","non_negative_rate","percent_change","stdev","s2","sum","interval","last"]

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

@ -1,11 +1,11 @@
# Keep the aggregate basicstats of each metric passing through. # Keep the aggregate basicstats of each metric passing through.
[[aggregators.basicstats]] [[aggregators.basicstats]]
## 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
## Configures which basic stats to push as fields ## Configures which basic stats to push as fields
# stats = ["count","diff","rate","min","max","mean","non_negative_diff","non_negative_rate","percent_change","stdev","s2","sum","interval","last"] # stats = ["count","diff","rate","min","max","mean","non_negative_diff","non_negative_rate","percent_change","stdev","s2","sum","interval","last"]

8
plugins/aggregators/derivative/README.md
View File

@ -18,17 +18,17 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
# Calculates a derivative for every field. # Calculates a derivative for every field.
[[aggregators.derivative]] [[aggregators.derivative]]
## The period in which to flush the aggregator. ## The period in which to flush the aggregator.
period = "30s" # period = "30s"
##
## Suffix to append for the resulting derivative field. ## Suffix to append for the resulting derivative field.
# suffix = "_rate" # suffix = "_rate"
##
## Field to use for the quotient when computing the derivative. ## Field to use for the quotient when computing the derivative.
## When using a field as the derivation parameter the name of that field will ## When using a field as the derivation parameter the name of that field will
## be used for the resulting derivative, e.g. *fieldname_by_parameter*. ## be used for the resulting derivative, e.g. *fieldname_by_parameter*.
## By default the timestamps of the metrics are used and the suffix is omitted. ## By default the timestamps of the metrics are used and the suffix is omitted.
# variable = "" # variable = ""
##
## Maximum number of roll-overs in case only one measurement is found during a period. ## Maximum number of roll-overs in case only one measurement is found during a period.
# max_roll_over = 10 # max_roll_over = 10
``` ```

8
plugins/aggregators/derivative/sample.conf
View File

@ -1,16 +1,16 @@
# Calculates a derivative for every field. # Calculates a derivative for every field.
[[aggregators.derivative]] [[aggregators.derivative]]
## The period in which to flush the aggregator. ## The period in which to flush the aggregator.
period = "30s" # period = "30s"
##
## Suffix to append for the resulting derivative field. ## Suffix to append for the resulting derivative field.
# suffix = "_rate" # suffix = "_rate"
##
## Field to use for the quotient when computing the derivative. ## Field to use for the quotient when computing the derivative.
## When using a field as the derivation parameter the name of that field will ## When using a field as the derivation parameter the name of that field will
## be used for the resulting derivative, e.g. *fieldname_by_parameter*. ## be used for the resulting derivative, e.g. *fieldname_by_parameter*.
## By default the timestamps of the metrics are used and the suffix is omitted. ## By default the timestamps of the metrics are used and the suffix is omitted.
# variable = "" # variable = ""
##
## Maximum number of roll-overs in case only one measurement is found during a period. ## Maximum number of roll-overs in case only one measurement is found during a period.
# max_roll_over = 10 # max_roll_over = 10

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

@ -26,7 +26,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
# Report the final metric of a series # Report the final metric of a series
[[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.

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

@ -1,7 +1,7 @@
# Report the final metric of a series # Report the final metric of a series
[[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.

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

@ -43,11 +43,11 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
# Configuration for aggregate histogram metrics # Configuration for aggregate histogram metrics
[[aggregators.histogram]] [[aggregators.histogram]]
## The period in which to flush the aggregator. ## The period in which to flush 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
## If true, the histogram will be reset on flush instead ## If true, the histogram will be reset on flush instead
## of accumulating the results. ## of accumulating the results.

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

@ -1,11 +1,11 @@
# Configuration for aggregate histogram metrics # Configuration for aggregate histogram metrics
[[aggregators.histogram]] [[aggregators.histogram]]
## The period in which to flush the aggregator. ## The period in which to flush 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
## If true, the histogram will be reset on flush instead ## If true, the histogram will be reset on flush instead
## of accumulating the results. ## of accumulating the results.

5
plugins/aggregators/minmax/README.md
View File

@ -19,10 +19,11 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
[[aggregators.minmax]] [[aggregators.minmax]]
## General Aggregator Arguments: ## General Aggregator Arguments:
## 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
``` ```
## Measurements & Fields ## Measurements & Fields

5
plugins/aggregators/minmax/sample.conf
View File

@ -2,7 +2,8 @@
[[aggregators.minmax]] [[aggregators.minmax]]
## General Aggregator Arguments: ## General Aggregator Arguments:
## 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

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

@ -19,11 +19,11 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
[[aggregators.quantile]] [[aggregators.quantile]]
## General Aggregator Arguments: ## General Aggregator Arguments:
## 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
## Quantiles to output in the range [0,1] ## Quantiles to output in the range [0,1]
# quantiles = [0.25, 0.5, 0.75] # quantiles = [0.25, 0.5, 0.75]

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

@ -2,11 +2,11 @@
[[aggregators.quantile]] [[aggregators.quantile]]
## General Aggregator Arguments: ## General Aggregator Arguments:
## 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
## Quantiles to output in the range [0,1] ## Quantiles to output in the range [0,1]
# quantiles = [0.25, 0.5, 0.75] # quantiles = [0.25, 0.5, 0.75]

6
plugins/aggregators/valuecounter/README.md
View File

@ -31,10 +31,12 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
[[aggregators.valuecounter]] [[aggregators.valuecounter]]
## General Aggregator Arguments: ## General Aggregator Arguments:
## 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 fields for which the values will be counted ## The fields for which the values will be counted
fields = ["status"] fields = ["status"]
``` ```

6
plugins/aggregators/valuecounter/sample.conf
View File

@ -2,9 +2,11 @@
[[aggregators.valuecounter]] [[aggregators.valuecounter]]
## General Aggregator Arguments: ## General Aggregator Arguments:
## 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 fields for which the values will be counted ## The fields for which the values will be counted
fields = ["status"] fields = ["status"]