use opentelemetry_sdk::{
resource::{EnvResourceDetector, OsResourceDetector, ResourceDetector},
Resource,
};
use tracing::level_filters::LevelFilter;
#[cfg(debug_assertions)]
use tracing_subscriber::fmt::format::FmtSpan;
use tracing_subscriber::layer::SubscriberExt;
pub use opentelemetry::{Array, Context, Key, KeyValue, StringValue, Value};
pub use opentelemetry_sdk::trace::TracerProvider;
pub use opentelemetry_semantic_conventions::{resource, trace as semconv};
pub use tracing_opentelemetry::OpenTelemetrySpanExt;
pub mod middleware;
pub mod propagation;
pub mod http;
#[cfg(feature = "axum")]
pub use tracing_opentelemetry_instrumentation_sdk;
pub mod otlp;
#[cfg(feature = "test")]
pub mod test;
mod filter;
mod util;
#[derive(Debug, Default)]
pub struct DetectResource {
fallback_service_name: &'static str,
fallback_service_version: &'static str,
}
impl DetectResource {
pub fn new(
fallback_service_name: &'static str,
fallback_service_version: &'static str,
) -> Self {
DetectResource {
fallback_service_name,
fallback_service_version,
}
}
pub fn build(self) -> Resource {
let base = Resource::default();
let fallback = Resource::from_detectors(
std::time::Duration::from_secs(0),
vec![
Box::new(ServiceInfoDetector {
fallback_service_name: self.fallback_service_name,
fallback_service_version: self.fallback_service_version,
}),
Box::new(OsResourceDetector),
Box::new(EnvResourceDetector::new()),
],
);
let rsrc = base.merge(&fallback); rsrc.iter().for_each(
|kv| tracing::debug!(target: "otel::setup::resource", key = %kv.0, value = %kv.1),
);
rsrc
}
}
#[derive(Debug)]
pub struct ServiceInfoDetector {
fallback_service_name: &'static str,
fallback_service_version: &'static str,
}
impl ResourceDetector for ServiceInfoDetector {
fn detect(&self, _timeout: std::time::Duration) -> Resource {
let service_name = util::env_var("OTEL_SERVICE_NAME")
.or_else(|| util::env_var("SERVICE_NAME"))
.or_else(|| util::env_var("APP_NAME"))
.or_else(|| Some(self.fallback_service_name.to_string()))
.map(|v| KeyValue::new(resource::SERVICE_NAME, v));
let service_version = util::env_var("OTEL_SERVICE_VERSION")
.or_else(|| util::env_var("SERVICE_VERSION"))
.or_else(|| util::env_var("APP_VERSION"))
.or_else(|| Some(self.fallback_service_version.to_string()))
.map(|v| KeyValue::new(resource::SERVICE_VERSION, v));
Resource::new(vec![service_name, service_version].into_iter().flatten())
}
}
macro_rules! fmt_layer {
() => {{
let layer = tracing_subscriber::fmt::layer();
#[cfg(debug_assertions)]
let layer = layer.compact().with_span_events(FmtSpan::CLOSE);
#[cfg(not(debug_assertions))]
let layer = layer
.json()
.flatten_event(true)
.with_current_span(false)
.with_span_list(true);
layer.with_writer(std::io::stdout)
}};
}
pub fn init_tracing_with_fallbacks(
log_level: tracing::Level,
fallback_service_name: &'static str,
fallback_service_version: &'static str,
) -> TracerProvider {
let setup_subscriber = tracing_subscriber::registry()
.with(Into::<LevelFilter>::into(log_level))
.with(fmt_layer!());
let _guard = tracing::subscriber::set_default(setup_subscriber);
tracing::info!("init logging & tracing");
let otel_rsrc =
DetectResource::new(fallback_service_name, fallback_service_version).build();
let otel_tracer =
otlp::init_tracer(otel_rsrc, otlp::identity).expect("setup of Tracer");
let tracer_provider = otel_tracer.provider().unwrap();
opentelemetry::global::set_text_map_propagator(
propagation::TextMapSplitPropagator::from_env().expect("setup of Propagation"),
);
let otel_layer = tracing_opentelemetry::layer().with_tracer(otel_tracer);
let subscriber = tracing_subscriber::registry()
.with(Into::<filter::TracingFilter>::into(log_level))
.with(fmt_layer!())
.with(otel_layer);
tracing::subscriber::set_global_default(subscriber).unwrap();
tracer_provider
}
#[macro_export]
macro_rules! init_tracing {
($log_level:expr) => {
$crate::init_tracing_with_fallbacks(
$log_level,
env!("CARGO_PKG_NAME"),
env!("CARGO_PKG_VERSION"),
)
};
}
#[inline]
pub fn shutdown_signal() {
std::thread::spawn(opentelemetry::global::shutdown_tracer_provider)
.join()
.unwrap();
}