Struct opentelemetry_sdk::metrics::Instrument

#[non_exhaustive]
pub struct Instrument {
    pub name: Cow<'static, str>,
    pub description: Cow<'static, str>,
    pub kind: Option<InstrumentKind>,
    pub unit: Cow<'static, str>,
    pub scope: Scope,
}

Describes properties an instrument is created with, also used for filtering in Views.

Example

Instruments can be used as criteria for views.

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

let criteria = Instrument::new().name("counter_*");
let mask = Stream::new().aggregation(Aggregation::Sum);

let view = new_view(criteria, mask);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Cow<'static, str>

The human-readable identifier of the instrument.

description: Cow<'static, str>

describes the purpose of the instrument.

kind: Option<InstrumentKind>

The functional group of the instrument.

unit: Cow<'static, str>

Unit is the unit of measurement recorded by the instrument.

scope: Scope

The instrumentation that created the instrument.

Implementations

impl Instrument

pub fn new() -> Self

Create a new instrument with default values

pub fn name(self, name: impl Into<Cow<'static, str>>) -> Self

Set the instrument name.

pub fn description(self, description: impl Into<Cow<'static, str>>) -> Self

Set the instrument description.

pub fn unit(self, unit: impl Into<Cow<'static, str>>) -> Self

Set the instrument unit.

pub fn scope(self, scope: Scope) -> Self

Set the 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 Default for Instrument

fn default() -> Instrument

Returns the “default value” for a type.

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