Struct opentelemetry_sdk::InstrumentationLibrary

#[non_exhaustive]
pub struct InstrumentationLibrary {
    pub name: Cow<'static, str>,
    pub version: Option<Cow<'static, str>>,
    pub schema_url: Option<Cow<'static, str>>,
    pub attributes: Vec<KeyValue>,
}

Information about a library or crate providing instrumentation.

An instrumentation library should be named to follow any naming conventions of the instrumented library (e.g. ‘middleware’ for a web framework).

See the instrumentation libraries spec for more information.

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 library name.

This should be the name of the crate providing the instrumentation.

version: Option<Cow<'static, str>>

The library version.

Examples

let library = opentelemetry::InstrumentationLibrary::builder("my-crate").
    with_version(env!("CARGO_PKG_VERSION")).
    with_schema_url("https://opentelemetry.io/schemas/1.17.0").
    build();

schema_url: Option<Cow<'static, str>>

Schema url used by this library.

attributes: Vec<KeyValue>

Specifies the instrumentation scope attributes to associate with emitted telemetry.

Implementations

impl InstrumentationLibrary

pub fn new( name: impl Into<Cow<'static, str>>, version: Option<impl Into<Cow<'static, str>>>, schema_url: Option<impl Into<Cow<'static, str>>>, attributes: Option<Vec<KeyValue>>, ) -> InstrumentationLibrary

👎Deprecated since 0.23.0: Please use builder() instead

Deprecated, use InstrumentationLibrary::builder()

Create an new instrumentation library.

pub fn builder<T>(name: T) -> InstrumentationLibraryBuilder

where T: Into<Cow<'static, str>>,

Create a new builder to create an InstrumentationLibrary

Trait Implementations

impl Clone for InstrumentationLibrary

fn clone(&self) -> InstrumentationLibrary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstrumentationLibrary

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

Formats the value using the given formatter.

impl Default for InstrumentationLibrary

fn default() -> InstrumentationLibrary

Returns the “default value” for a type.

impl Hash for InstrumentationLibrary

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

where H: Hasher,

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 PartialEq for InstrumentationLibrary

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