Struct FeedMetricsCtx 

#[non_exhaustive]
pub struct FeedMetricsCtx {
    pub meter: Option<Meter>,
    pub per_partition_detail: bool,
}

What the runtime hands a feed backend for its own metric families, through Feed::attach_metrics.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

meter: Option<Meter>

Scoped spate_<backend>_feed_* and pre-labeled with the pipeline, component="feed" and the backend key as component_type. None when the backend key cannot scope a family: a reserved root or custom opts out silently, and a malformed key is logged and also yields None.

per_partition_detail: bool

The calling pipeline’s metrics.per_partition_detail. Gates the backend’s own per-partition families: when false, register and emit only aggregate series. Set whether or not meter is Some.

Implementations

impl FeedMetricsCtx

pub fn new(meter: Option<Meter>) -> Self

Context carrying meter, with per-partition detail off. Backends outside this crate construct it here, as the struct is #[non_exhaustive].

Examples

use spate_core::feed::FeedMetricsCtx;
use spate_core::metrics::{Meter, render_local};

let meter = Meter::with_namespace("probe_feed", "orders", "feed", "probe");
let cx = FeedMetricsCtx::new(Some(meter)).with_partition_detail(true);
assert!(cx.per_partition_detail);

let meter = cx.meter.expect("a scoped Meter");
let text = render_local(|| meter.counter("receives_total", &[]).increment(1));
assert!(text.lines().any(|l| {
    l == r#"spate_probe_feed_receives_total{pipeline="orders",component="feed",component_type="probe"} 1"#
}));

pub fn with_partition_detail(self, enabled: bool) -> Self

Enable cardinality-sensitive per-partition series. Called by the runtime from metrics.per_partition_detail.

Trait Implementations

impl Debug for FeedMetricsCtx

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.