Struct MetricKey 

pub struct MetricKey {
    pub name: String,
    pub tags: BTreeMap<String, String>,
}

The name and attributes of one metric, as KIP-714 names them.

Fields

name: String

For example org.apache.kafka.producer.request.total.

tags: BTreeMap<String, String>

The data point attributes, with snake case keys.

Implementations

impl MetricKey

pub fn kafka<'a>( group: &str, name: &str, tags: impl IntoIterator<Item = (&'a str, &'a str)>, ) -> Self

The key of the Kafka metric name in group with tags, as TelemetryMetricNamingConvention maps it: the group and name are lower case and dot separated, the group loses its -metrics part, and each tag key is snake case.

use assert2::assert;
use krabka_client_core::telemetry::MetricKey;

let key = MetricKey::kafka("producer-metrics", "record-send-rate", []);
assert!(key.name == "org.apache.kafka.producer.record.send.rate");

Trait Implementations

impl Clone for MetricKey

fn clone(&self) -> MetricKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetricKey

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

Formats the value using the given formatter.

impl Eq for MetricKey

impl Hash for MetricKey

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 MetricKey

fn cmp(&self, other: &MetricKey) -> 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 MetricKey

fn eq(&self, other: &MetricKey) -> 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 MetricKey

fn partial_cmp(&self, other: &MetricKey) -> 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 StructuralPartialEq for MetricKey