pub struct Instrument {
    pub name: Cow<'static, str>,
    pub description: Cow<'static, str>,
    pub kind: Option<InstrumentKind>,
    pub unit: Unit,
    pub scope: InstrumentationLibrary,
}
Available on crate feature metrics only.
Expand description

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)§

This struct is marked as 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: Unit

Unit is the unit of measurement recorded by the instrument.

§scope: InstrumentationLibrary

The instrumentation that created the instrument.

Implementations§

source§

impl Instrument

source

pub fn new() -> Instrument

Create a new instrument with default values

source

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

Set the instrument name.

source

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

Set the instrument description.

source

pub fn unit(self, unit: Unit) -> Instrument

Set the instrument unit.

source

pub fn scope(self, scope: InstrumentationLibrary) -> Instrument

Set the instrument scope.

Trait Implementations§

source§

impl Clone for Instrument

source§

fn clone(&self) -> Instrument

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Instrument

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Instrument

source§

fn default() -> Instrument

Returns the “default value” for a type. Read more
source§

impl PartialEq<Instrument> for Instrument

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for Instrument

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FutureExt for T

source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V