Struct OtelSdkBuilder 

pub struct OtelSdkBuilder { /* private fields */ }

Builder for configuring and initialising the OpenTelemetry SDK.

Example

use opentelemetry_configuration::{OtelSdkBuilder, SdkError};

let _guard = OtelSdkBuilder::new()
    .service_name("my-service")
    .build()?;

Implementations

impl OtelSdkBuilder

pub fn new() -> OtelSdkBuilder

Creates a new builder with default configuration.

pub fn from_figment(figment: Figment) -> OtelSdkBuilder

Creates a builder from an existing figment for complex configuration chains.

pub fn with_file<P>(self, path: P) -> OtelSdkBuilder

where P: AsRef<Path>,

Merges configuration from a TOML file. Missing files are silently skipped.

pub fn with_env(self, prefix: &str) -> OtelSdkBuilder

Merges configuration from environment variables with the given prefix.

Variables are split on underscores: PREFIX_FOO_BAR → foo.bar.

pub fn with_standard_env(self) -> OtelSdkBuilder

Merges standard OTEL_* environment variables per OpenTelemetry spec.

pub fn endpoint(self, url: impl Into<String>) -> OtelSdkBuilder

Sets the OTLP endpoint URL. For HTTP, signal paths are appended automatically.

pub fn protocol(self, protocol: Protocol) -> OtelSdkBuilder

Sets the export protocol.

This overrides any configuration from files or environment variables.

The default endpoint changes based on protocol:

• Protocol::Grpc → http://localhost:4317
• Protocol::HttpBinary → http://localhost:4318
• Protocol::HttpJson → http://localhost:4318

pub fn service_name(self, name: impl Into<String>) -> OtelSdkBuilder

Sets the service name resource attribute.

This is the most commonly configured resource attribute and identifies your service in the telemetry backend.

pub fn service_version(self, version: impl Into<String>) -> OtelSdkBuilder

Sets the service version resource attribute.

pub fn deployment_environment(self, env: impl Into<String>) -> OtelSdkBuilder

Sets the deployment environment resource attribute.

pub fn resource_attribute( self, key: impl Into<String>, value: impl Into<String>, ) -> OtelSdkBuilder

Adds a custom resource attribute.

Resource attributes describe the entity producing telemetry. Use this for application-specific metadata not covered by standard semantic conventions.

Example

use opentelemetry_configuration::OtelSdkBuilder;

let _guard = OtelSdkBuilder::new()
    .service_name("my-service")
    .resource_attribute("git.commit", "abc123")
    .resource_attribute("feature.flags", "new-ui,beta-api")
    .build()?;

pub fn with_resource(self, resource: Resource) -> OtelSdkBuilder

Provides a pre-built OpenTelemetry Resource.

This takes precedence over individual resource configuration. Use this when you need fine-grained control over resource construction.

pub fn resource<F>(self, f: F) -> OtelSdkBuilder

where F: FnOnce(ResourceConfigBuilder) -> ResourceConfigBuilder,

Configures the resource using a builder function.

Example

use opentelemetry_configuration::{OtelSdkBuilder, SdkError};

let _guard = OtelSdkBuilder::new()
    .resource(|r| r
        .service_name("my-lambda")
        .service_version(env!("CARGO_PKG_VERSION"))
        .deployment_environment("production"))
    .build()?;

pub fn traces(self, enabled: bool) -> OtelSdkBuilder

Enables or disables trace collection.

Default: enabled

pub fn metrics(self, enabled: bool) -> OtelSdkBuilder

Enables or disables metrics collection.

Default: enabled

pub fn logs(self, enabled: bool) -> OtelSdkBuilder

Enables or disables log collection.

Default: enabled

pub fn without_tracing_subscriber(self) -> OtelSdkBuilder

Disables automatic tracing subscriber initialisation.

By default, the SDK sets up a tracing-subscriber with tracing-opentelemetry and opentelemetry-appender-tracing integration. Disable this if you want to configure the subscriber yourself.

pub fn header( self, key: impl Into<String>, value: impl Into<String>, ) -> OtelSdkBuilder

Adds an HTTP header to all export requests.

Headers are applied to trace, metric, and log exporters. Common uses include authentication tokens and custom routing metadata.

Example

use opentelemetry_configuration::OtelSdkBuilder;

let api_token = std::env::var("API_TOKEN").unwrap_or_default();
let _guard = OtelSdkBuilder::new()
    .service_name("my-service")
    .header("Authorization", format!("Bearer {api_token}"))
    .build()?;

pub fn instrumentation_scope_name( self, name: impl Into<String>, ) -> OtelSdkBuilder

Sets the instrumentation scope name (otel.library.name).

If not set, defaults to the service name, then “opentelemetry-configuration”.

pub fn compute_environment(self, env: ComputeEnvironment) -> OtelSdkBuilder

Sets the compute environment for resource detection.

Controls which resource detectors are run automatically:

• Auto (default): Runs generic detectors and probes for Lambda/K8s
• Lambda: Runs generic detectors + Lambda-specific attributes
• Kubernetes: Runs generic detectors + K8s detector
• None: No automatic detection, only explicit configuration

pub fn with_rust_build_info(self, info: RustBuildInfo) -> OtelSdkBuilder

Adds Rust build-time information as resource attributes.

Use with the capture_rust_build_info! macro to add rustc version and channel information to telemetry.

Requires emit_rustc_env to be called in your build.rs.

Example

In build.rs:

opentelemetry_configuration::emit_rustc_env();

In main.rs:

use opentelemetry_configuration::{OtelSdkBuilder, capture_rust_build_info};

let _guard = OtelSdkBuilder::new()
    .service_name("my-service")
    .with_rust_build_info(capture_rust_build_info!())
    .build()?;

Attributes Added

• process.runtime.version - rustc version (e.g., “1.84.0”)
• process.runtime.description - full version string
• rust.channel - release channel (“stable”, “beta”, or “nightly”)

pub fn extract_config(&self) -> Result<OtelSdkConfig, SdkError>

Extracts the configuration for inspection or debugging.

Errors

Returns an error if configuration extraction fails or if the endpoint URL is invalid.

pub fn build(self) -> Result<OtelGuard, SdkError>

Builds and initialises the OpenTelemetry SDK.

Returns an OtelGuard that manages provider lifecycle. When the guard is dropped, all providers are flushed and shut down.

Errors

Returns an error if:

• Configuration extraction fails
• Provider initialisation fails
• Tracing subscriber initialisation fails

Example

use opentelemetry_configuration::{OtelSdkBuilder, SdkError};

fn main() -> Result<(), SdkError> {
    let _guard = OtelSdkBuilder::new()
        .with_env("OTEL_")
        .service_name("my-lambda")
        .build()?;

    tracing::info!("Application started");

    // Guard automatically shuts down providers on drop
    Ok(())
}

Trait Implementations

impl Default for OtelSdkBuilder

fn default() -> OtelSdkBuilder

Returns the “default value” for a type.