stateDuration() function

stateDuration() returns the cumulative duration of a given state.

The state is defined by the fn predicate function. For each consecutive record that evaluates to true, the state duration is incremented by the duration of time between records using the specified unit. When a record evaluates to false, the value is set to -1 and the state duration is reset. If the record generates an error during evaluation, the point is discarded, and does not affect the state duration.

The state duration is added as an additional column to each record. The duration is represented as an integer in the units specified.

Note: As the first point in the given state has no previous point, its state duration will be 0.

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



(Required) Predicate function that identifies the state of a record.


Column to store the state duration in. Default is stateDuration.


Time column to use to calculate elapsed time between rows. Default is _time.


Unit of time to use to increment state duration. Default is 1s (seconds).

Example units:

  • 1ns (nanoseconds)
  • 1us (microseconds)
  • 1ms (milliseconds)
  • 1s (seconds)
  • 1m (minutes)
  • 1h (hours)
  • 1d (days)


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


Return the time spent in a specified state

import "sampledata"
    |> stateDuration(fn: (r) => r._value < 15)

View example input and output

Was this page helpful?

Thank you for your feedback!

Linux Package Signing Key Rotation

All signed InfluxData Linux packages have been resigned with an updated key. If using Linux, you may need to update your package configuration to continue to download and verify InfluxData software packages.

For more information, see the Linux Package Signing Key Rotation blog post.

State of the InfluxDB Cloud (IOx) documentation

The new documentation for InfluxDB Cloud backed by InfluxDB IOx 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.