feat: Cleanup OTLP Exporter public API (#3384)

Co-authored-by: Scott Gerring <scottgerring@users.noreply.github.com>

Author: cijothomas

opentelemetry-otlp/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## vNext
 
+- **Breaking** Removed `ExportConfig`, `HasExportConfig`, and `with_export_config()` from public API.
+Use the `WithExportConfig` trait
+  methods (`.with_endpoint()`, `.with_protocol()`, `.with_timeout()`) instead, which remain public.
 - Add support for `OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE` environment variable
   to configure metrics temporality. Accepted values: `cumulative` (default), `delta`,
   `lowmemory` (case-insensitive). Programmatic `.with_temporality()` overrides the env var.

opentelemetry-otlp/src/exporter/http/mod.rs

@@ -2,7 +2,9 @@ use super::{
     default_headers, parse_header_string, resolve_timeout, ExporterBuildError,
     OTEL_EXPORTER_OTLP_HTTP_ENDPOINT_DEFAULT,
 };
-use crate::{ExportConfig, Protocol, OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_HEADERS};
+use crate::{
+    exporter::ExportConfig, Protocol, OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_HEADERS,
+};
 use http::{HeaderName, HeaderValue, Uri};
 use opentelemetry::otel_debug;
 use opentelemetry_http::{Bytes, HttpClient};
@@ -1042,7 +1044,7 @@ mod tests {
                 #[cfg(feature = "experimental-http-retry")]
                 retry_policy: None,
             },
-            exporter_config: crate::ExportConfig::default(),
+            exporter_config: crate::exporter::ExportConfig::default(),
         };
 
         // Act

opentelemetry-otlp/src/exporter/mod.rs

@@ -53,7 +53,7 @@ pub(crate) mod tonic;
 
 /// Configuration for the OTLP exporter.
 #[derive(Debug)]
-pub struct ExportConfig {
+pub(crate) struct ExportConfig {
     /// The address of the OTLP collector.
     /// Default address will be used based on the protocol.
     ///
@@ -228,7 +228,7 @@ fn default_headers() -> std::collections::HashMap<String, String> {
 }
 
 /// Provide access to the [ExportConfig] field within the exporter builders.
-pub trait HasExportConfig {
+pub(crate) trait HasExportConfig {
     /// Return a mutable reference to the [ExportConfig] within the exporter builders.
     fn export_config(&mut self) -> &mut ExportConfig;
 }
@@ -249,9 +249,7 @@ impl HasExportConfig for HttpExporterBuilder {
     }
 }
 
-/// Expose methods to override [ExportConfig].
-///
-/// This trait will be implemented for every struct that implemented [`HasExportConfig`] trait.
+/// Expose methods to set export configuration on exporter builders.
 ///
 /// ## Examples
 /// ```
@@ -280,10 +278,6 @@ pub trait WithExportConfig {
     ///
     /// Note: Programmatically setting this will override any value set via the environment variable.
     fn with_timeout(self, timeout: Duration) -> Self;
-    /// Set export config. This will override all previous configurations.
-    ///
-    /// Note: Programmatically setting this will override any value set via environment variables.
-    fn with_export_config(self, export_config: ExportConfig) -> Self;
 }
 
 impl<B: HasExportConfig> WithExportConfig for B {
@@ -301,13 +295,6 @@ impl<B: HasExportConfig> WithExportConfig for B {
         self.export_config().timeout = Some(timeout);
         self
     }
-
-    fn with_export_config(mut self, exporter_config: ExportConfig) -> Self {
-        self.export_config().endpoint = exporter_config.endpoint;
-        self.export_config().protocol = exporter_config.protocol;
-        self.export_config().timeout = exporter_config.timeout;
-        self
-    }
 }
 
 #[cfg(any(feature = "grpc-tonic", feature = "http-proto", feature = "http-json"))]
@@ -413,19 +400,12 @@ mod tests {
     #[cfg(any(feature = "http-proto", feature = "http-json"))]
     #[test]
     fn export_builder_error_invalid_http_endpoint() {
-        use std::time::Duration;
-
-        use crate::{ExportConfig, LogExporter, Protocol, WithExportConfig};
-
-        let ex_config = ExportConfig {
-            endpoint: Some("invalid_uri/something".to_string()),
-            protocol: Protocol::HttpBinary,
-            timeout: Some(Duration::from_secs(10)),
-        };
+        use crate::{LogExporter, WithExportConfig};
 
         let exporter_result = LogExporter::builder()
             .with_http()
-            .with_export_config(ex_config)
+            .with_endpoint("invalid_uri/something")
+            .with_timeout(std::time::Duration::from_secs(10))
             .build();
 
         assert!(
@@ -440,19 +420,12 @@ mod tests {
     #[cfg(feature = "grpc-tonic")]
     #[tokio::test]
     async fn export_builder_error_invalid_grpc_endpoint() {
-        use std::time::Duration;
-
-        use crate::{ExportConfig, LogExporter, Protocol, WithExportConfig};
-
-        let ex_config = ExportConfig {
-            endpoint: Some("invalid_uri/something".to_string()),
-            protocol: Protocol::Grpc,
-            timeout: Some(Duration::from_secs(10)),
-        };
+        use crate::{LogExporter, WithExportConfig};
 
         let exporter_result = LogExporter::builder()
             .with_tonic()
-            .with_export_config(ex_config)
+            .with_endpoint("invalid_uri/something")
+            .with_timeout(std::time::Duration::from_secs(10))
             .build();
 
         assert!(matches!(

opentelemetry-otlp/src/exporter/tonic/mod.rs

@@ -14,7 +14,7 @@ use tonic::transport::ClientTlsConfig;
 use super::{default_headers, parse_header_string, OTEL_EXPORTER_OTLP_GRPC_ENDPOINT_DEFAULT};
 use super::{resolve_timeout, ExporterBuildError};
 use crate::exporter::Compression;
-use crate::{ExportConfig, OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_HEADERS};
+use crate::{exporter::ExportConfig, OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_HEADERS};
 
 #[cfg(all(
     feature = "experimental-grpc-retry",
@@ -502,7 +502,7 @@ pub trait WithTonicConfig {
     /// this will override tls config and should only be used
     /// when working with non-HTTP transports.
     ///
-    /// Users MUST make sure the [`ExportConfig::timeout`] is
+    /// Users MUST make sure the timeout is
     /// the same as the channel's timeout.
     fn with_channel(self, channel: tonic::transport::Channel) -> Self;
 

opentelemetry-otlp/src/lib.rs

@@ -424,7 +424,6 @@ pub mod retry_classification;
 pub mod retry;
 
 pub use crate::exporter::Compression;
-pub use crate::exporter::ExportConfig;
 pub use crate::exporter::ExporterBuildError;
 #[cfg(feature = "trace")]
 #[cfg(any(feature = "http-proto", feature = "http-json", feature = "grpc-tonic"))]
@@ -457,7 +456,7 @@ pub use crate::exporter::http::{HasHttpConfig, WithHttpConfig};
 pub use crate::exporter::tonic::{HasTonicConfig, WithTonicConfig};
 
 pub use crate::exporter::{
-    HasExportConfig, WithExportConfig, OTEL_EXPORTER_OTLP_COMPRESSION, OTEL_EXPORTER_OTLP_ENDPOINT,
+    WithExportConfig, OTEL_EXPORTER_OTLP_COMPRESSION, OTEL_EXPORTER_OTLP_ENDPOINT,
     OTEL_EXPORTER_OTLP_ENDPOINT_DEFAULT, OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_PROTOCOL,
     OTEL_EXPORTER_OTLP_PROTOCOL_GRPC, OTEL_EXPORTER_OTLP_PROTOCOL_HTTP_JSON,
     OTEL_EXPORTER_OTLP_PROTOCOL_HTTP_PROTOBUF, OTEL_EXPORTER_OTLP_TIMEOUT,

opentelemetry-otlp/src/logs.rs

@@ -8,7 +8,7 @@ use opentelemetry_sdk::{error::OTelSdkResult, logs::LogBatch};
 use std::fmt::Debug;
 use std::time;
 
-use crate::{ExporterBuildError, HasExportConfig, NoExporterBuilderSet};
+use crate::{exporter::HasExportConfig, ExporterBuildError, NoExporterBuilderSet};
 
 #[cfg(feature = "grpc-tonic")]
 use crate::{HasTonicConfig, TonicExporterBuilder, TonicExporterBuilderSet};
@@ -83,14 +83,14 @@ impl LogExporterBuilder<HttpExporterBuilderSet> {
 
 #[cfg(feature = "grpc-tonic")]
 impl HasExportConfig for LogExporterBuilder<TonicExporterBuilderSet> {
-    fn export_config(&mut self) -> &mut crate::ExportConfig {
+    fn export_config(&mut self) -> &mut crate::exporter::ExportConfig {
         &mut self.client.0.exporter_config
     }
 }
 
 #[cfg(any(feature = "http-proto", feature = "http-json"))]
 impl HasExportConfig for LogExporterBuilder<HttpExporterBuilderSet> {
-    fn export_config(&mut self) -> &mut crate::ExportConfig {
+    fn export_config(&mut self) -> &mut crate::exporter::ExportConfig {
         &mut self.client.0.exporter_config
     }
 }

opentelemetry-otlp/src/metric.rs

@@ -4,7 +4,7 @@
 //!
 
 #[cfg(any(feature = "http-proto", feature = "http-json", feature = "grpc-tonic"))]
-use crate::HasExportConfig;
+use crate::exporter::HasExportConfig;
 
 #[cfg(any(feature = "http-proto", feature = "http-json"))]
 use crate::{exporter::http::HttpExporterBuilder, HasHttpConfig, HttpExporterBuilderSet};
@@ -127,14 +127,14 @@ impl MetricExporterBuilder<HttpExporterBuilderSet> {
 
 #[cfg(feature = "grpc-tonic")]
 impl HasExportConfig for MetricExporterBuilder<TonicExporterBuilderSet> {
-    fn export_config(&mut self) -> &mut crate::ExportConfig {
+    fn export_config(&mut self) -> &mut crate::exporter::ExportConfig {
         &mut self.client.0.exporter_config
     }
 }
 
 #[cfg(any(feature = "http-proto", feature = "http-json"))]
 impl HasExportConfig for MetricExporterBuilder<HttpExporterBuilderSet> {
-    fn export_config(&mut self) -> &mut crate::ExportConfig {
+    fn export_config(&mut self) -> &mut crate::exporter::ExportConfig {
         &mut self.client.0.exporter_config
     }
 }

opentelemetry-otlp/src/span.rs

@@ -86,14 +86,14 @@ impl SpanExporterBuilder<HttpExporterBuilderSet> {
 
 #[cfg(feature = "grpc-tonic")]
 impl HasExportConfig for SpanExporterBuilder<TonicExporterBuilderSet> {
-    fn export_config(&mut self) -> &mut crate::ExportConfig {
+    fn export_config(&mut self) -> &mut crate::exporter::ExportConfig {
         &mut self.client.0.exporter_config
     }
 }
 
 #[cfg(any(feature = "http-proto", feature = "http-json"))]
 impl HasExportConfig for SpanExporterBuilder<HttpExporterBuilderSet> {
-    fn export_config(&mut self) -> &mut crate::ExportConfig {
+    fn export_config(&mut self) -> &mut crate::exporter::ExportConfig {
         &mut self.client.0.exporter_config
     }
 }