fix(jaeger): Move CommonConfig and HasRequiredConfig to private mod to meet MSRV requirement. Rename CommonConfig to TransformationConfig.

Author: TommyCpp

opentelemetry-jaeger/src/exporter/config/agent.rs

@@ -1,7 +1,8 @@
 use crate::exporter::agent::{AgentAsyncClientUdp, AgentSyncClientUdp};
 use crate::exporter::config::{
-    build_config_and_process, install_tracer_provider_and_get_tracer, CommonConfig,
-    HasRequiredConfig,
+    build_config_and_process,
+    common::{TransformationConfig, HasRequiredConfig},
+    install_tracer_provider_and_get_tracer,
 };
 use crate::exporter::uploader::{AsyncUploader, SyncUploader, Uploader};
 use crate::{Error, Exporter, JaegerTraceRuntime};
@@ -45,7 +46,7 @@ const DEFAULT_AGENT_ENDPOINT: &str = "127.0.0.1:6831";
 /// is not set, the exporter will use 127.0.0.1 as the host.
 #[derive(Debug)]
 pub struct AgentPipeline {
-    common_config: CommonConfig,
+    common_config: TransformationConfig,
     trace_config: Option<sdk::trace::Config>,
     agent_endpoint: Result<Vec<net::SocketAddr>, crate::Error>,
     max_packet_size: usize,
@@ -71,6 +72,20 @@ impl Default for AgentPipeline {
     }
 }
 
+// implement the seal trait
+impl HasRequiredConfig for AgentPipeline {
+    fn set_transformation_config<T>(&mut self, f: T)
+        where
+            T: FnOnce(&mut TransformationConfig),
+    {
+        f(self.common_config.borrow_mut())
+    }
+
+    fn set_trace_config(&mut self, config: Config) {
+        self.trace_config = Some(config)
+    }
+}
+
 /// Start a new pipeline to configure a exporter that target a jaeger agent.
 ///
 /// See details for each configurations at [`AgentPipeline`]
@@ -273,16 +288,3 @@ impl AgentPipeline {
         Ok(Box::new(SyncUploader::Agent(agent)))
     }
 }
-
-impl HasRequiredConfig for AgentPipeline {
-    fn set_common_config<T>(&mut self, f: T)
-    where
-        T: FnOnce(&mut CommonConfig),
-    {
-        f(self.common_config.borrow_mut())
-    }
-
-    fn set_trace_config(&mut self, config: Config) {
-        self.trace_config = Some(config)
-    }
-}

opentelemetry-jaeger/src/exporter/config/collector/mod.rs

@@ -1,6 +1,7 @@
 use crate::exporter::config::{
-    build_config_and_process, install_tracer_provider_and_get_tracer, CommonConfig,
-    HasRequiredConfig,
+    build_config_and_process,
+    common::{TransformationConfig, HasRequiredConfig},
+    install_tracer_provider_and_get_tracer,
 };
 use crate::exporter::uploader::{AsyncUploader, Uploader};
 use crate::{Exporter, JaegerTraceRuntime};
@@ -85,7 +86,7 @@ const ENV_PASSWORD: &str = "OTEL_EXPORTER_JAEGER_PASSWORD";
 /// [reqwest blocking client]: reqwest::blocking::Client
 #[derive(Debug)]
 pub struct CollectorPipeline {
-    common_config: CommonConfig,
+    common_config: TransformationConfig,
     trace_config: Option<TraceConfig>,
 
     #[cfg(feature = "collector_client")]
@@ -139,6 +140,20 @@ impl Default for CollectorPipeline {
     }
 }
 
+// implement the seal trait
+impl HasRequiredConfig for CollectorPipeline {
+    fn set_transformation_config<T>(&mut self, f: T)
+        where
+            T: FnOnce(&mut TransformationConfig),
+    {
+        f(self.common_config.borrow_mut())
+    }
+
+    fn set_trace_config(&mut self, config: TraceConfig) {
+        self.trace_config = Some(config)
+    }
+}
+
 #[derive(Debug)]
 enum ClientConfig {
     #[cfg(feature = "collector_client")]
@@ -401,19 +416,6 @@ impl CollectorPipeline {
     }
 }
 
-impl HasRequiredConfig for CollectorPipeline {
-    fn set_common_config<T>(&mut self, f: T)
-    where
-        T: FnOnce(&mut CommonConfig),
-    {
-        f(self.common_config.borrow_mut())
-    }
-
-    fn set_trace_config(&mut self, config: TraceConfig) {
-        self.trace_config = Some(config)
-    }
-}
-
 #[cfg(test)]
 #[cfg(feature = "rt-tokio")]
 mod tests {

opentelemetry-jaeger/src/exporter/config/mod.rs

@@ -23,27 +23,34 @@ pub mod agent;
 #[cfg(any(feature = "collector_client", feature = "wasm_collector_client"))]
 pub mod collector;
 
-#[derive(Debug)]
-struct CommonConfig {
-    export_instrument_library: bool,
-    service_name: Option<String>,
-}
+mod common {
+    use opentelemetry::sdk;
+
+
+    // configurations and overrides on how to transform OTLP spans to Jaeger spans.
+    #[derive(Debug)]
+    pub struct TransformationConfig {
+        pub export_instrument_library: bool,
+        pub service_name: Option<String>,
+    }
 
-impl Default for CommonConfig {
-    fn default() -> Self {
-        CommonConfig {
-            export_instrument_library: true,
-            service_name: None,
+    impl Default for TransformationConfig {
+        fn default() -> Self {
+            TransformationConfig {
+                export_instrument_library: true,
+                service_name: None,
+            }
         }
     }
-}
 
-trait HasRequiredConfig {
-    fn set_common_config<T>(&mut self, f: T)
-    where
-        T: FnOnce(&mut CommonConfig);
+    // pipeline must have transformation config and trace config.
+    pub trait HasRequiredConfig {
+        fn set_transformation_config<T>(&mut self, f: T)
+        where
+            T: FnOnce(&mut TransformationConfig);
 
-    fn set_trace_config(&mut self, config: sdk::trace::Config);
+        fn set_trace_config(&mut self, config: sdk::trace::Config);
+    }
 }
 
 /// Common configurations shared by the agent and the collector. You can use those functions
@@ -116,17 +123,17 @@ pub trait Configurable: Sized {
 
 impl<B> Configurable for B
 where
-    B: HasRequiredConfig,
+    B: common::HasRequiredConfig,
 {
     fn with_service_name<T: Into<String>>(mut self, service_name: T) -> Self {
-        self.set_common_config(|mut config| {
+        self.set_transformation_config(|mut config| {
             config.service_name = Some(service_name.into());
         });
         self
     }
 
     fn with_instrumentation_library_tags(mut self, export_instrument_library: bool) -> Self {
-        self.set_common_config(|mut config| {
+        self.set_transformation_config(|mut config| {
             config.export_instrument_library = export_instrument_library;
         });
         self