Documentation

stateTracking() function

stateTracking() returns the cumulative count and duration of consecutive rows that match a predicate function that defines a state.

To return the cumulative count of consecutive rows that match the predicate, include the countColumn parameter. To return the cumulative duration of consecutive rows that match the predicate, include the durationColumn parameter. Rows that do not match the predicate function fn return -1 in the count and duration columns.

Function type signature
(
    <-tables: stream[A],
    fn: (r: A) => bool,
    ?countColumn: string,
    ?durationColumn: string,
    ?durationUnit: duration,
    ?timeColumn: string,
) => stream[B] where A: Record, B: Record
For more information, see Function type signatures.

Parameters

fn

(Required) Predicate function to determine state.

countColumn

Column to store state count in.

If not defined, stateTracking() does not return the state count.

durationColumn

Column to store state duration in.

If not defined, stateTracking() does not return the state duration.

durationUnit

Unit of time to report state duration in. Default is 1s.

timeColumn

Column with time values used to calculate state duration. Default is _time.

tables

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

Examples

Return a cumulative state count

data
    |> stateTracking(fn: (r) => r.state == "crit", countColumn: "count")

View example input and output

Return a cumulative state duration in milliseconds

data
    |> stateTracking(fn: (r) => r.state == "crit", durationColumn: "duration", durationUnit: 1ms)

View example input and output

Return a cumulative state count and duration

data
    |> stateTracking(fn: (r) => r.state == "crit", countColumn: "count", durationColumn: "duration")

View example input and output


Was this page helpful?

Thank you for your feedback!


Introducing InfluxDB Clustered

A highly available InfluxDB 3.0 cluster on your own infrastructure.

InfluxDB Clustered is a highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

InfluxDB Clustered is currently in limited availability and is only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.

Learn more
Contact InfluxData Sales

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.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: