From fa0dbba658d2080f206ff9f79c0db5794eda994e Mon Sep 17 00:00:00 2001
From: Joshua Powers <powersj@fastmail.com>
Date: Thu, 18 Apr 2024 02:51:46 -0600
Subject: [PATCH] docs(aggregators.final): Swap useful statements (#15159)

---
 plugins/aggregators/final/README.md   | 13 +++++--------
 plugins/aggregators/final/sample.conf | 10 +++++-----
 2 files changed, 10 insertions(+), 13 deletions(-)

diff --git a/plugins/aggregators/final/README.md b/plugins/aggregators/final/README.md
index ee8a73725..f67cad34c 100644
--- a/plugins/aggregators/final/README.md
+++ b/plugins/aggregators/final/README.md
@@ -27,18 +27,18 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 [[aggregators.final]]
   ## The period on which to flush & clear the aggregator.
   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
 
-  ## 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"
 
   ## Output strategy, supported values:
-  ##   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`; useful to
-  ##               downsample the input data
+  ##   timeout  -- output a metric if no new input arrived for `series_timeout`
+  ##   periodic -- output the last received metric every `period`
   # 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
 case metric sporadically arrive in the timeout phase of the period and emitting
 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`
 metric at the end of the period irrespectively of when the last metric arrived,
 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
 
diff --git a/plugins/aggregators/final/sample.conf b/plugins/aggregators/final/sample.conf
index dc24c2d38..66cfdcc49 100644
--- a/plugins/aggregators/final/sample.conf
+++ b/plugins/aggregators/final/sample.conf
@@ -2,16 +2,16 @@
 [[aggregators.final]]
   ## The period on which to flush & clear the aggregator.
   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
 
-  ## 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"
 
   ## Output strategy, supported values:
-  ##   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`; useful to
-  ##               downsample the input data
+  ##   timeout  -- output a metric if no new input arrived for `series_timeout`
+  ##   periodic -- output the last received metric every `period`
   # output_strategy = "timeout"