Versions:
Counter and gauge aggregation
This section contains functions related to counter and gauge aggregation. Counter aggregation functions are used to accumulate monotonically increasing data by treating any decrements as resets. Gauge aggregates are similar, but are used to track data which can decrease as well as increase. For more information about counter aggregation functions, see the hyperfunctions documentation.
Some hyperfunctions are included in the default TimescaleDB product. For additional hyperfunctions, you need to install the Timescale Toolkit PostgreSQL extension.
| Hyperfunction subfamily | Hyperfunction type | API call | Toolkit | Experimental |
|---|---|---|---|---|
| Counter aggregation | Aggregate | counter_agg | ✅ | |
| Accessor | corr | ✅ | ||
counter_zero_time | ✅ | |||
extrapolated_delta | ✅ | |||
extrapolated_rate | ✅ | |||
intercept | ✅ | |||
irate_left | irate_right | ✅ | |||
num_changes | ✅ | |||
num_elements | ✅ | |||
num_resets | ✅ | |||
rate | ✅ | |||
slope | ✅ | |||
time_delta | ✅ | |||
| Mutator | with_bounds | ✅ | ||
| Counter | gauge aggregation | Accessor | delta | ✅ | |
idelta_left | idelta_right | ✅ | |||
| Rollup | counter | ✅ | ||
| Gauge aggregation | Accessor | gauge_agg | ✅ | ✅ |
important
All accessors can be used with
CounterSummary. The accessors delta, idelta_left, and idelta_right can be used with GaugeSummary. GaugeSummary will eventually support all the accessors, with the exception of num_resets.Found an issue on this page?
Report an issue!