Compare commits

...
Author SHA1 Message Date
damocles
b699ca8857 docs: drop stale delta-query caveat now that deltatocumulative is live 2026-08-30 20:04:06 +02:00
damocles
34b5fc72fe docs/observability: fix stale hive-metric temporality docs
Usage synopsis was missing --temporality, --type's description still
said cumulative-by-default, and the tasks_completed example comment
still called it a cumulative counter. Also name hive-metric as the
documented exception to the always-cumulative policy, and note the
query-idiom consequence: sum_over_time()/rate_over_sum() instead of
rate()/increase(), since the collector pipeline has no
deltatocumulative processor.
2026-08-30 20:03:44 +02:00
damocles
1e9a00ba46 hive-metric: delta counters by default, cumulative opt-in
A stateless one-shot CLI can't track a running total across invocations,
so cumulative-by-default semantics required a caller to already know and
report the accumulated value every time -- awkward for the common case
(an agent incrementing a counter by 1 per event). Delta is now the
default: send the contribution since the last report, and the collector
accumulates. --temporality cumulative is available for the rare caller
that already tracks its own running total. gauge behavior unchanged.
2026-08-30 20:03:44 +02:00
2 changed files with 47 additions and 7 deletions

View file

@ -327,13 +327,18 @@ Agents can push arbitrary labeled metrics to the same OTEL collector via the
### Usage
```text
hive-metric <name> <value> [--type counter|gauge] [--labels key=value...]
hive-metric <name> <value> [--type counter|gauge] [--temporality delta|cumulative] [--labels key=value...]
```
- `<name>` — metric name (e.g. `tasks_completed`, `latency_ms`).
- `<value>` — numeric value (f64; integers and floats both accepted).
- `--type counter|gauge` — metric kind: `counter` (cumulative sum, default) or
- `--type counter|gauge` — metric kind: `counter` (increasing sum, default) or
`gauge` (instantaneous point-in-time value).
- `--temporality delta|cumulative` — counter reporting mode (`counter` only,
ignored for `gauge`): `delta` (this call's own contribution, default — send
`1` each time and the collector accumulates) or `cumulative` (this call
reports the running total, which a stateless one-shot CLI can't track
itself).
- `--labels key=value` — extra per-data-point labels. May be repeated.
The resource labels (agent, hive, swarm, service.name) are inherited
automatically from `OTEL_RESOURCE_ATTRIBUTES` — do not re-specify them.
@ -341,7 +346,7 @@ hive-metric <name> <value> [--type counter|gauge] [--labels key=value...]
### Examples
```text
# Counter: cumulative tasks finished (default type — no --type flag needed)
# Counter: one more task finished (delta is the default — no flag needed)
hive-metric tasks_completed 1 --labels phase=scan
# Gauge: current queue depth (absolute value — must use --type gauge)
@ -366,8 +371,17 @@ with an informative error message. No silently-dropped metrics.
## Metrics temporality
OTEL export is always configured with **cumulative** temporality
OTEL export is configured with **cumulative** temporality by default
(`OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE=cumulative`),
overriding Claude Code's default of DELTA. This avoids silent metric drops in
Prometheus-family backends (including Grafana LGTM / Mimir) that don't ship a
delta-to-cumulative processor.
**`hive-metric` counters are the one exception**, reporting delta by default
(see above) — programmatically set on the exporter, which overrides this
container-wide env var for that tool specifically. `--type gauge` is
unaffected either way; gauges have no temporality. The hive-tier collector
runs a `deltatocumulative` processor ahead of export, so a delta
`hive-metric` counter still lands in VictoriaMetrics as a cumulative
series — the standard `rate()`/`increase()` idioms work on it exactly like
any other counter in this system, no special query needed.

View file

@ -12,7 +12,7 @@
//!
//! # Usage
//! ```text
//! hive-metric <name> <value> [--type counter|gauge] [--labels key=value...]
//! hive-metric <name> <value> [--type counter|gauge] [--temporality delta|cumulative] [--labels key=value...]
//! ```
use anyhow::{Context, Result, bail};
@ -20,6 +20,7 @@ use clap::Parser;
use opentelemetry::KeyValue;
use opentelemetry::metrics::MeterProvider;
use opentelemetry_otlp::{Protocol, WithExportConfig};
use opentelemetry_sdk::metrics::Temporality;
#[derive(Parser)]
#[command(
@ -39,10 +40,17 @@ struct Cli {
/// negative; counters must be >= 0 (they only increase).
value: f64,
/// Metric kind: `counter` (cumulative sum, default) or `gauge` (instantaneous value).
/// Metric kind: `counter` (increasing sum, default) or `gauge` (instantaneous value).
#[arg(long = "type", value_name = "TYPE", default_value = "counter")]
metric_type: MetricKind,
/// Counter reporting mode: `delta` (this call's own contribution, default —
/// send `1` each time and the collector accumulates) or `cumulative` (this
/// call reports the running total, which a stateless one-shot CLI can't
/// track itself — only meaningful for `--type counter`; ignored for `gauge`).
#[arg(long, value_name = "MODE", default_value = "delta")]
temporality: TemporalityArg,
/// Extra label(s) as `key=value` pairs. May be repeated.
/// Resource labels (agent, hive, swarm) come from `OTEL_RESOURCE_ATTRIBUTES`
/// automatically — do not re-specify them here.
@ -52,12 +60,29 @@ struct Cli {
#[derive(Clone, Debug, clap::ValueEnum)]
enum MetricKind {
/// Counter: monotonically increasing cumulative sum (default).
/// Counter: increasing sum (default).
Counter,
/// Gauge: point-in-time instantaneous value.
Gauge,
}
#[derive(Clone, Debug, clap::ValueEnum)]
enum TemporalityArg {
/// Report this call's own contribution since the last report (default).
Delta,
/// Report the running total as of this call.
Cumulative,
}
impl From<TemporalityArg> for Temporality {
fn from(arg: TemporalityArg) -> Self {
match arg {
TemporalityArg::Delta => Temporality::Delta,
TemporalityArg::Cumulative => Temporality::Cumulative,
}
}
}
fn main() -> Result<()> {
let cli = Cli::parse();
@ -86,6 +111,7 @@ fn main() -> Result<()> {
let exporter = opentelemetry_otlp::MetricExporter::builder()
.with_http()
.with_protocol(Protocol::HttpJson)
.with_temporality(cli.temporality.into())
.build()
.context("failed to build OTLP metric exporter")?;