Struct MetricFamilyMeta 

pub struct MetricFamilyMeta {
    pub name: String,
    pub ty: MetricType,
    pub unit: Option<String>,
    pub help: Option<String>,
}

One metric family’s OpenMetrics metadata. Identifies the family by name and surfaces its type / unit / help.

The OpenMetrics envelope:

# TYPE process_cpu_seconds_total counter
# UNIT process_cpu_seconds_total seconds
# HELP process_cpu_seconds_total Total user and system CPU time spent in seconds.

becomes:

MetricFamilyMeta {
    name: "process_cpu_seconds_total".into(),
    ty: MetricType::Counter,
    unit: Some("seconds".into()),
    help: Some("Total user and system CPU time spent in seconds.".into()),
}

Fields

name: String

Family name (e.g. http_requests_total, nmbrs_phase_duration_seconds). For histograms / summaries this is the family name; the time-series names emitted on the wire (<name>_bucket, <name>_sum, <name>_count) are derived siblings, not distinct families.

ty: MetricType

Metric type per OpenMetrics 1.0.

unit: Option<String>

Optional unit (seconds, bytes, etc.). Used by completion to surface a hint on the metric name, and by the metricsql evaluator to validate type-incompatible binary ops.

help: Option<String>

Optional help string, lifted verbatim from the OpenMetrics # HELP metadata.

Trait Implementations

impl Clone for MetricFamilyMeta

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetricFamilyMeta

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

Formats the value using the given formatter.

impl Eq for MetricFamilyMeta

impl PartialEq for MetricFamilyMeta

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for MetricFamilyMeta