Skip to content

Commit

Permalink
docs(aggregators.final): Swap useful statements
Browse files Browse the repository at this point in the history
The statements seem switched around currently and are causing confusion
for users.
  • Loading branch information
powersj committed Apr 15, 2024
1 parent e2aa248 commit 9a07246
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
12 changes: 7 additions & 5 deletions plugins/aggregators/final/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.

## Output strategy, supported values:
## timeout -- output a metric if no new input arrived for `series_timeout`;
## useful to down sample the input data
## periodic -- output the last received metric every `period`;
## useful for filling gaps in input data
## periodic -- output the last received metric every `period`; useful to
## downsample the input data
# output_strategy = "timeout"
```

Expand All @@ -50,13 +50,15 @@ 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.

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.

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.

This can be helpful to fill in gaps in the data if no input arrived in time.

## Metrics

Expand Down
4 changes: 2 additions & 2 deletions plugins/aggregators/final/sample.conf
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

## Output strategy, supported values:
## timeout -- output a metric if no new input arrived for `series_timeout`;
## useful to down sample the input data
## periodic -- output the last received metric every `period`;
## useful for filling gaps in input data
## periodic -- output the last received metric every `period`; useful to
## downsample the input data
# output_strategy = "timeout"

0 comments on commit 9a07246

Please sign in to comment.