Back to Influxdb

promql.instantRate() function

content/flux/v0/stdlib/internal/promql/instantrate.md

latest1.4 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/internal/promql/promql.flux#L122-L125 Contributing to Flux: https://github.com/influxdata/flux#contributing Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ------------------------------------------------------------------------------->

promql.instantRate() is a helper function that calculates instant rates over counters and is used to implement PromQL's irate() and idelta() functions.

Important: The internal/promql package is not meant for external use.

Function type signature
js
(<-tables: stream[{A with _value: float, _time: time}], ?isRate: bool) => stream[{B with _value: float}]

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

Parameters

tables

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

isRate

Data represents a rate.