💥 change the init_tracer to allow setup of resources (wip)

Author: davidB

README.md

@@ -18,15 +18,21 @@ For examples, you can look at:
 
 ```rust
 //...
+use axum_tracing_opentelemetry::opentelemetry_tracing_layer;
 use axum_tracing_opentelemetry::{
-  opentelemetry_tracing_layer,
-  // optional tools to init tracer (require features)
-  CollectorKind, init_tracer
+    // optional tools to init tracer (may require features)
+    init_tracer,
+    make_resource,
+    CollectorKind,
 };
 
 fn init_tracing() {
 
-    let otel_tracer = init_tracer(CollectorKind::Otlp).expect("setup of Tracer");
+    let otel_tracer = init_tracer(
+        CollectorKind::Otlp,
+        make_resource(env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION")),
+    )
+    .expect("setup of Tracer");
     let otel_layer = tracing_opentelemetry::layer().with_tracer(otel_tracer);
 
     let subscriber = tracing_subscriber::registry()

examples/oltp/src/main.rs

@@ -2,7 +2,13 @@ use axum::extract::{Path, Query};
 use axum::http::Method;
 use axum::Extension;
 use axum::{response::IntoResponse, routing::get, Router};
-use axum_tracing_opentelemetry::{init_tracer, opentelemetry_tracing_layer, CollectorKind};
+use axum_tracing_opentelemetry::opentelemetry_tracing_layer;
+use axum_tracing_opentelemetry::{
+    // optional tools to init tracer (may require features)
+    init_tracer,
+    make_resource,
+    CollectorKind,
+};
 use serde_json::json;
 use std::net::SocketAddr;
 
@@ -17,7 +23,11 @@ fn init_tracing() {
         std::env::var("RUST_LOG").unwrap_or("INFO".to_string()),
     );
 
-    let otel_tracer = init_tracer(CollectorKind::Otlp).expect("setup of Tracer");
+    let otel_tracer = init_tracer(
+        CollectorKind::Otlp,
+        make_resource(env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION")),
+    )
+    .expect("setup of Tracer");
     let otel_layer = tracing_opentelemetry::layer().with_tracer(otel_tracer);
 
     let fmt_layer = tracing_subscriber::fmt::layer()

src/tools.rs

@@ -1,7 +1,7 @@
+use opentelemetry::sdk::Resource;
 #[cfg(any(feature = "jaeger", feature = "otlp"))]
 use opentelemetry::{
-    global, sdk::propagation::TraceContextPropagator, sdk::trace as sdktrace, sdk::Resource,
-    trace::TraceError,
+    global, sdk::propagation::TraceContextPropagator, sdk::trace as sdktrace, trace::TraceError,
 };
 
 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
@@ -14,14 +14,10 @@ pub enum CollectorKind {
 }
 
 #[cfg(any(feature = "jaeger", feature = "otlp"))]
-pub fn init_tracer(kind: CollectorKind) -> Result<sdktrace::Tracer, TraceError> {
-    // use opentelemetry_otlp::WithExportConfig;
-    use opentelemetry_semantic_conventions as semcov;
-    let resource = Resource::new(vec![
-        semcov::resource::SERVICE_NAME.string(env!("CARGO_PKG_NAME")),
-        semcov::resource::SERVICE_VERSION.string(env!("CARGO_PKG_VERSION")),
-    ]);
-
+pub fn init_tracer(
+    kind: CollectorKind,
+    resource: Resource,
+) -> Result<sdktrace::Tracer, TraceError> {
     match kind {
         #[cfg(feature = "otlp")]
         CollectorKind::Otlp => {
@@ -41,18 +37,39 @@ pub fn init_tracer(kind: CollectorKind) -> Result<sdktrace::Tracer, TraceError>
     }
 }
 
+/// call with service name and version
+///
+/// ```rust
+/// make_resource(env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION"))
+/// ```
+pub fn make_resource<S>(service_name: S, service_version: S) -> Resource
+where
+    S: Into<String>,
+{
+    use opentelemetry_semantic_conventions as semcov;
+    Resource::new(vec![
+        semcov::resource::SERVICE_NAME.string(service_name.into()),
+        semcov::resource::SERVICE_VERSION.string(service_version.into()),
+    ])
+}
+
 #[cfg(feature = "otlp")]
 pub fn init_tracer_otlp(resource: Resource) -> Result<sdktrace::Tracer, TraceError> {
-    global::set_text_map_propagator(TraceContextPropagator::new());
-
-    // resource = resource.merge(&read_dt_metadata());
+    use opentelemetry_otlp::WithExportConfig;
 
+    global::set_text_map_propagator(TraceContextPropagator::new());
+    // FIXME choice the right/official env variable `OTEL_COLLECTOR_URL` or `OTEL_EXPORTER_OTLP_ENDPOINT`
+    // TODO try to autodetect if http or grpc should be used (eg based on env variable, port ???)
+    //endpoint (default = 0.0.0.0:4317 for grpc protocol, 0.0.0.0:4318 http protocol):
+    //.http().with_endpoint(collector_url),
+    let endpoint_grpc = std::env::var("OTEL_EXPORTER_OTLP_ENDPOINT")
+        .unwrap_or_else(|_| "http://0.0.0.0:4317".to_string());
+    let exporter = opentelemetry_otlp::new_exporter()
+        .tonic()
+        .with_endpoint(endpoint_grpc);
     opentelemetry_otlp::new_pipeline()
         .tracing()
-        //endpoint (default = 0.0.0.0:4317 for grpc protocol, 0.0.0.0:4318 http protocol):
-        .with_exporter(
-            opentelemetry_otlp::new_exporter().tonic(), //.http().with_endpoint(collector_url),
-        )
+        .with_exporter(exporter)
         .with_trace_config(
             sdktrace::config()
                 .with_resource(resource)
@@ -69,7 +86,6 @@ pub fn init_tracer_jaeger(resource: Resource) -> Result<sdktrace::Tracer, TraceE
     );
 
     opentelemetry_jaeger::new_pipeline()
-        .with_service_name(env!("CARGO_PKG_NAME"))
         .with_trace_config(
             sdktrace::config()
                 .with_resource(resource)