Struct serde_prometheus_labels::Family

pub struct Family<S, M, C = fn() -> M> { /* private fields */ }

A wrapper around prometheus_client::metrics::family::Family which encodes its labels with Serialize instead of Encode.

Examples

Basic usage:

#[derive(Clone, Eq, Hash, PartialEq, Serialize)]
struct Labels {
    method: Method,
    host: String,
}

#[derive(Clone, Eq, Hash, PartialEq, Serialize)]
enum Method {
    #[serde(rename = "GET")]
    Get,
}

let family = <Family<Labels, Counter>>::default();
let mut registry = Registry::with_prefix("http");

registry.register(
    "Incoming requests",
    "Number of requests per method and per host",
    family.clone(),
);

family
    .get_or_create(&Labels {
        method: Method::Get,
        host: "unionize.org".to_string(),
    })
    .inc();

let mut serialized = String::new();

// SAFETY: We know prometheus-client only writes UTF-8 slices.
unsafe {
    encode(&mut serialized.as_mut_vec(), &registry).unwrap();
}

assert_eq!(
    serialized,
    concat!(
        "# HELP http_Incoming requests Number of requests per method and per host.\n",
        "# TYPE http_Incoming requests counter\n",
        "http_Incoming requests_total{method=\"GET\",host=\"unionize.org\"} 1\n",
        "# EOF\n",
    ),
);

Implementations

impl<S, M, C> Family<S, M, C>where
    S: Clone + Eq + Hash,

pub fn new_with_constructor(constructor: C) -> Self

impl<S, M, C> Family<S, M, C>where
    S: Clone + Eq + Hash,
    C: MetricConstructor<M>,

pub fn get_or_create(&self, label_set: &S) -> MappedRwLockReadGuard<'_, M>

Trait Implementations

impl<S, M, C> Clone for Family<S, M, C>where
    C: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Debug, M: Debug, C: Debug> Debug for Family<S, M, C>

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

Formats the value using the given formatter.

impl<S, M> Default for Family<S, M>where
    S: Clone + Eq + Hash,
    M: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<S, M, C> EncodeMetric for Family<S, M, C>where
    S: Clone + Eq + Hash + Serialize,
    M: EncodeMetric + TypedMetric,
    C: MetricConstructor<M>,

fn encode(&self, encoder: Encoder<'_, '_>) -> Result<()>

fn metric_type(&self) -> MetricType

impl<S, M, C> TypedMetric for Family<S, M, C>where
    M: TypedMetric,

const TYPE: MetricType = <M as TypedMetric>::TYPE