Struct InstrumentationLibraryBuilder

pub struct InstrumentationLibraryBuilder { /* private fields */ }

Configuration options for InstrumentationLibrary.

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

Apart from the name, all other fields are optional.

See the instrumentation libraries spec for more information.

Implementations

impl InstrumentationLibraryBuilder

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

Configure the version for the instrumentation library

Examples

let library = opentelemetry::InstrumentationLibrary::builder("my-crate")
    .with_version("v0.1.0")
    .build();

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

Configure the Schema URL for the instrumentation library

Examples

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

pub fn with_attributes<I>(self, attributes: I) -> Self

where I: IntoIterator<Item = KeyValue>,

Configure the attributes for the instrumentation library

Examples

use opentelemetry::KeyValue;

let library = opentelemetry::InstrumentationLibrary::builder("my-crate")
    .with_attributes(vec![KeyValue::new("k", "v")])
    .build();

pub fn build(self) -> InstrumentationLibrary

Create a new InstrumentationLibrary from this configuration

Trait Implementations

impl Debug for InstrumentationLibraryBuilder

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

Formats the value using the given formatter.