owiwi-tracing-opentelemetry is a crate that provides an opinionated abstraction for initializing tracing subscriber with OpenTelemetry.

It allows sending telemetry to any of the collector define in the trace::collector module.

The owiwi-tracing-opentelemetry crate is on crates.io and can be used by adding owiwi-tracing-opentelemetry to your dependencies in your project's Cargo.toml. Or more simply, just run cargo add owiwi-tracing-opentelemetry.

Additionally, You must add the tracing crate to your dependencies.

The main type of this crate is originally design to work binary application that defines a command line interface, we need to enable the clap flag.

[dependencies]
clap = { version = "4.5.48", features = ["derive"] }
owiwi-tracing-opentelemetry = { version = "0.2", features = ["clap"] }
tracing = "0.1"

The following is a complete program that initializes a subscriber and emit some traces.

use clap::Parser;
use owiwi_tracing_opentelemetry::Owiwi;
use owiwi_tracing_opentelemetry::trace::TraceCollectorConfig;
use owiwi_tracing_opentelemetry::trace::collector::HoneycombConfig;

#[derive(Debug, Clone, Parser)]
struct Cli {
     #[command(flatten)]
     owiwi: Owiwi,
}

fn main() {
     let cli = Cli::parse();
     // Create a configuration to send traces to honeycomb.io
     let honeycomb_config = HoneycombConfig.builder()
         .endpoint("https://api.honeycomb.io/traces/api".parse().expect("to be valid URL"))
         .api_key("super_secret_key".into())
         .timeout(std::time::Duration::from_secs(5))
         .build();
     let collector_config = TraceCollectorConfig::Honeycomb(honeycomb_config);
     let _guard = cli.owiwi.try_init("example", collector_config);
     tracing::info!("the subscriber was initialized");
}

The following is a complete program that initializes a subscriber and emit some traces.

use owiwi_tracing_opentelemetry::Owiwi;
use owiwi_tracing_opentelemetry::trace::TraceCollectorConfig;
use owiwi_tracing_opentelemetry::format::EventFormat;

fn main() {
     // The default collector configuration sends traces to std::io::stdout
     let collector_config = TraceCollectorConfig::default();
     let service_name = "example";
     // Initializes the subscriber
     let _guard = Owiwi::default().try_init(service_name,  collector_config);
     tracing::info!("the Subscriber was initialized!");
}

There are some optional features that enable additional dependencies:

• serde adds Deserialize implementations for some types. It also allow deserializing humantime using humantime-serde
• clap: adds Args implementation to Owiwi and various other types.

owiwi-tracing-opentelemetry currently only supports the latest stable version.

This project is licensed under the MIT license.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in owiwi-tracing-opentelemetry by you, shall be licensed as MIT, without any additional terms or conditions.

This project was inspired by this blog post.