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!


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

InfluxDB v3 enhancements and InfluxDB Clustered is now generally available

New capabilities, including faster query performance and management tooling advance the InfluxDB v3 product line. InfluxDB Clustered is now generally available.

InfluxDB v3 performance and features

The InfluxDB v3 product line has seen significant enhancements in query performance and has made new management tooling available. These enhancements include an operational dashboard to monitor the health of your InfluxDB cluster, single sign-on (SSO) support in InfluxDB Cloud Dedicated, and new management APIs for tokens and databases.

Learn about the new v3 enhancements


InfluxDB Clustered general availability

InfluxDB Clustered is now generally available and gives you the power of InfluxDB v3 in your self-managed stack.

Talk to us about InfluxDB Clustered