Enum Rule 

pub enum Rule {
    ClusterNameLookup {
        cluster_id_label: String,
        output_label: String,
    },
    ReplicaNameLookup {
        cluster_id_label: String,
        replica_id_label: String,
        output_label: String,
    },
    ObjectNameLookup {
        object_id_label: String,
        output_object_label: String,
        output_schema_label: String,
        output_database_label: String,
    },
}

Available on crate feature metrics only.

A declarative enrichment rule applied to a metric family at scrape time.

Each variant reads one or more ID labels already present on a metric and adds one or more resolved name labels.

Variants

ClusterNameLookup

Reads the cluster ID from cluster_id_label and writes the resolved cluster name into output_label.

Fields

cluster_id_label: String

Name of the label on the metric that carries the cluster ID.

output_label: String

Name of the label to add with the resolved cluster name.

ReplicaNameLookup

Reads the cluster ID from cluster_id_label and the replica ID from replica_id_label, then writes the resolved replica name into output_label.

Fields

cluster_id_label: String

Name of the label on the metric that carries the cluster ID.

replica_id_label: String

Name of the label on the metric that carries the replica ID.

output_label: String

Name of the label to add with the resolved replica name.

ObjectNameLookup

Reads a GlobalId from object_id_label and writes the resolved catalog object’s fully-qualified name into three labels: the object name into output_object_label, the schema into output_schema_label, and the database into output_database_label (empty for system objects).

Fields

object_id_label: String

Name of the label on the metric that carries the global ID.

output_object_label: String

Name of the label to add with the resolved object name.

output_schema_label: String

Name of the label to add with the resolved schema name.

output_database_label: String

Name of the label to add with the resolved database name.

Implementations

impl Rule

pub fn object_name_lookup_with_default_labels( object_id_label: impl Into<String>, output_object_label: impl Into<String>, ) -> Rule

Builds an Rule::ObjectNameLookup that resolves object_id_label and writes the object name to output_object_label, with the schema and database written to the default schema_name/database_name labels.

fn resolve<L: NameLookup>( &self, labels: &BTreeMap<&str, &str>, lookup: &L, ) -> Vec<LabelPair>

Resolves this rule against a metric’s current labels using lookup, returning the label pairs the rule wants to add. Empty if the required input labels are missing or the lookup fails to resolve.

pub fn apply<L: NameLookup>(&self, family: &mut MetricFamily, lookup: &L)

Applies the rule to every metric in family, adding the resolved name labels. A label that is already present is left untouched (so rules never overwrite existing values or produce duplicates).

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Rule

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Rule

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Rule

fn cmp(&self, other: &Rule) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Rule

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Rule

fn partial_cmp(&self, other: &Rule) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Rule

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Rule

impl StructuralPartialEq for Rule