aggregate.rate() function

aggregate.rate() is experimental and subject to change at any time.

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

For more information, see Function type signatures.



(Required) Duration of time windows.


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


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


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


Calculate the average rate of change in data

import "experimental/aggregate"
import "sampledata"

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

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

View example input and output

Was this page helpful?

Thank you for your feedback!

The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more