Struct InstrumentationScopeBuilder

pub struct InstrumentationScopeBuilder { /* private fields */ }

Configuration options for InstrumentationScope.

An instrumentation scope 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 InstrumentationScopeBuilder

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

Configure the version for the instrumentation scope

Examples

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

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

Configure the Schema URL for the instrumentation scope

Examples

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

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

where I: IntoIterator<Item = KeyValue>,

Configure the attributes for the instrumentation scope

Examples

use opentelemetry::KeyValue;

let scope = opentelemetry::InstrumentationScope::builder("my-crate")
    .with_attributes([KeyValue::new("k", "v")])
    .build();

pub fn build(self) -> InstrumentationScope

Create a new InstrumentationScope from this configuration

Trait Implementations

impl Debug for InstrumentationScopeBuilder

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

Formats the value using the given formatter.