Skip to content

Metric catalogue

The canonical set of metrics every widget, rule, and report binds to. For the concepts behind kind and default aggregation, see Metrics & telemetry.

Source of truth: packages/domain/src/catalog/Metric.ts (METRIC_DEFINITIONS). The catalogue is data-driven — new metrics are added as database rows, so this table is the seeded starter set.

Key Label Unit Kind Default aggregation
water_volume_m3 Total volume counter delta
flow_rate_lpm Flow rate L/min gauge avg
pressure_kpa Pressure kPa gauge avg
level_m Level m gauge avg
temperature_c Temperature °C gauge avg
battery_v Battery V gauge last
rssi_dbm Signal (RSSI) dBm gauge last
snr_db Signal (SNR) dB gauge last

battery_v, rssi_dbm, and snr_db are diagnostics — they describe the sensor’s own health, not the water network, so they never stand in for an asset’s headline reading.

Event metrics have no unit; each occurrence is recorded, and buckets count how many fired.

Key Label
leak Leak
burst_pipe Burst pipe
empty_pipe Empty pipe
tamper Tamper
reverse_flow Reverse flow
low_battery Low battery