Back to Influxdb

increase() function

content/flux/v0/stdlib/universe/increase.md

latest3.0 KB
Original Source
<!------------------------------------------------------------------------------ IMPORTANT: This page was generated from comments in the Flux source code. Any edits made directly to this page will be overwritten the next time the documentation is generated. To make updates to this documentation, update the function comments above the function definition in the Flux source code: https://github.com/influxdata/flux/blob/master/stdlib/universe/universe.flux#L3931-L3934 Contributing to Flux: https://github.com/influxdata/flux#contributing Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ------------------------------------------------------------------------------->

increase() returns the cumulative sum of non-negative differences between subsequent values.

The primary use case for increase() is tracking changes in counter values which may wrap overtime when they hit a threshold or are reset. In the case of a wrap/reset, increase() assumes that the absolute delta between two points is at least their non-negative difference.

Function type signature
js
(<-tables: stream[A], ?columns: [string]) => stream[B] where A: Record, B: Record

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

columns

List of columns to operate on. Default is ["_value"].

tables

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

Examples

Normalize resets in counter metrics

js
import "sampledata"

sampledata.int()
    |> increase()

{{< expand-wrapper >}} {{% expand "View example input and output" %}}

Input data

_time_value*tag
2021-01-01T00:00:00Z-2t1
2021-01-01T00:00:10Z10t1
2021-01-01T00:00:20Z7t1
2021-01-01T00:00:30Z17t1
2021-01-01T00:00:40Z15t1
2021-01-01T00:00:50Z4t1
_time_value*tag
2021-01-01T00:00:00Z19t2
2021-01-01T00:00:10Z4t2
2021-01-01T00:00:20Z-3t2
2021-01-01T00:00:30Z19t2
2021-01-01T00:00:40Z13t2
2021-01-01T00:00:50Z1t2

Output data

_time_value*tag
2021-01-01T00:00:00Z0t1
2021-01-01T00:00:10Z12t1
2021-01-01T00:00:20Z19t1
2021-01-01T00:00:30Z29t1
2021-01-01T00:00:40Z44t1
2021-01-01T00:00:50Z48t1
_time_value*tag
2021-01-01T00:00:00Z0t2
2021-01-01T00:00:10Z4t2
2021-01-01T00:00:20Z4t2
2021-01-01T00:00:30Z26t2
2021-01-01T00:00:40Z39t2
2021-01-01T00:00:50Z40t2

{{% /expand %}} {{< /expand-wrapper >}}