Struct Instrument

pub struct Instrument { /* private fields */ }

Describes the properties of an instrument at creation, used for filtering in views. This is utilized in the with_view methods on MeterProviderBuilder to customize metric output.

Users can use a reference to Instrument to select which instrument(s) a Stream should be applied to.

Example

use opentelemetry_sdk::metrics::{Instrument, Stream};

let my_view_change_cardinality = |i: &Instrument| {
    if i.name() == "my_second_histogram" {
        // Note: If Stream is invalid, `build()` will return an error. By
        // calling `.ok()`, any such error is ignored and treated as if the
        // view does not match the instrument. If this is not the desired
        // behavior, consider handling the error explicitly.
        Stream::builder().with_cardinality_limit(2).build().ok()
    } else {
        None
    }
};

Implementations

impl Instrument

pub fn name(&self) -> &str

Instrument name.

pub fn kind(&self) -> InstrumentKind

Instrument kind.

pub fn unit(&self) -> &str

Instrument unit.

pub fn scope(&self) -> &InstrumentationScope

Instrument scope.

Trait Implementations

impl Clone for Instrument

fn clone(&self) -> Instrument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Instrument

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

Formats the value using the given formatter.

impl PartialEq for Instrument

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