Merge pull request #1099 from jvanz/update-otel

chore(build): Update OTEL

Author: viccuad

Cargo.lock

@@ -28,16 +28,17 @@ lazy_static = "1.4.0"
 mime = "0.3"
 mockall_double = "0.3"
 num_cpus = "1.16.0"
-opentelemetry = { version = "0.27.0", default-features = false, features = [
+opentelemetry = { version = "0.28.0", default-features = false, features = [
   "metrics",
   "trace",
 ] }
-opentelemetry-otlp = { version = "0.27.0", features = [
+opentelemetry-otlp = { version = "0.28.0", features = [
   "metrics",
   "tls",
   "tonic",
+  "grpc-tonic"
 ] }
-opentelemetry_sdk = { version = "0.27.0", features = ["rt-tokio"] }
+opentelemetry_sdk = { version = "0.28.0", features = ["rt-tokio"] }
 policy-evaluator = { git = "https://github.com/kubewarden/policy-evaluator", tag = "v0.20.0" }
 pprof = { version = "0.14", features = ["prost-codec"] }
 rayon = "1.10"
@@ -66,7 +67,7 @@ tokio = { version = "^1.43.0", features = ["full"] }
 tonic = { version = "0.12.3" }
 tower-http = { version = "0.6.1", features = ["trace"] }
 tracing = "0.1"
-tracing-opentelemetry = "0.28.0"
+tracing-opentelemetry = "0.29.0"
 tracing-subscriber = { version = "0.3", features = ["ansi", "fmt", "json"] }
 
 [target.'cfg(target_os = "linux")'.dependencies]

Cargo.toml

@@ -7,7 +7,6 @@ use ::tracing::info;
 use anyhow::anyhow;
 use anyhow::Result;
 use clap::ArgMatches;
-use opentelemetry::global::shutdown_tracer_provider;
 use policy_server::metrics::setup_metrics;
 use policy_server::tracing::setup_tracing;
 use policy_server::PolicyServer;
@@ -27,7 +26,7 @@ async fn main() -> Result<()> {
 
     let config = policy_server::config::Config::from_args(&matches)?;
 
-    setup_tracing(&config.log_level, &config.log_fmt, config.log_no_color)?;
+    let tracer_provider = setup_tracing(&config.log_level, &config.log_fmt, config.log_no_color)?;
 
     if config.metrics_enabled {
         setup_metrics()?;
@@ -58,7 +57,9 @@ async fn main() -> Result<()> {
     let api_server = PolicyServer::new_from_config(config).await?;
     api_server.run().await?;
 
-    shutdown_tracer_provider();
+    if let Some(trace_provider) = tracer_provider {
+        trace_provider.shutdown()?;
+    }
 
     Ok(())
 }

src/main.rs

@@ -1,7 +1,6 @@
 use anyhow::Result;
 use opentelemetry::{global, KeyValue};
 use opentelemetry_otlp::{ExportConfig, WithExportConfig, WithTonicConfig};
-use opentelemetry_sdk::runtime;
 
 mod policy_evaluations_total;
 pub use policy_evaluations_total::add_policy_evaluation;
@@ -20,8 +19,7 @@ pub fn setup_metrics() -> Result<()> {
         .build()?;
 
     let periodic_reader =
-        opentelemetry_sdk::metrics::PeriodicReader::builder(metric_exporter, runtime::Tokio)
-            .build();
+        opentelemetry_sdk::metrics::PeriodicReader::builder(metric_exporter).build();
     let meter_provider = opentelemetry_sdk::metrics::SdkMeterProvider::builder()
         .with_reader(periodic_reader)
         .build();

src/metrics.rs

@@ -2,14 +2,22 @@ use anyhow::{anyhow, Result};
 use opentelemetry::trace::TracerProvider;
 use opentelemetry_otlp::WithTonicConfig;
 
+use opentelemetry_sdk::Resource;
 use tracing_subscriber::prelude::*;
 use tracing_subscriber::{fmt, EnvFilter};
 
 use crate::config::{self, build_client_tls_config_from_env};
 
 // Setup the tracing system. This MUST be done inside of a tokio Runtime
 // because some collectors rely on it and would panic otherwise.
-pub fn setup_tracing(log_level: &str, log_fmt: &str, log_no_color: bool) -> Result<()> {
+//
+// The function returns an optional tracer provider that must be used to
+// shut down the tracing system.
+pub fn setup_tracing(
+    log_level: &str,
+    log_fmt: &str,
+    log_no_color: bool,
+) -> Result<Option<opentelemetry_sdk::trace::SdkTracerProvider>> {
     // setup logging
     let filter_layer = EnvFilter::new(log_level)
         // some of our dependencies generate trace events too, but we don't care about them ->
@@ -23,18 +31,22 @@ pub fn setup_tracing(log_level: &str, log_fmt: &str, log_no_color: bool) -> Resu
         .add_directive("wasmtime_cranelift=off".parse().unwrap())
         .add_directive("wasmtime_jit=off".parse().unwrap());
 
-    match log_fmt {
-        "json" => tracing_subscriber::registry()
-            .with(filter_layer)
-            .with(fmt::layer().json())
-            .init(),
+    let tracer = match log_fmt {
+        "json" => {
+            tracing_subscriber::registry()
+                .with(filter_layer)
+                .with(fmt::layer().json())
+                .init();
+            None
+        }
         "text" => {
             let fmt_layer = fmt::layer().with_ansi(log_no_color);
 
             tracing_subscriber::registry()
                 .with(filter_layer)
                 .with(fmt_layer)
-                .init()
+                .init();
+            None
         }
         "otlp" => {
             // Create a new OpenTelemetry pipeline sending events to a
@@ -47,26 +59,30 @@ pub fn setup_tracing(log_level: &str, log_fmt: &str, log_no_color: bool) -> Resu
                 .with_tls_config(build_client_tls_config_from_env("OTLP")?)
                 .build()?;
 
-            let tracer_provider = opentelemetry_sdk::trace::TracerProvider::builder()
-                .with_resource(opentelemetry_sdk::Resource::new(vec![
-                    opentelemetry::KeyValue::new("service.name", config::SERVICE_NAME),
-                ]))
-                .with_batch_exporter(otlp_exporter, opentelemetry_sdk::runtime::Tokio)
+            let tracer_provider = opentelemetry_sdk::trace::SdkTracerProvider::builder()
+                .with_resource(
+                    Resource::builder()
+                        .with_service_name(config::SERVICE_NAME)
+                        .build(),
+                )
+                .with_batch_exporter(otlp_exporter)
                 .build();
 
             let tracer = tracer_provider.tracer(config::SERVICE_NAME);
 
             // Create a tracing layer with the configured tracer
             let telemetry = tracing_opentelemetry::layer().with_tracer(tracer);
+
             tracing_subscriber::registry()
                 .with(filter_layer)
                 .with(telemetry)
                 .with(fmt::layer())
-                .init()
+                .init();
+            Some(tracer_provider)
         }
 
         _ => return Err(anyhow!("Unknown log message format")),
     };
 
-    Ok(())
+    Ok(tracer)
 }

src/tracing.rs

@@ -5,6 +5,7 @@ receivers:
   otlp:
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
         tls:
           ca_file: "certs/server-ca.pem"
           cert_file: "certs/server-cert.pem"

tests/data/otel-collector-config.yaml

@@ -804,8 +804,6 @@ async fn test_detect_certificate_rotation() {
     }
 }
 
-// This test is flaky. We need to fix it. But for now, we are ignoring it.
-#[ignore]
 #[tokio::test]
 async fn test_otel() {
     setup();
@@ -856,7 +854,7 @@ async fn test_otel() {
         set_permissions(file_path, permissions.clone()).unwrap();
     }
 
-    let otelc = GenericImage::new("otel/opentelemetry-collector", "0.98.0")
+    let otelc = GenericImage::new("otel/opentelemetry-collector", "0.120.0")
         .with_wait_for(WaitFor::message_on_stderr("Everything is ready"))
         .with_mount(Mount::bind_mount(
             otelc_config_path.to_str().unwrap(),