Back to Telegraf

Basic Statistics Aggregator Plugin

plugins/aggregators/basicstats/README.md

1.38.32.5 KB
Original Source

Basic Statistics Aggregator Plugin

This plugin computes basic statistics such as counts, differences, minima, maxima, mean values, non-negative differences etc. for a set of metrics and emits these statistical values every period.

⭐ Telegraf v1.5.0 🏷️ statistics 💻 all

Global configuration options <!-- @/docs/includes/plugin_config.md -->

Plugins support additional global and plugin configuration settings for tasks such as modifying metrics, tags, and fields, creating aliases, and configuring plugin ordering. See CONFIGURATION.md for more details.

Configuration

toml
# Keep the aggregate basicstats of each metric passing through.
[[aggregators.basicstats]]
  ## 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

  ## Configures which basic stats to push as fields
  # stats = ["count","min","max","mean","variance","stdev"]
  • stats
    • If not specified, then count, min, max, mean, stdev, and s2 are aggregated and pushed as fields. Other fields are not aggregated by default to maintain backwards compatibility.
    • If empty array, no stats are aggregated

Measurements & Fields

  • measurement1
    • field1_count
    • field1_diff (difference)
    • field1_rate (rate per second)
    • field1_max
    • field1_min
    • field1_mean
    • field1_non_negative_diff (non-negative difference)
    • field1_non_negative_rate (non-negative rate per second)
    • field1_percent_change
    • field1_sum
    • field1_s2 (variance)
    • field1_stdev (standard deviation)
    • field1_interval (interval in nanoseconds)
    • field1_last (last aggregated value)
    • field1_first (first aggregated value)

Tags

No tags are applied by this aggregator.

Example Output

text
system,host=tars load1=1 1475583980000000000
system,host=tars load1=1 1475583990000000000
system,host=tars load1_count=2,load1_diff=0,load1_rate=0,load1_max=1,load1_min=1,load1_mean=1,load1_sum=2,load1_s2=0,load1_stdev=0,load1_interval=10000000000i,load1_last=1 1475584010000000000
system,host=tars load1=1 1475584020000000000
system,host=tars load1=3 1475584030000000000
system,host=tars load1_count=2,load1_diff=2,load1_rate=0.2,load1_max=3,load1_min=1,load1_mean=2,load1_sum=4,load1_s2=2,load1_stdev=1.414162,load1_interval=10000000000i,load1_last=3,load1_first=3 1475584010000000000