Skip to content

Commit 55eae75

Browse files
committed
feat: clean up trace SDK APIs and remove integration tests for jaeger
1 parent 91397fc commit 55eae75

File tree

12 files changed

+28
-34
lines changed

12 files changed

+28
-34
lines changed

opentelemetry-appender-tracing/src/layer.rs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,8 @@ mod tests {
212212
use opentelemetry::{logs::AnyValue, Key};
213213
use opentelemetry_sdk::logs::LoggerProvider;
214214
use opentelemetry_sdk::testing::logs::InMemoryLogsExporter;
215-
use opentelemetry_sdk::trace::{config, Sampler, TracerProvider};
215+
use opentelemetry_sdk::trace;
216+
use opentelemetry_sdk::trace::{Sampler, TracerProvider};
216217
use tracing::error;
217218
use tracing_subscriber::layer::SubscriberExt;
218219

@@ -300,7 +301,7 @@ mod tests {
300301

301302
// setup tracing as well.
302303
let tracer_provider = TracerProvider::builder()
303-
.with_config(config().with_sampler(Sampler::AlwaysOn))
304+
.with_config(trace::Config::default().with_sampler(Sampler::AlwaysOn))
304305
.build();
305306
let tracer = tracer_provider.tracer("test-tracer");
306307

@@ -464,7 +465,7 @@ mod tests {
464465

465466
// setup tracing as well.
466467
let tracer_provider = TracerProvider::builder()
467-
.with_config(config().with_sampler(Sampler::AlwaysOn))
468+
.with_config(trace::Config::default().with_sampler(Sampler::AlwaysOn))
468469
.build();
469470
let tracer = tracer_provider.tracer("test-tracer");
470471

opentelemetry-sdk/CHANGELOG.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@
2525
reference or owned`LogData`. If the exporter needs to process the log data
2626
asynchronously, it should clone the log data to ensure it can be safely processed without
2727
lifetime issues.
28+
- Clean up public methods in SDK.
29+
- [`TracerProvider::span_processors`] and [`TracerProvider::config`] was removed as it's not part of the spec.
30+
- Added `non_exhaustive` annotation to [`trace::Config`]. Marked [`config`] as deprecated since it's only a wrapper for `Config::default`
31+
- Removed [`Tracer::tracer_provder`] and [`Tracer::instrument_libraries`] as it's not part of the spec.
2832

2933
## v0.23.0
3034

@@ -57,13 +61,7 @@
5761
- After `shutdown`, `LogProcessor` will not process any new logs
5862
- Moving LogRecord implementation to the SDK. [1702](https://github.com/open-telemetry/opentelemetry-rust/pull/1702).
5963
- Relocated `LogRecord` struct to SDK, as an implementation for the trait in the API.
60-
- **Breaking** [#1729](https://github.com/open-telemetry/opentelemetry-rust/pull/1729)
61-
- Update the return type of `TracerProvider.span_processors()` from `&Vec<Box<dyn SpanProcessor>>` to `&[Box<dyn SpanProcessor>]`.
62-
- Update the return type of `LoggerProvider.log_processors()` from `&Vec<Box<dyn LogProcessor>>` to `&[Box<dyn LogProcessor>]`.
63-
- Update `opentelemetry` dependency version to 0.23
64-
- Update `opentelemetry-http` dependency version to 0.12
65-
- **Breaking** [#1750](https://github.com/open-telemetry/opentelemetry-rust/pull/1729)
66-
- Update the return type of `LoggerProvider.shutdown()` from `Vec<LogResult<()>>` to `LogResult<()>`.
64+
6765

6866
## v0.22.1
6967

opentelemetry-sdk/benches/context.rs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ use opentelemetry::{
1010
};
1111
use opentelemetry_sdk::{
1212
export::trace::{ExportResult, SpanData, SpanExporter},
13-
trace::{config, Sampler, TracerProvider},
13+
trace,
14+
trace::{Sampler, TracerProvider},
1415
};
1516
#[cfg(not(target_os = "windows"))]
1617
use pprof::criterion::{Output, PProfProfiler};
@@ -126,7 +127,9 @@ impl Display for Environment {
126127

127128
fn parent_sampled_tracer(inner_sampler: Sampler) -> (TracerProvider, BoxedTracer) {
128129
let provider = TracerProvider::builder()
129-
.with_config(config().with_sampler(Sampler::ParentBased(Box::new(inner_sampler))))
130+
.with_config(
131+
trace::Config::default().with_sampler(Sampler::ParentBased(Box::new(inner_sampler))),
132+
)
130133
.with_simple_exporter(NoopExporter)
131134
.build();
132135
let tracer = provider.tracer(module_path!());

opentelemetry-sdk/benches/log.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ use opentelemetry::trace::TracerProvider as _;
1717
use opentelemetry::Key;
1818
use opentelemetry_sdk::export::logs::{LogData, LogExporter};
1919
use opentelemetry_sdk::logs::{Logger, LoggerProvider};
20-
use opentelemetry_sdk::trace::{config, Sampler, TracerProvider};
20+
use opentelemetry_sdk::trace;
21+
use opentelemetry_sdk::trace::{Sampler, TracerProvider};
2122

2223
#[derive(Debug)]
2324
struct VoidExporter;
@@ -51,7 +52,7 @@ fn log_benchmark_group<F: Fn(&Logger)>(c: &mut Criterion, name: &str, f: F) {
5152

5253
// setup tracing as well.
5354
let tracer_provider = TracerProvider::builder()
54-
.with_config(config().with_sampler(Sampler::AlwaysOn))
55+
.with_config(trace::Config::default().with_sampler(Sampler::AlwaysOn))
5556
.build();
5657
let tracer = tracer_provider.tracer("bench-tracer");
5758

opentelemetry-sdk/benches/span_builder.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ fn span_builder_benchmark_group(c: &mut Criterion) {
5454

5555
fn not_sampled_provider() -> (sdktrace::TracerProvider, sdktrace::Tracer) {
5656
let provider = sdktrace::TracerProvider::builder()
57-
.with_config(sdktrace::config().with_sampler(sdktrace::Sampler::AlwaysOff))
57+
.with_config(sdktrace::Config::default().with_sampler(sdktrace::Sampler::AlwaysOff))
5858
.with_simple_exporter(NoopExporter)
5959
.build();
6060
let tracer = provider.tracer("not-sampled");

opentelemetry-sdk/benches/trace.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ fn trace_benchmark_group<F: Fn(&sdktrace::Tracer)>(c: &mut Criterion, name: &str
7070

7171
group.bench_function("always-sample", |b| {
7272
let provider = sdktrace::TracerProvider::builder()
73-
.with_config(sdktrace::config().with_sampler(sdktrace::Sampler::AlwaysOn))
73+
.with_config(sdktrace::Config::default().with_sampler(sdktrace::Sampler::AlwaysOn))
7474
.with_simple_exporter(VoidExporter)
7575
.build();
7676
let always_sample = provider.tracer("always-sample");
@@ -80,7 +80,7 @@ fn trace_benchmark_group<F: Fn(&sdktrace::Tracer)>(c: &mut Criterion, name: &str
8080

8181
group.bench_function("never-sample", |b| {
8282
let provider = sdktrace::TracerProvider::builder()
83-
.with_config(sdktrace::config().with_sampler(sdktrace::Sampler::AlwaysOff))
83+
.with_config(sdktrace::Config::default().with_sampler(sdktrace::Sampler::AlwaysOff))
8484
.with_simple_exporter(VoidExporter)
8585
.build();
8686
let never_sample = provider.tracer("never-sample");

opentelemetry-sdk/src/trace/config.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,14 @@ use std::env;
1010
use std::str::FromStr;
1111

1212
/// Default trace configuration
13+
#[deprecated(since = "0.23.0", note = "Use Config::default() instead")]
1314
pub fn config() -> Config {
1415
Config::default()
1516
}
1617

1718
/// Tracer configuration
1819
#[derive(Debug)]
20+
#[non_exhaustive]
1921
pub struct Config {
2022
/// The sampler that the sdk should use
2123
pub sampler: Box<dyn ShouldSample>,

opentelemetry-sdk/src/trace/provider.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ impl TracerProvider {
6767
}
6868

6969
/// Config associated with this tracer
70-
pub fn config(&self) -> &crate::trace::Config {
70+
pub(crate) fn config(&self) -> &crate::trace::Config {
7171
&self.inner.config
7272
}
7373

opentelemetry-sdk/src/trace/tracer.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,12 @@ impl Tracer {
5555
}
5656

5757
/// TracerProvider associated with this tracer.
58-
pub fn provider(&self) -> Option<TracerProvider> {
58+
pub(crate) fn provider(&self) -> Option<TracerProvider> {
5959
self.provider.upgrade().map(TracerProvider::new)
6060
}
6161

6262
/// Instrumentation library information of this tracer.
63-
pub fn instrumentation_library(&self) -> &InstrumentationLibrary {
63+
pub(crate) fn instrumentation_library(&self) -> &InstrumentationLibrary {
6464
&self.instrumentation_lib
6565
}
6666

opentelemetry-zipkin/src/exporter/mod.rs

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,7 @@ impl ZipkinPipelineBuilder {
106106
));
107107
cfg
108108
} else {
109-
Config {
110-
resource: Cow::Owned(Resource::empty()),
111-
..Default::default()
112-
}
109+
Config::default().with_resource(Resource::empty())
113110
};
114111
(config, Endpoint::new(service_name, self.service_addr))
115112
} else {
@@ -119,11 +116,7 @@ impl ZipkinPipelineBuilder {
119116
.unwrap()
120117
.to_string();
121118
(
122-
Config {
123-
// use a empty resource to prevent TracerProvider to assign a service name.
124-
resource: Cow::Owned(Resource::empty()),
125-
..Default::default()
126-
},
119+
Config::default().with_resource(Resource::empty()),
127120
Endpoint::new(service_name, self.service_addr),
128121
)
129122
}

scripts/integration_tests.sh

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1 @@
1-
#COMPOSE_FILE=./opentelemetry-jaeger/tests/docker-compose.yaml
2-
#docker-compose -f $COMPOSE_FILE down -v &&
3-
#docker-compose -f $COMPOSE_FILE up --build --abort-on-container-exit --exit-code-from opentelemetry-jaeger
4-
51
cargo test ./opentelemetry-otlp/tests/integration_test/tests -- --ignored

0 commit comments

Comments
 (0)