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!

Introducing InfluxDB 3.0

The new core of InfluxDB built with Rust and Apache Arrow. Available today in InfluxDB Cloud Dedicated.

Learn more

State of the InfluxDB Cloud Serverless documentation

The new documentation for InfluxDB Cloud Serverless is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.