dom
/
telegraf
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update docs on using filtering to group aggregates (#5349)

This commit is contained in:
Pierre Tessier 2019-01-30 01:01:17 -05:00 committed by Daniel Nelson
parent d207269a30
commit c37811ccd8
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/AGGREGATORS_AND_PROCESSORS.md
View File

@ -44,11 +44,13 @@ to control which metrics are passed through a processor or aggregator. If a
metric is filtered out the metric bypasses the plugin and is passed downstream metric is filtered out the metric bypasses the plugin and is passed downstream
to the next plugin. to the next plugin.
**Processor** plugins process metrics as they pass through and immediately emit ### Processor
Processor plugins process metrics as they pass through and immediately emit
results based on the values they process. For example, this could be printing results based on the values they process. For example, this could be printing
all metrics or adding a tag to all metrics that pass through. all metrics or adding a tag to all metrics that pass through.
**Aggregator** plugins, on the other hand, are a bit more complicated. Aggregators ### Aggregator
Aggregator plugins, on the other hand, are a bit more complicated. Aggregators
are typically for emitting new _aggregate_ metrics, such as a running mean, are typically for emitting new _aggregate_ metrics, such as a running mean,
minimum, maximum, quantiles, or standard deviation. For this reason, all _aggregator_ minimum, maximum, quantiles, or standard deviation. For this reason, all _aggregator_
plugins are configured with a `period`. The `period` is the size of the window plugins are configured with a `period`. The `period` is the size of the window
@ -58,6 +60,10 @@ Since many users will only care about their aggregates and not every single metr
gathered, there is also a `drop_original` argument, which tells Telegraf to only gathered, there is also a `drop_original` argument, which tells Telegraf to only
emit the aggregates and not the original metrics. emit the aggregates and not the original metrics.
Since aggregates are created for each measurement, field, and unique tag combination
the plugin receives, you can make use of `taginclude` to group
aggregates by specific tags only.
**NOTE** That since aggregators only aggregate metrics within their period, that **NOTE** That since aggregators only aggregate metrics within their period, that
historical data is not supported. In other words, if your metric timestamp is more historical data is not supported. In other words, if your metric timestamp is more
than `now() - period` in the past, it will not be aggregated. If this is a feature than `now() - period` in the past, it will not be aggregated. If this is a feature