aggregate.rate() function

aggregate.rate() calculates the average rate of increase per window of time for each input table.

aggregate.rate() requires that input data have _start and _stop columns to calculate windows of time to operate on. Use range() to assign _start and _stop values.

This function is designed to replicate the Prometheus rate() function and should only be used with counters.

Function type signature

(<-tables: stream[A], every: duration, ?groupColumns: [string], ?unit: duration) => stream[B] where A: Record, B: Record

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

every

({{< req >}}) Duration of time windows.

groupColumns

List of columns to group by. Default is [].

unit

Time duration to use when calculating the rate. Default is 1s.

tables

Input data. Default is piped-forward data (<-).

Examples

Calculate the average rate of change in data

import "experimental/aggregate"
import "sampledata"

data =
    sampledata.int()
        |> range(start: sampledata.start, stop: sampledata.stop)

data
    |> aggregate.rate(every: 30s, unit: 1s, groupColumns: ["tag"])

{{< expand-wrapper >}} {{% expand "View example input and output" %}}

Input data

Output data

{{% /expand %}} {{< /expand-wrapper >}}