Add logging to int tests to help debug

Author: scottgerring

opentelemetry-otlp/tests/integration_test/Cargo.toml

@@ -15,6 +15,8 @@ testcontainers = "0.15.0"
 once_cell.workspace = true
 anyhow = "1.0.94"
 ctor = "0.2.9"
+tracing-subscriber = "0.3.19"
+tracing = "0.1.41"
 
 [target.'cfg(unix)'.dependencies]
 opentelemetry-appender-log = { path = "../../../opentelemetry-appender-log", default-features = false}
@@ -26,7 +28,8 @@ hyper-client = ["opentelemetry-otlp/hyper-client", "opentelemetry-otlp/http-prot
 reqwest-client = ["opentelemetry-otlp/reqwest-client", "opentelemetry-otlp/http-proto", "opentelemetry-otlp/trace","opentelemetry-otlp/logs", "opentelemetry-otlp/metrics"]
 reqwest-blocking-client = ["opentelemetry-otlp/reqwest-blocking-client", "opentelemetry-otlp/http-proto", "opentelemetry-otlp/trace","opentelemetry-otlp/logs", "opentelemetry-otlp/metrics"]
 tonic-client = ["opentelemetry-otlp/grpc-tonic", "opentelemetry-otlp/trace", "opentelemetry-otlp/logs", "opentelemetry-otlp/metrics"]
+internal-logs = []
 
 # Keep tonic as the default client
-default = ["tonic-client"]
+default = ["tonic-client", "internal-logs"]
 

opentelemetry-otlp/tests/integration_test/src/test_utils.rs

@@ -21,10 +21,12 @@
 use std::collections::HashMap;
 use std::fs::File;
 use std::os::unix::fs::PermissionsExt;
-use std::sync::{Arc, Mutex, OnceLock};
+use std::sync::{Arc, Mutex, Once, OnceLock};
 use testcontainers::clients::Cli;
 use testcontainers::core::{Port, WaitFor};
 use testcontainers::{Container, Image, RunnableImage};
+use tracing_subscriber::FmtSubscriber;
+use opentelemetry::{otel_debug, otel_info};
 
 // Static references for container management
 static COLLECTOR_ARC: OnceLock<Mutex<Option<Arc<Container<Collector>>>>> = OnceLock::new();
@@ -38,7 +40,23 @@ pub static METRICS_FILE: &str = "./actual/metrics.json";
 pub static LOGS_FILE: &str = "./actual/logs.json";
 pub static TRACES_FILE: &str = "./actual/traces.json";
 
+static INIT_TRACING: Once = Once::new();
+
+fn init_tracing() {
+    INIT_TRACING.call_once(|| {
+        let subscriber = FmtSubscriber::builder()
+            .with_max_level(tracing::Level::DEBUG)
+            .finish();
+
+        tracing::subscriber::set_global_default(subscriber)
+            .expect("Failed to set tracing subscriber");
+        otel_info!(name: "init_tracing");
+    });
+}
+
 pub async fn start_collector_container() {
+    init_tracing();
+
     let docker = DOCKER_CLIENT.get_or_init(init_docker_client);
     let mut arc_guard = COLLECTOR_ARC
         .get_or_init(|| Mutex::new(None))
@@ -54,17 +72,16 @@ pub async fn start_collector_container() {
 
         // Start a new container
         let image = Collector::default();
-        let mut runnable_image = RunnableImage::from(image);
-
-        // Map ports
-        for port in [4317, 4318] {
-            runnable_image = runnable_image.with_mapped_port(Port {
-                local: port,
-                internal: port,
-            });
-        }
+        let runnable_image =
+            RunnableImage::from(image)
+                .with_mapped_port(Port::from((4317, 4317)))
+                .with_mapped_port(Port::from((4318, 4318)));
 
-        let container = Arc::new(docker.run(runnable_image));
+        let container_instance = docker.run(runnable_image);
+        let container = Arc::new(container_instance);
+        otel_debug!(
+            name: "Container started",
+            ports = format!("{:?}", container.ports()));
 
         // Store the container in COLLECTOR_ARC
         *arc_guard = Some(Arc::clone(&container));
@@ -87,13 +104,13 @@ fn upsert_empty_file(path: &str) -> File {
 /// suite shutting down!
 ///
 pub fn stop_collector_container() {
-    println!("Trying to shutdown");
+    otel_debug!(name: "stop_collector_container");
     if let Some(container) = COLLECTOR_ARC
         .get()
         .and_then(|arc_lock| arc_lock.lock().unwrap().take())
     {
         container.stop();
-        println!("Collector container stopped.");
+        otel_debug!(name: "stop_collector_container::stopped");
     }
 }
 
@@ -119,13 +136,6 @@ impl Image for Collector {
     fn volumes(&self) -> Box<dyn Iterator<Item = (&String, &String)> + '_> {
         Box::new(self.volumes.iter())
     }
-
-    fn expose_ports(&self) -> Vec<u16> {
-        vec![
-            // 4317,  // gRPC port, defined in Dockerfile
-            // 4318,  // HTTP port, defined in Dockerfile
-        ]
-    }
 }
 
 impl Default for Collector {

scripts/integration_tests.sh

@@ -6,16 +6,16 @@ if [ -d "$TEST_DIR" ]; then
     cd "$TEST_DIR"
 
     # Run tests with the grpc-tonic feature
-    cargo test --no-default-features --features "tonic-client"
+    cargo test --no-default-features --features "tonic-client","internal-logs"
 
     # Run tests with the reqwest-client feature
-    cargo test --no-default-features --features "reqwest-client"
+    cargo test --no-default-features --features "reqwest-client","internal-logs"
 
     # TODO - Uncomment the following lines once the reqwest-blocking-client feature is working.
     # cargo test --no-default-features --features "reqwest-blocking-client"
 
     # Run tests with the hyper-client feature
-    cargo test --no-default-features --features "hyper-client"
+    cargo test --no-default-features --features "hyper-client","internal-logs"
 else
     echo "Directory $TEST_DIR does not exist. Skipping tests."
     exit 1