chore(sampling): move sdk types from opentelemetry to opentelemetry_sdk (#3277)

Author: bantonsson

opentelemetry-sdk/CHANGELOG.md

@@ -5,8 +5,12 @@
 - Added `Resource::get_ref(&self, key: &Key) -> Option<&Value>` to allow retrieving a reference to a resource value without cloning.
 - **Breaking** Removed the following public hidden methods from the `SdkTracer` [#3227][3227]:
   - `id_generator`, `should_sample`
+- **Breaking** Moved the following SDK sampling types from `opentelemetry::trace` to `opentelemetry_sdk::trace` [#3277][3277]:
+  - `SamplingDecision`, `SamplingResult`
+  - These types are SDK implementation details and should be imported from `opentelemetry_sdk::trace` instead.
 
 [3227]: https://github.com/open-telemetry/opentelemetry-rust/pull/3227
+[3277]: https://github.com/open-telemetry/opentelemetry-rust/pull/3277
 
 ## 0.31.0
 

opentelemetry-sdk/src/trace/mod.rs

@@ -38,7 +38,7 @@ pub use in_memory_exporter::{InMemorySpanExporter, InMemorySpanExporterBuilder};
 pub use id_generator::{IdGenerator, RandomIdGenerator};
 pub use links::SpanLinks;
 pub use provider::{SdkTracerProvider, TracerProviderBuilder};
-pub use sampler::{Sampler, ShouldSample};
+pub use sampler::{Sampler, SamplingDecision, SamplingResult, ShouldSample};
 pub use span::Span;
 pub use span_limit::SpanLimits;
 pub use span_processor::{
@@ -60,13 +60,14 @@ mod runtime_tests;
 mod tests {
     use super::*;
     use crate::error::OTelSdkResult;
+    use crate::trace::{SamplingDecision, SamplingResult};
     use crate::{
         trace::span_limit::{DEFAULT_MAX_EVENT_PER_SPAN, DEFAULT_MAX_LINKS_PER_SPAN},
         trace::{InMemorySpanExporter, InMemorySpanExporterBuilder},
     };
     use opentelemetry::{
         baggage::BaggageExt,
-        trace::{SamplingDecision, SamplingResult, SpanKind, Status, TraceContextExt, TraceState},
+        trace::{SpanKind, Status, TraceContextExt, TraceState},
     };
     use opentelemetry::{testing::trace::TestSpan, InstrumentationScope};
     use opentelemetry::{

opentelemetry-sdk/src/trace/sampler.rs

@@ -1,13 +1,37 @@
 use opentelemetry::{
-    trace::{
-        Link, SamplingDecision, SamplingResult, SpanKind, TraceContextExt, TraceId, TraceState,
-    },
+    trace::{Link, SpanKind, TraceContextExt, TraceId, TraceState},
     Context, KeyValue,
 };
 
 #[cfg(feature = "jaeger_remote_sampler")]
 mod jaeger_remote;
 
+/// The result of sampling logic for a given span.
+#[derive(Clone, Debug, PartialEq)]
+pub struct SamplingResult {
+    /// The decision about whether or not to sample.
+    pub decision: SamplingDecision,
+
+    /// Extra attributes to be added to the span by the sampler
+    pub attributes: Vec<KeyValue>,
+
+    /// Trace state from parent context, may be modified by samplers.
+    pub trace_state: TraceState,
+}
+
+/// Decision about whether or not to sample
+#[derive(Clone, Debug, PartialEq, Eq)]
+pub enum SamplingDecision {
+    /// Span will not be recorded and all events and attributes will be dropped.
+    Drop,
+
+    /// Span data wil be recorded, but not exported.
+    RecordOnly,
+
+    /// Span data will be recorded and exported.
+    RecordAndSample,
+}
+
 #[cfg(feature = "jaeger_remote_sampler")]
 pub use jaeger_remote::{JaegerRemoteSampler, JaegerRemoteSamplerBuilder};
 #[cfg(feature = "jaeger_remote_sampler")]

opentelemetry-sdk/src/trace/sampler/jaeger_remote/sampler.rs

@@ -2,10 +2,10 @@ use crate::runtime::{to_interval_stream, RuntimeChannel};
 use crate::trace::error::TraceError;
 use crate::trace::sampler::jaeger_remote::remote::SamplingStrategyResponse;
 use crate::trace::sampler::jaeger_remote::sampling_strategy::Inner;
-use crate::trace::{Sampler, ShouldSample};
+use crate::trace::{Sampler, SamplingResult, ShouldSample};
 use futures_util::{stream, StreamExt as _};
 use http::Uri;
-use opentelemetry::trace::{Link, SamplingResult, SpanKind, TraceId};
+use opentelemetry::trace::{Link, SpanKind, TraceId};
 use opentelemetry::{otel_warn, Context, KeyValue};
 use opentelemetry_http::HttpClient;
 use std::str::FromStr;

opentelemetry-sdk/src/trace/sampler/jaeger_remote/sampling_strategy.rs

@@ -3,9 +3,8 @@ use crate::trace::sampler::jaeger_remote::remote::{
     SamplingStrategyResponse,
 };
 use crate::trace::sampler::sample_based_on_probability;
-use opentelemetry::trace::{
-    SamplingDecision, SamplingResult, TraceContextExt, TraceId, TraceState,
-};
+use crate::trace::{SamplingDecision, SamplingResult};
+use opentelemetry::trace::{TraceContextExt, TraceId, TraceState};
 use opentelemetry::{otel_warn, Context};
 use std::collections::HashMap;
 use std::fmt::{Debug, Formatter};

opentelemetry-sdk/src/trace/tracer.rs

@@ -10,13 +10,10 @@
 use crate::trace::{
     provider::SdkTracerProvider,
     span::{Span, SpanData},
-    SpanEvents, SpanLimits, SpanLinks,
+    SamplingDecision, SpanEvents, SpanLimits, SpanLinks,
 };
 use opentelemetry::{
-    trace::{
-        SamplingDecision, Span as _, SpanBuilder, SpanContext, SpanKind, Status, TraceContextExt,
-        TraceFlags,
-    },
+    trace::{Span as _, SpanBuilder, SpanContext, SpanKind, Status, TraceContextExt, TraceFlags},
     Context, InstrumentationScope, KeyValue,
 };
 use std::fmt;
@@ -270,12 +267,12 @@ impl opentelemetry::trace::Tracer for SdkTracer {
 mod tests {
     use crate::{
         testing::trace::TestSpan,
-        trace::{Sampler, ShouldSample},
+        trace::{Sampler, SamplingDecision, SamplingResult, ShouldSample},
     };
     use opentelemetry::{
         trace::{
-            Link, SamplingDecision, SamplingResult, Span, SpanContext, SpanId, SpanKind,
-            TraceContextExt, TraceFlags, TraceId, TraceState, Tracer, TracerProvider,
+            Link, Span, SpanContext, SpanId, SpanKind, TraceContextExt, TraceFlags, TraceId,
+            TraceState, Tracer, TracerProvider,
         },
         Context, KeyValue,
     };

opentelemetry/CHANGELOG.md

@@ -7,8 +7,12 @@
   - `trace_id`, `span_id`, `end_time`, `status`, `sampling_result`
   - `with_trace_id`, `with_span_id`, `with_end_time`, `with_status`, `with_sampling_result`
 - **Added** `#[must_use]` attribute to `opentelemetry::metrics::AsyncInstrumentBuilder` to add compile time warning when `.build()` is not called on observable instrument builders, preventing silent failures where callbacks are never registered and metrics are never reported.
+- **Breaking** Moved the following SDK sampling types from `opentelemetry::trace` to `opentelemetry_sdk::trace` [#3277][3277]:
+  - `SamplingDecision`, `SamplingResult`
+  - These types are SDK implementation details and should be imported from `opentelemetry_sdk::trace` instead.
 
 [3227]: https://github.com/open-telemetry/opentelemetry-rust/pull/3227
+[3277]: https://github.com/open-telemetry/opentelemetry-rust/pull/3277
 
 ## v0.31.0
 

opentelemetry/src/trace/mod.rs

@@ -181,7 +181,7 @@ pub use self::{
     },
     span::{Span, SpanKind, Status},
     span_context::{SpanContext, TraceState},
-    tracer::{SamplingDecision, SamplingResult, SpanBuilder, Tracer},
+    tracer::{SpanBuilder, Tracer},
     tracer_provider::TracerProvider,
 };
 use crate::KeyValue;

opentelemetry/src/trace/tracer.rs

@@ -1,5 +1,5 @@
 use crate::{
-    trace::{Event, Link, Span, SpanKind, TraceContextExt, TraceState},
+    trace::{Event, Link, Span, SpanKind, TraceContextExt},
     Context, KeyValue,
 };
 use std::borrow::Cow;
@@ -328,29 +328,3 @@ impl SpanBuilder {
         tracer.build_with_context(self, parent_cx)
     }
 }
-
-/// The result of sampling logic for a given span.
-#[derive(Clone, Debug, PartialEq)]
-pub struct SamplingResult {
-    /// The decision about whether or not to sample.
-    pub decision: SamplingDecision,
-
-    /// Extra attributes to be added to the span by the sampler
-    pub attributes: Vec<KeyValue>,
-
-    /// Trace state from parent context, may be modified by samplers.
-    pub trace_state: TraceState,
-}
-
-/// Decision about whether or not to sample
-#[derive(Clone, Debug, PartialEq, Eq)]
-pub enum SamplingDecision {
-    /// Span will not be recorded and all events and attributes will be dropped.
-    Drop,
-
-    /// Span data wil be recorded, but not exported.
-    RecordOnly,
-
-    /// Span data will be recorded and exported.
-    RecordAndSample,
-}