CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: clarify the k and fields topk params (#10830)

This commit is contained in:
Joshua Powers 2022-03-24 10:56:51 -07:00 committed by GitHub
parent 5506f528e5
commit d89972c02c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
plugins/processors/topk/README.md
View File

@ -22,14 +22,21 @@ Notes:
## How many seconds between aggregations
# period = 10
## How many top buckets to return
## How many top buckets to return per field
## Every field specified to aggregate over will return k number of results.
## For example, 1 field with k of 10 will return 10 buckets. While 2 fields
## with k of 3 will return 6 buckets.
# k = 10
## Based on which tags should the buckets be computed. Globs can be specified.
## If set to an empty list tags are not considered when creating the buckets
# group_by = ['*']
## Over which fields is the aggregation done
## The field(s) to aggregate
## Each field defined is used to create an independent aggregation. Each
## aggregation will return k buckets. If a metric does not have a defined
## field the metric will be dropped from the aggregation. Considering using
## the defaults processor plugin to ensure fields are set if required.
# fields = ["value"]
## What aggregation function to use. Options: sum, mean, min, max

11
plugins/processors/topk/topk.go
View File

@ -56,7 +56,10 @@ var sampleConfig = `
## How many seconds between aggregations
# period = 10
## How many top metrics to return
## How many top buckets to return per field
## Every field specified to aggregate over will return k number of results.
## For example, 1 field with k of 10 will return 10 buckets. While 2 fields
## with k of 3 will return 6 buckets.
# k = 10
## Over which tags should the aggregation be done. Globs can be specified, in
@ -64,7 +67,11 @@ var sampleConfig = `
## empty list is no aggregation over tags is done
# group_by = ['*']
## Over which fields are the top k are calculated
## The field(s) to aggregate
## Each field defined is used to create an independent aggregation. Each
## aggregation will return k buckets. If a metric does not have a defined
## field the metric will be dropped from the aggregation. Considering using
## the defaults processor plugin to ensure fields are set if required.
# fields = ["value"]
## What aggregation to use. Options: sum, mean, min, max