Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

trace: split tracer and versioned_tracer methods #682

Merged
merged 3 commits into from
Dec 24, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions opentelemetry-datadog/src/exporter/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,11 @@ impl DatadogPipelineBuilder {
sdk::trace::TracerProvider::builder().with_simple_exporter(exporter);
provider_builder = provider_builder.with_config(config);
let provider = provider_builder.build();
let tracer = provider.tracer("opentelemetry-datadog", Some(env!("CARGO_PKG_VERSION")));
let tracer = provider.versioned_tracer(
"opentelemetry-datadog",
Some(env!("CARGO_PKG_VERSION")),
None,
);
let _ = global::set_tracer_provider(provider);
Ok(tracer)
}
Expand All @@ -186,7 +190,11 @@ impl DatadogPipelineBuilder {
sdk::trace::TracerProvider::builder().with_batch_exporter(exporter, runtime);
provider_builder = provider_builder.with_config(config);
let provider = provider_builder.build();
let tracer = provider.tracer("opentelemetry-datadog", Some(env!("CARGO_PKG_VERSION")));
let tracer = provider.versioned_tracer(
"opentelemetry-datadog",
Some(env!("CARGO_PKG_VERSION")),
None,
);
let _ = global::set_tracer_provider(provider);
Ok(tracer)
}
Expand Down
14 changes: 10 additions & 4 deletions opentelemetry-jaeger/src/exporter/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -322,8 +322,11 @@ impl PipelineBuilder {
/// Install a Jaeger pipeline with a simple span processor.
pub fn install_simple(self) -> Result<sdk::trace::Tracer, TraceError> {
let tracer_provider = self.build_simple()?;
let tracer =
tracer_provider.tracer("opentelemetry-jaeger", Some(env!("CARGO_PKG_VERSION")));
let tracer = tracer_provider.versioned_tracer(
"opentelemetry-jaeger",
Some(env!("CARGO_PKG_VERSION")),
None,
);
let _ = global::set_tracer_provider(tracer_provider);
Ok(tracer)
}
Expand All @@ -334,8 +337,11 @@ impl PipelineBuilder {
runtime: R,
) -> Result<sdk::trace::Tracer, TraceError> {
let tracer_provider = self.build_batch(runtime)?;
let tracer =
tracer_provider.tracer("opentelemetry-jaeger", Some(env!("CARGO_PKG_VERSION")));
let tracer = tracer_provider.versioned_tracer(
"opentelemetry-jaeger",
Some(env!("CARGO_PKG_VERSION")),
None,
);
let _ = global::set_tracer_provider(tracer_provider);
Ok(tracer)
}
Expand Down
6 changes: 4 additions & 2 deletions opentelemetry-otlp/src/span.rs
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,8 @@ fn build_simple_with_exporter(
provider_builder = provider_builder.with_config(config);
}
let provider = provider_builder.build();
let tracer = provider.tracer("opentelemetry-otlp", Some(env!("CARGO_PKG_VERSION")));
let tracer =
provider.versioned_tracer("opentelemetry-otlp", Some(env!("CARGO_PKG_VERSION")), None);
let _ = global::set_tracer_provider(provider);
tracer
}
Expand All @@ -180,7 +181,8 @@ fn build_batch_with_exporter<R: TraceRuntime>(
provider_builder = provider_builder.with_config(config);
}
let provider = provider_builder.build();
let tracer = provider.tracer("opentelemetry-otlp", Some(env!("CARGO_PKG_VERSION")));
let tracer =
provider.versioned_tracer("opentelemetry-otlp", Some(env!("CARGO_PKG_VERSION")), None);
let _ = global::set_tracer_provider(provider);
tracer
}
Expand Down
12 changes: 10 additions & 2 deletions opentelemetry-zipkin/src/exporter/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,11 @@ impl ZipkinPipelineBuilder {
sdk::trace::TracerProvider::builder().with_simple_exporter(exporter);
provider_builder = provider_builder.with_config(config);
let provider = provider_builder.build();
let tracer = provider.tracer("opentelemetry-zipkin", Some(env!("CARGO_PKG_VERSION")));
let tracer = provider.versioned_tracer(
"opentelemetry-zipkin",
Some(env!("CARGO_PKG_VERSION")),
None,
);
let _ = global::set_tracer_provider(provider);
Ok(tracer)
}
Expand All @@ -173,7 +177,11 @@ impl ZipkinPipelineBuilder {
sdk::trace::TracerProvider::builder().with_batch_exporter(exporter, runtime);
provider_builder = provider_builder.with_config(config);
let provider = provider_builder.build();
let tracer = provider.tracer("opentelemetry-zipkin", Some(env!("CARGO_PKG_VERSION")));
let tracer = provider.versioned_tracer(
"opentelemetry-zipkin",
Some(env!("CARGO_PKG_VERSION")),
None,
);
let _ = global::set_tracer_provider(provider);
Ok(tracer)
}
Expand Down
4 changes: 2 additions & 2 deletions opentelemetry/benches/trace.rs
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ fn trace_benchmark_group<F: Fn(&sdktrace::Tracer)>(c: &mut Criterion, name: &str
.with_config(sdktrace::config().with_sampler(sdktrace::Sampler::AlwaysOn))
.with_simple_exporter(VoidExporter)
.build();
let always_sample = provider.tracer("always-sample", None);
let always_sample = provider.tracer("always-sample");

b.iter(|| f(&always_sample));
});
Expand All @@ -125,7 +125,7 @@ fn trace_benchmark_group<F: Fn(&sdktrace::Tracer)>(c: &mut Criterion, name: &str
.with_config(sdktrace::config().with_sampler(sdktrace::Sampler::AlwaysOff))
.with_simple_exporter(VoidExporter)
.build();
let never_sample = provider.tracer("never-sample", None);
let never_sample = provider.tracer("never-sample");
b.iter(|| f(&never_sample));
});

Expand Down
12 changes: 8 additions & 4 deletions opentelemetry/src/global/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,17 @@
//! ```
//! # #[cfg(feature="trace")]
//! # {
//! use opentelemetry::trace::Tracer;
//! use opentelemetry::trace::{Tracer, TracerProvider};
//! use opentelemetry::global;
//!
//! pub fn my_traced_library_function() {
//! // End users of your library will configure their global tracer provider
//! // so you can use the global tracer without any setup
//! let tracer = global::tracer_with_version("my-library-name", env!("CARGO_PKG_VERSION"));
//! let tracer = global::tracer_provider().versioned_tracer(
//! "my-library-name",
//! Some(env!("CARGO_PKG_VERSION")),
//! None,
//! );
//!
//! tracer.in_span("doing_library_work", |cx| {
//! // Traced library logic here...
Expand Down Expand Up @@ -156,6 +160,6 @@ pub use propagation::{get_text_map_propagator, set_text_map_propagator};
#[cfg_attr(docsrs, doc(cfg(feature = "trace")))]
pub use trace::{
force_flush_tracer_provider, set_tracer_provider, shutdown_tracer_provider, tracer,
tracer_provider, tracer_with_version, BoxedSpan, BoxedTracer, GlobalTracerProvider,
ObjectSafeTracer, ObjectSafeTracerProvider,
tracer_provider, BoxedSpan, BoxedTracer, GlobalTracerProvider, ObjectSafeTracer,
ObjectSafeTracerProvider,
};
44 changes: 21 additions & 23 deletions opentelemetry/src/global/trace.rs
Original file line number Diff line number Diff line change
Expand Up @@ -313,11 +313,13 @@ where
/// [`TracerProvider`]: crate::trace::TracerProvider
/// [`GlobalTracerProvider`]: crate::global::GlobalTracerProvider
pub trait ObjectSafeTracerProvider {
/// Creates a named tracer instance that is a trait object through the underlying `TracerProvider`.
fn tracer_boxed(
/// Creates a versioned named tracer instance that is a trait object through the underlying
/// `TracerProvider`.
fn versioned_tracer_boxed(
&self,
name: Cow<'static, str>,
version: Option<Cow<'static, str>>,
version: Option<&'static str>,
schema_url: Option<&'static str>,
) -> Box<dyn ObjectSafeTracer + Send + Sync>;

/// Force flush all remaining spans in span processors and return results.
Expand All @@ -330,13 +332,14 @@ where
T: trace::Tracer<Span = S> + Send + Sync + 'static,
P: trace::TracerProvider<Tracer = T>,
{
/// Return a boxed tracer
fn tracer_boxed(
/// Return a versioned boxed tracer
fn versioned_tracer_boxed(
&self,
name: Cow<'static, str>,
version: Option<Cow<'static, str>>,
version: Option<&'static str>,
schema_url: Option<&'static str>,
) -> Box<dyn ObjectSafeTracer + Send + Sync> {
Box::new(self.tracer(name, version))
Box::new(self.versioned_tracer(name, version, schema_url))
}

fn force_flush(&self) -> Vec<TraceResult<()>> {
Expand Down Expand Up @@ -377,11 +380,16 @@ impl GlobalTracerProvider {
impl trace::TracerProvider for GlobalTracerProvider {
type Tracer = BoxedTracer;

/// Find or create a named tracer using the global provider.
fn tracer<T: Into<Cow<'static, str>>>(&self, name: T, version: Option<T>) -> Self::Tracer {
/// Create a versioned tracer using the global provider.
fn versioned_tracer(
&self,
name: impl Into<Cow<'static, str>>,
version: Option<&'static str>,
schema_url: Option<&'static str>,
) -> Self::Tracer {
BoxedTracer(
self.provider
.tracer_boxed(name.into(), version.map(Into::<Cow<'static, str>>::into)),
.versioned_tracer_boxed(name.into(), version, schema_url),
)
}

Expand Down Expand Up @@ -412,21 +420,11 @@ pub fn tracer_provider() -> GlobalTracerProvider {
///
/// If the name is an empty string, the provider will use a default name.
///
/// This is a more convenient way of expressing `global::tracer_provider().tracer(name, None)`.
///
/// [`Tracer`]: crate::trace::Tracer
pub fn tracer<T: Into<Cow<'static, str>>>(name: T) -> BoxedTracer {
tracer_provider().tracer(name.into(), None)
}

/// Creates a named instance of [`Tracer`] with version info via the configured [`GlobalTracerProvider`]
///
/// If the name is an empty string, the provider will use a default name.
/// If the version is an empty string, it will be used as part of instrumentation library information.
/// This is a more convenient way of expressing `global::tracer_provider().tracer(name)`.
///
/// [`Tracer`]: crate::trace::Tracer
pub fn tracer_with_version<T: Into<Cow<'static, str>>>(name: T, version: T) -> BoxedTracer {
tracer_provider().tracer(name.into(), Some(version.into()))
pub fn tracer(name: impl Into<Cow<'static, str>>) -> BoxedTracer {
tracer_provider().tracer(name.into())
}

/// Sets the given [`TracerProvider`] instance as the current global provider.
Expand Down
4 changes: 3 additions & 1 deletion opentelemetry/src/sdk/export/trace/stdout.rs
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,9 @@ where
provider_builder = provider_builder.with_config(config);
}
let provider = provider_builder.build();
let tracer = provider.tracer("opentelemetry", Some(env!("CARGO_PKG_VERSION")));

let tracer =
provider.versioned_tracer("opentelemetry", Some(env!("CARGO_PKG_VERSION")), None);
let _ = global::set_tracer_provider(provider);

tracer
Expand Down
2 changes: 1 addition & 1 deletion opentelemetry/src/sdk/propagation/composite.rs
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ use std::collections::HashSet;
///
/// // And a given span
/// let example_span = sdktrace::TracerProvider::default()
/// .tracer("example-component", None)
/// .tracer("example-component")
/// .start("span-name");
///
/// // with the current context, call inject to add the headers
Expand Down
13 changes: 9 additions & 4 deletions opentelemetry/src/sdk/trace/provider.rs
Original file line number Diff line number Diff line change
Expand Up @@ -78,17 +78,22 @@ impl crate::trace::TracerProvider for TracerProvider {
/// This implementation of `TracerProvider` produces `Tracer` instances.
type Tracer = sdk::trace::Tracer;

/// Find or create `Tracer` instance by name.
fn tracer<T: Into<Cow<'static, str>>>(&self, name: T, version: Option<T>) -> Self::Tracer {
/// Create a new versioned `Tracer` instance.
fn versioned_tracer(
&self,
name: impl Into<Cow<'static, str>>,
version: Option<&'static str>,
_schema_url: Option<&'static str>,
) -> Self::Tracer {
let name = name.into();
let version = version.map(Into::<Cow<'static, str>>::into);
// Use default value if name is invalid empty string
let component_name = if name.is_empty() {
Cow::Borrowed(DEFAULT_COMPONENT_NAME)
} else {
name
};
let instrumentation_lib = sdk::InstrumentationLibrary::new(component_name, version);
let instrumentation_lib =
sdk::InstrumentationLibrary::new(component_name, version.map(Into::into));

sdk::trace::Tracer::new(instrumentation_lib, Arc::downgrade(&self.inner))
}
Expand Down
8 changes: 4 additions & 4 deletions opentelemetry/src/sdk/trace/span.rs
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ mod tests {
fn init() -> (sdk::trace::Tracer, SpanData) {
let provider = sdk::trace::TracerProvider::default();
let config = provider.config();
let tracer = provider.tracer("opentelemetry", Some(env!("CARGO_PKG_VERSION")));
let tracer = provider.tracer("opentelemetry");
let data = SpanData {
parent_span_id: SpanId::from_u64(0),
span_kind: trace::SpanKind::Internal,
Expand Down Expand Up @@ -529,7 +529,7 @@ mod tests {
let exporter = NoopSpanExporter::new();
let provider_builder = sdk::trace::TracerProvider::builder().with_simple_exporter(exporter);
let provider = provider_builder.build();
let tracer = provider.tracer("opentelemetry-test", None);
let tracer = provider.tracer("opentelemetry-test");

let mut event1 = Event::with_name("test event");
for i in 0..(DEFAULT_MAX_ATTRIBUTES_PER_EVENT * 2) {
Expand Down Expand Up @@ -563,7 +563,7 @@ mod tests {
let exporter = NoopSpanExporter::new();
let provider_builder = sdk::trace::TracerProvider::builder().with_simple_exporter(exporter);
let provider = provider_builder.build();
let tracer = provider.tracer("opentelemetry-test", None);
let tracer = provider.tracer("opentelemetry-test");

let mut link = Link::new(
SpanContext::new(
Expand Down Expand Up @@ -597,7 +597,7 @@ mod tests {
let provider = sdk::trace::TracerProvider::builder()
.with_simple_exporter(NoopSpanExporter::new())
.build();
let tracer = provider.tracer("test", None);
let tracer = provider.tracer("test");

let mut span = tracer.start("test_span");
span.add_event("test_event".to_string(), vec![]);
Expand Down
6 changes: 3 additions & 3 deletions opentelemetry/src/sdk/trace/tracer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ mod tests {
let tracer_provider = sdk::trace::TracerProvider::builder()
.with_config(config)
.build();
let tracer = tracer_provider.tracer("test", None);
let tracer = tracer_provider.tracer("test");
let trace_state = TraceState::from_key_value(vec![("foo", "bar")]).unwrap();
let span_builder = SpanBuilder {
parent_context: Context::new().with_span(TestSpan(SpanContext::new(
Expand Down Expand Up @@ -392,7 +392,7 @@ mod tests {
.build();

let context = Context::current_with_span(TestSpan(SpanContext::empty_context()));
let tracer = tracer_provider.tracer("test", None);
let tracer = tracer_provider.tracer("test");
let span = tracer.start_with_context("must_not_be_sampled", context);

assert!(!span.span_context().is_sampled());
Expand All @@ -405,7 +405,7 @@ mod tests {
let tracer_provider = sdk::trace::TracerProvider::builder()
.with_config(config)
.build();
let tracer = tracer_provider.tracer("test", None);
let tracer = tracer_provider.tracer("test");

let _attached = Context::current_with_span(TestSpan(SpanContext::empty_context())).attach();
let span = tracer.span_builder("must_not_be_sampled").start(&tracer);
Expand Down
2 changes: 1 addition & 1 deletion opentelemetry/src/trace/context.rs
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ pub trait TraceContextExt {
/// assert_eq!(Context::current().span().span_context(), &SpanContext::empty_context());
///
/// let provider = sdk::trace::TracerProvider::default();
/// provider.tracer("my-component", None).in_span("my-span", |cx| {
/// provider.tracer("my-component").in_span("my-span", |cx| {
/// // Returns a reference to the current span if set
/// assert_ne!(cx.span().span_context(), &SpanContext::empty_context());
/// });
Expand Down
6 changes: 5 additions & 1 deletion opentelemetry/src/trace/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@
//! let tracer_provider = global::tracer_provider();
//!
//! // Get a tracer for this library
//! let tracer = tracer_provider.tracer("my_name", Some(env!("CARGO_PKG_VERSION")));
//! let tracer = tracer_provider.versioned_tracer(
//! "my_name",
//! Some(env!("CARGO_PKG_VERSION")),
//! None
//! );
//!
//! // Create spans
//! let mut span = tracer.start("doing_work");
Expand Down
7 changes: 6 additions & 1 deletion opentelemetry/src/trace/noop.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,12 @@ impl trace::TracerProvider for NoopTracerProvider {
type Tracer = NoopTracer;

/// Returns a new `NoopTracer` instance.
fn tracer<T: Into<Cow<'static, str>>>(&self, _name: T, _version: Option<T>) -> Self::Tracer {
fn versioned_tracer(
&self,
_name: impl Into<Cow<'static, str>>,
_version: Option<&'static str>,
_schema_url: Option<&'static str>,
) -> Self::Tracer {
NoopTracer::new()
}

Expand Down
Loading