From c37811ccd8b6c9dee832498ff6d62fe2a5371306 Mon Sep 17 00:00:00 2001 From: Pierre Tessier Date: Wed, 30 Jan 2019 01:01:17 -0500 Subject: [PATCH] Update docs on using filtering to group aggregates (#5349) --- docs/AGGREGATORS_AND_PROCESSORS.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/AGGREGATORS_AND_PROCESSORS.md b/docs/AGGREGATORS_AND_PROCESSORS.md index ffa9c8f7e..9cbc39381 100644 --- a/docs/AGGREGATORS_AND_PROCESSORS.md +++ b/docs/AGGREGATORS_AND_PROCESSORS.md @@ -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 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 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, 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 @@ -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 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 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