Expand description
Metric and label name constants — the single source of truth for the
taxonomy documented in docs/METRICS.md.
Every framework metric is registered through these constants; nothing
else may hard-code a metric name. Names follow Prometheus conventions:
_total suffix on counters, unit suffixes (_seconds, _bytes,
_rows) on everything measured in a unit, etl_ prefix throughout.
Constants§
- BACKPRESSURE_
INFLIGHT_ BYTES - Current global in-flight byte budget usage.
- BACKPRESSURE_
PAUSED - 1 while the source is paused by the watermark controller.
- BACKPRESSURE_
PAUSED_ SECONDS_ TOTAL - Cumulative paused time in seconds. Monotonically increasing; exported
as a gauge because the
metricscounter type is integer-only. - BACKPRESSURE_
PAUSE_ EVENTS_ TOTAL - Pause transitions (flapping indicator when high).
- CHECKPOINT_
COMMITS_ TOTAL - Source commit calls, by
L_OUTCOME. - CHECKPOINT_
COMMIT_ DURATION_ SECONDS - Commit round-trip time.
- CHECKPOINT_
PENDING_ BATCHES - Unacknowledged batches tracked; unlabelled series is the max across partitions.
- CHECKPOINT_
WATERMARK_ AGE_ SECONDS - Age of the oldest unacknowledged batch — the primary “stuck pipeline” alert signal.
- COUNTERS
- Every counter name (must end in
_total). - DESER_
BATCH_ DURATION_ SECONDS - Deserialization time per source batch.
- DESER_
NOT_ READY_ TOTAL - Counter: payload replays awaiting an upstream dependency (e.g. a schema
fetch) —
DeserError::NotReadyoccurrences. Not an error and not backpressure. - DESER_
RECORDS_ DROPPED_ TOTAL - Payloads dropped by the Skip error policy, by
L_REASON. - DESER_
RECORDS_ TOTAL - Deserialization outputs plus one
errorper failed payload, byL_OUTCOME. - E2E_
LATENCY_ SECONDS - Source-to-durable-write latency, observed per acknowledged batch.
- GAUGES
- Every gauge name.
- HISTOGRAMS
- Every histogram name (must carry a unit suffix).
- L_
COMPONENT - Component instance id label (e.g.
orders_kafka). - L_
COMPONENT_ TYPE - Component implementation label (e.g.
kafka,clickhouse,map). - L_
ERROR_ TYPE - Error taxonomy class label (
retryable,record_level,fatal). - L_EVENT
- Rebalance event label (
assign,revoke). - L_
OUTCOME - Outcome label (
ok,error). - L_
PARTITION - Source partition label (cardinality-gated by
per_partition_detail). - L_
PIPELINE - Pipeline name label.
- L_QUEUE
- Queue edge label (
<upstream>-><downstream>). - L_
REASON - Drop reason label (
filtered,skip_policy). - L_
REPLICA - Sink replica label.
- L_SHARD
- Sink shard label.
- L_STATE
- Pipeline state label (
starting,running,draining,failed). - L_
VERSION - Build version label on
etl_pipeline_info. - OPERATOR_
BATCH_ DURATION_ SECONDS - Processing time per batch through this operator.
- OPERATOR_
ERRORS_ TOTAL - User-code errors by
L_ERROR_TYPE. - OPERATOR_
RECORDS_ DROPPED_ TOTAL - Records intentionally removed, by
L_REASON. - OPERATOR_
RECORDS_ IN_ TOTAL - Records entering the operator.
- OPERATOR_
RECORDS_ OUT_ TOTAL - Records emitted downstream by the operator.
- PIPELINE_
INFO - Constant 1; carries build metadata via
L_VERSION. - PIPELINE_
STATE - 1 for the current state, 0 otherwise, by
L_STATE. - PIPELINE_
THREADS - Pinned pipeline thread count.
- QUEUE_
CAPACITY - Configured queue bound, by
L_QUEUE. - QUEUE_
DEPTH - Items currently queued, by
L_QUEUE. - QUEUE_
FULL_ EVENTS_ TOTAL try_sendrejections (each is a backpressure signal, never a block).- SINK_
ABANDONED_ BATCHES_ TOTAL - Batches abandoned at the drain deadline (replayed after restart).
- SINK_
BATCH_ BYTES - Bytes per sealed batch.
- SINK_
BATCH_ ROWS - Rows per sealed batch.
- SINK_
BREAKER_ OPENS_ TOTAL - Circuit-breaker open transitions, by
L_SHARDandL_REPLICA. - SINK_
BYTES_ TOTAL - Bytes durably written, by
L_SHARD. - SINK_
ERRORS_ TOTAL - Write errors, by
L_SHARDandL_ERROR_TYPE. - SINK_
FLUSHES_ TOTAL - Flushes by trigger, by
L_SHARDandL_REASON. - SINK_
FLUSH_ DURATION_ SECONDS - Write round-trip per flush including retries, by
L_SHARD. - SINK_
INFLIGHT_ BATCHES - Sealed batches currently in flight, by
L_SHARD. - SINK_
RECORDS_ TOTAL - Records durably written (acknowledged flushes only), by
L_SHARD. - SINK_
REPLICA_ HEALTHY - 1 = circuit closed, 0 = open, by
L_SHARDandL_REPLICA. - SINK_
RETRIES_ TOTAL - Flush attempts beyond the first, by
L_SHARD. - SOURCE_
BYTES_ TOTAL - Payload bytes emitted by the source.
- SOURCE_
LAG_ RECORDS - Consumer lag; unlabelled series is the max across partitions.
- SOURCE_
LANES_ ACTIVE - Currently assigned lanes (partitions).
- SOURCE_
POLL_ DURATION_ SECONDS - Time spent inside
pollper call. - SOURCE_
REBALANCES_ TOTAL - Rebalance events observed, labelled by
L_EVENT. - SOURCE_
RECORDS_ TOTAL - Records emitted by the source (post-poll, pre-deserialization).