From dd9451222bf244661a5740a3c156f2992ac05581 Mon Sep 17 00:00:00 2001 From: Thomas Casteleyn Date: Thu, 12 Sep 2024 23:00:21 +0200 Subject: [PATCH] chore(aggregators): Comment out default values in sample configs (#15864) --- plugins/aggregators/basicstats/README.md | 4 ++-- plugins/aggregators/basicstats/sample.conf | 4 ++-- plugins/aggregators/derivative/README.md | 8 ++++---- plugins/aggregators/derivative/sample.conf | 8 ++++---- plugins/aggregators/final/README.md | 2 +- plugins/aggregators/final/sample.conf | 2 +- plugins/aggregators/histogram/README.md | 4 ++-- plugins/aggregators/histogram/sample.conf | 4 ++-- plugins/aggregators/minmax/README.md | 5 +++-- plugins/aggregators/minmax/sample.conf | 5 +++-- plugins/aggregators/quantile/README.md | 4 ++-- plugins/aggregators/quantile/sample.conf | 4 ++-- plugins/aggregators/valuecounter/README.md | 6 ++++-- plugins/aggregators/valuecounter/sample.conf | 6 ++++-- 14 files changed, 36 insertions(+), 30 deletions(-) diff --git a/plugins/aggregators/basicstats/README.md b/plugins/aggregators/basicstats/README.md index 8fa2ef5f4..2f1621068 100644 --- a/plugins/aggregators/basicstats/README.md +++ b/plugins/aggregators/basicstats/README.md @@ -19,11 +19,11 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. # Keep the aggregate basicstats of each metric passing through. [[aggregators.basicstats]] ## The period on which to flush & clear the aggregator. - period = "30s" + # period = "30s" ## If true, the original metric will be dropped by the ## aggregator and will not get sent to the output plugins. - drop_original = false + # drop_original = false ## 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"] diff --git a/plugins/aggregators/basicstats/sample.conf b/plugins/aggregators/basicstats/sample.conf index 1e2128441..30d5e5836 100644 --- a/plugins/aggregators/basicstats/sample.conf +++ b/plugins/aggregators/basicstats/sample.conf @@ -1,11 +1,11 @@ # Keep the aggregate basicstats of each metric passing through. [[aggregators.basicstats]] ## The period on which to flush & clear the aggregator. - period = "30s" + # period = "30s" ## If true, the original metric will be dropped by the ## aggregator and will not get sent to the output plugins. - drop_original = false + # drop_original = false ## 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"] diff --git a/plugins/aggregators/derivative/README.md b/plugins/aggregators/derivative/README.md index abd25b7af..cfab6e7b7 100644 --- a/plugins/aggregators/derivative/README.md +++ b/plugins/aggregators/derivative/README.md @@ -18,17 +18,17 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. # Calculates a derivative for every field. [[aggregators.derivative]] ## The period in which to flush the aggregator. - period = "30s" - ## + # period = "30s" + ## Suffix to append for the resulting derivative field. # suffix = "_rate" - ## + ## Field to use for the quotient when computing the derivative. ## 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*. ## By default the timestamps of the metrics are used and the suffix is omitted. # variable = "" - ## + ## Maximum number of roll-overs in case only one measurement is found during a period. # max_roll_over = 10 ``` diff --git a/plugins/aggregators/derivative/sample.conf b/plugins/aggregators/derivative/sample.conf index d43f523c2..241d910d2 100644 --- a/plugins/aggregators/derivative/sample.conf +++ b/plugins/aggregators/derivative/sample.conf @@ -1,16 +1,16 @@ # Calculates a derivative for every field. [[aggregators.derivative]] ## The period in which to flush the aggregator. - period = "30s" - ## + # period = "30s" + ## Suffix to append for the resulting derivative field. # suffix = "_rate" - ## + ## Field to use for the quotient when computing the derivative. ## 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*. ## By default the timestamps of the metrics are used and the suffix is omitted. # variable = "" - ## + ## Maximum number of roll-overs in case only one measurement is found during a period. # max_roll_over = 10 diff --git a/plugins/aggregators/final/README.md b/plugins/aggregators/final/README.md index 28e89ce9c..c205750b9 100644 --- a/plugins/aggregators/final/README.md +++ b/plugins/aggregators/final/README.md @@ -26,7 +26,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. # Report the final metric of a series [[aggregators.final]] ## The period on which to flush & clear the aggregator. - period = "30s" + # period = "30s" ## If true, the original metric will be dropped by the ## aggregator and will not get sent to the output plugins. diff --git a/plugins/aggregators/final/sample.conf b/plugins/aggregators/final/sample.conf index 3f5d57ae7..0e8f13e1d 100644 --- a/plugins/aggregators/final/sample.conf +++ b/plugins/aggregators/final/sample.conf @@ -1,7 +1,7 @@ # Report the final metric of a series [[aggregators.final]] ## The period on which to flush & clear the aggregator. - period = "30s" + # period = "30s" ## If true, the original metric will be dropped by the ## aggregator and will not get sent to the output plugins. diff --git a/plugins/aggregators/histogram/README.md b/plugins/aggregators/histogram/README.md index 5185d7166..30cbcd495 100644 --- a/plugins/aggregators/histogram/README.md +++ b/plugins/aggregators/histogram/README.md @@ -43,11 +43,11 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. # Configuration for aggregate histogram metrics [[aggregators.histogram]] ## The period in which to flush the aggregator. - period = "30s" + # period = "30s" ## If true, the original metric will be dropped by the ## 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 ## of accumulating the results. diff --git a/plugins/aggregators/histogram/sample.conf b/plugins/aggregators/histogram/sample.conf index 4b2543fd6..70b7721e2 100644 --- a/plugins/aggregators/histogram/sample.conf +++ b/plugins/aggregators/histogram/sample.conf @@ -1,11 +1,11 @@ # Configuration for aggregate histogram metrics [[aggregators.histogram]] ## The period in which to flush the aggregator. - period = "30s" + # period = "30s" ## If true, the original metric will be dropped by the ## 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 ## of accumulating the results. diff --git a/plugins/aggregators/minmax/README.md b/plugins/aggregators/minmax/README.md index ebb6548ef..f8e7a9cee 100644 --- a/plugins/aggregators/minmax/README.md +++ b/plugins/aggregators/minmax/README.md @@ -19,10 +19,11 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. [[aggregators.minmax]] ## General Aggregator Arguments: ## The period on which to flush & clear the aggregator. - period = "30s" + # period = "30s" + ## If true, the original metric will be dropped by the ## aggregator and will not get sent to the output plugins. - drop_original = false + # drop_original = false ``` ## Measurements & Fields diff --git a/plugins/aggregators/minmax/sample.conf b/plugins/aggregators/minmax/sample.conf index f2316cc68..bc814f486 100644 --- a/plugins/aggregators/minmax/sample.conf +++ b/plugins/aggregators/minmax/sample.conf @@ -2,7 +2,8 @@ [[aggregators.minmax]] ## General Aggregator Arguments: ## The period on which to flush & clear the aggregator. - period = "30s" + # period = "30s" + ## If true, the original metric will be dropped by the ## aggregator and will not get sent to the output plugins. - drop_original = false + # drop_original = false diff --git a/plugins/aggregators/quantile/README.md b/plugins/aggregators/quantile/README.md index 05d0d19b8..db19b88c7 100644 --- a/plugins/aggregators/quantile/README.md +++ b/plugins/aggregators/quantile/README.md @@ -19,11 +19,11 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. [[aggregators.quantile]] ## General Aggregator Arguments: ## The period on which to flush & clear the aggregator. - period = "30s" + # period = "30s" ## If true, the original metric will be dropped by the ## 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 = [0.25, 0.5, 0.75] diff --git a/plugins/aggregators/quantile/sample.conf b/plugins/aggregators/quantile/sample.conf index ee4d47eae..5bffc824b 100644 --- a/plugins/aggregators/quantile/sample.conf +++ b/plugins/aggregators/quantile/sample.conf @@ -2,11 +2,11 @@ [[aggregators.quantile]] ## General Aggregator Arguments: ## The period on which to flush & clear the aggregator. - period = "30s" + # period = "30s" ## If true, the original metric will be dropped by the ## 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 = [0.25, 0.5, 0.75] diff --git a/plugins/aggregators/valuecounter/README.md b/plugins/aggregators/valuecounter/README.md index 7b1e1977d..c71ad5062 100644 --- a/plugins/aggregators/valuecounter/README.md +++ b/plugins/aggregators/valuecounter/README.md @@ -31,10 +31,12 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. [[aggregators.valuecounter]] ## General Aggregator Arguments: ## The period on which to flush & clear the aggregator. - period = "30s" + # period = "30s" + ## If true, the original metric will be dropped by the ## 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 fields = ["status"] ``` diff --git a/plugins/aggregators/valuecounter/sample.conf b/plugins/aggregators/valuecounter/sample.conf index 375f7f01e..763002cd5 100644 --- a/plugins/aggregators/valuecounter/sample.conf +++ b/plugins/aggregators/valuecounter/sample.conf @@ -2,9 +2,11 @@ [[aggregators.valuecounter]] ## General Aggregator Arguments: ## The period on which to flush & clear the aggregator. - period = "30s" + # period = "30s" + ## If true, the original metric will be dropped by the ## 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 fields = ["status"]