Merge branch 'main' into utpilla/Fix-typos

Author: cijothomas

.github/workflows/ci.yml

@@ -110,10 +110,8 @@ jobs:
     - uses: dtolnay/rust-toolchain@1.65.0
     - name: Patch dependencies versions # some dependencies bump MSRV without major version bump
       run: bash ./scripts/patch_dependencies.sh
-    - name: Run tests
-      run: cargo --version &&
-        cargo test --manifest-path=opentelemetry/Cargo.toml --features trace,metrics,testing &&
-        cargo test --manifest-path=opentelemetry-zipkin/Cargo.toml
+    - name: Check MSRV for all crates
+      run: bash ./scripts/msrv.sh
   cargo-deny:
     runs-on: ubuntu-latest # This uses the step `EmbarkStudios/cargo-deny-action@v1` which is only supported on Linux
     continue-on-error: true # Prevent sudden announcement of a new advisory from failing ci

CONTRIBUTING.md

@@ -37,6 +37,11 @@ You can provide the protocol compiler protoc path programmatically (only works w
 export PROTOC=$(which protoc)
 ```
 
+It is recommended to use "3.15" or newer of protoc, as some of the proto
+definitions include "optional" fields, that are not supported in older versions,
+resulting in errors as shown
+[here](https://github.com/open-telemetry/opentelemetry-proto/issues/451).
+
 Prerequisites to build the protocol compiler protoc from source
 
 - [protoc](https://github.com/protocolbuffers/protobuf)

examples/tracing-jaeger/src/main.rs

@@ -10,7 +10,7 @@ use opentelemetry_semantic_conventions::resource::SERVICE_NAME;
 
 use std::error::Error;
 
-fn init_tracer() -> Result<opentelemetry_sdk::trace::Tracer, TraceError> {
+fn init_tracer_provider() -> Result<opentelemetry_sdk::trace::TracerProvider, TraceError> {
     opentelemetry_otlp::new_pipeline()
         .tracing()
         .with_exporter(
@@ -29,7 +29,8 @@ fn init_tracer() -> Result<opentelemetry_sdk::trace::Tracer, TraceError> {
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
-    let _tracer = init_tracer().expect("Failed to initialize tracer.");
+    let tracer_provider = init_tracer_provider().expect("Failed to initialize tracer provider.");
+    global::set_tracer_provider(tracer_provider.clone());
 
     let tracer = global::tracer("tracing-jaeger");
     tracer.in_span("main-operation", |cx| {

opentelemetry-otlp/CHANGELOG.md

@@ -12,6 +12,8 @@ Instead of using
 `.with_config(Config::default().with_resource(RESOURCE::default()))` users must
 now use `.with_resource(RESOURCE::default())` to configure Resource when using
 `OtlpLogPipeline`.
+- **Breaking** The methods `OtlpTracePipeline::install_simple()` and `OtlpTracePipeline::install_batch()` would now return `TracerProvider` instead of `Tracer`.
+  These methods would also no longer set the global tracer provider. It would now be the responsibility of users to set it by calling `global::set_tracer_provider(tracer_provider.clone());`. Refer to the [basic-otlp](https://github.com/open-telemetry/opentelemetry-rust/blob/main/opentelemetry-otlp/examples/basic-otlp/src/main.rs) and [basic-otlp-http](https://github.com/open-telemetry/opentelemetry-rust/blob/main/opentelemetry-otlp/examples/basic-otlp-http/src/main.rs) examples on how to initialize OTLP Trace Exporter.
 
 ## v0.16.0
 

opentelemetry-otlp/examples/basic-otlp-http/src/main.rs

@@ -37,7 +37,7 @@ fn init_logs() -> Result<sdklogs::LoggerProvider, opentelemetry::logs::LogError>
         .install_batch(opentelemetry_sdk::runtime::Tokio)
 }
 
-fn init_tracer() -> Result<sdktrace::Tracer, TraceError> {
+fn init_tracer_provider() -> Result<sdktrace::TracerProvider, TraceError> {
     opentelemetry_otlp::new_pipeline()
         .tracing()
         .with_exporter(
@@ -67,13 +67,16 @@ fn init_metrics() -> Result<opentelemetry_sdk::metrics::SdkMeterProvider, Metric
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
-    let result = init_tracer();
+    let result = init_tracer_provider();
     assert!(
         result.is_ok(),
         "Init tracer failed with error: {:?}",
         result.err()
     );
 
+    let tracer_provider = result.unwrap();
+    global::set_tracer_provider(tracer_provider.clone());
+
     let result = init_metrics();
     assert!(
         result.is_ok(),

opentelemetry-otlp/examples/basic-otlp/src/main.rs

@@ -22,7 +22,7 @@ static RESOURCE: Lazy<Resource> = Lazy::new(|| {
     )])
 });
 
-fn init_tracer() -> Result<sdktrace::Tracer, TraceError> {
+fn init_tracer_provider() -> Result<sdktrace::TracerProvider, TraceError> {
     opentelemetry_otlp::new_pipeline()
         .tracing()
         .with_exporter(
@@ -72,12 +72,14 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
     // matches the containing block, reporting traces and metrics during the whole
     // execution.
 
-    let result = init_tracer();
+    let result = init_tracer_provider();
     assert!(
         result.is_ok(),
         "Init tracer failed with error: {:?}",
         result.err()
     );
+    let tracer_provider = result.unwrap();
+    global::set_tracer_provider(tracer_provider.clone());
 
     let result = init_metrics();
     assert!(

opentelemetry-otlp/src/lib.rs

@@ -120,7 +120,7 @@
 //! on the choice of exporters.
 //!
 //! ```no_run
-//! use opentelemetry::{KeyValue, trace::Tracer};
+//! use opentelemetry::{global, KeyValue, trace::Tracer};
 //! use opentelemetry_sdk::{trace::{self, RandomIdGenerator, Sampler}, Resource};
 //! # #[cfg(feature = "metrics")]
 //! use opentelemetry_sdk::metrics::reader::{DefaultAggregationSelector, DefaultTemporalitySelector};
@@ -138,7 +138,7 @@
 //!     map.insert("x-number", "123".parse().unwrap());
 //!     map.insert_bin("trace-proto-bin", MetadataValue::from_bytes(b"[binary data]"));
 //!
-//!     let tracer = opentelemetry_otlp::new_pipeline()
+//!     let tracer_provider = opentelemetry_otlp::new_pipeline()
 //!         .tracing()
 //!         .with_exporter(
 //!             opentelemetry_otlp::new_exporter()
@@ -157,6 +157,8 @@
 //!                 .with_resource(Resource::new(vec![KeyValue::new("service.name", "example")])),
 //!         )
 //!         .install_batch(opentelemetry_sdk::runtime::Tokio)?;
+//!         global::set_tracer_provider(tracer_provider);
+//!         let tracer = global::tracer("tracer-name");
 //!         # tracer
 //!     # };
 //!

opentelemetry-otlp/src/logs.rs

@@ -151,9 +151,9 @@ impl OtlpLogPipeline<NoExporterConfig> {
 impl OtlpLogPipeline<LogExporterBuilder> {
     /// Install the configured log exporter.
     ///
-    /// Returns a [`Logger`] with the name `opentelemetry-otlp` and the current crate version.
+    /// Returns a [`LoggerProvider`].
     ///
-    /// [`Logger`]: opentelemetry_sdk::logs::Logger
+    /// [`LoggerProvider`]: opentelemetry_sdk::logs::LoggerProvider
     pub fn install_simple(self) -> Result<opentelemetry_sdk::logs::LoggerProvider, LogError> {
         Ok(build_simple_with_exporter(
             self.exporter_builder.build_log_exporter()?,
@@ -164,9 +164,9 @@ impl OtlpLogPipeline<LogExporterBuilder> {
     /// Install the configured log exporter and a batch log processor using the
     /// specified runtime.
     ///
-    /// Returns a [`Logger`] with the name `opentelemetry-otlp` and the current crate version.
+    /// Returns a [`LoggerProvider`].
     ///
-    /// [`Logger`]: opentelemetry_sdk::logs::Logger
+    /// [`LoggerProvider`]: opentelemetry_sdk::logs::LoggerProvider
     pub fn install_batch<R: RuntimeChannel>(
         self,
         runtime: R,

opentelemetry-otlp/src/span.rs

@@ -5,10 +5,7 @@
 use std::fmt::Debug;
 
 use futures_core::future::BoxFuture;
-use opentelemetry::{
-    global,
-    trace::{TraceError, TracerProvider},
-};
+use opentelemetry::trace::TraceError;
 use opentelemetry_sdk::{
     self as sdk,
     export::trace::{ExportResult, SpanData},
@@ -99,10 +96,10 @@ impl OtlpTracePipeline<NoExporterConfig> {
 impl OtlpTracePipeline<SpanExporterBuilder> {
     /// Install the configured span exporter.
     ///
-    /// Returns a [`Tracer`] with the name `opentelemetry-otlp` and current crate version.
+    /// Returns a [`TracerProvider`].
     ///
-    /// [`Tracer`]: opentelemetry::trace::Tracer
-    pub fn install_simple(self) -> Result<sdk::trace::Tracer, TraceError> {
+    /// [`TracerProvider`]: opentelemetry::trace::TracerProvider
+    pub fn install_simple(self) -> Result<sdk::trace::TracerProvider, TraceError> {
         Ok(build_simple_with_exporter(
             self.exporter_builder.build_span_exporter()?,
             self.trace_config,
@@ -112,15 +109,15 @@ impl OtlpTracePipeline<SpanExporterBuilder> {
     /// Install the configured span exporter and a batch span processor using the
     /// specified runtime.
     ///
-    /// Returns a [`Tracer`] with the name `opentelemetry-otlp` and current crate version.
+    /// Returns a [`TracerProvider`].
     ///
     /// `install_batch` will panic if not called within a tokio runtime
     ///
-    /// [`Tracer`]: opentelemetry::trace::Tracer
+    /// [`TracerProvider`]: opentelemetry::trace::TracerProvider
     pub fn install_batch<R: RuntimeChannel>(
         self,
         runtime: R,
-    ) -> Result<sdk::trace::Tracer, TraceError> {
+    ) -> Result<sdk::trace::TracerProvider, TraceError> {
         Ok(build_batch_with_exporter(
             self.exporter_builder.build_span_exporter()?,
             self.trace_config,
@@ -133,26 +130,21 @@ impl OtlpTracePipeline<SpanExporterBuilder> {
 fn build_simple_with_exporter(
     exporter: SpanExporter,
     trace_config: Option<sdk::trace::Config>,
-) -> sdk::trace::Tracer {
+) -> sdk::trace::TracerProvider {
     let mut provider_builder = sdk::trace::TracerProvider::builder().with_simple_exporter(exporter);
     if let Some(config) = trace_config {
         provider_builder = provider_builder.with_config(config);
     }
-    let provider = provider_builder.build();
-    let tracer = provider
-        .tracer_builder("opentelemetry-otlp")
-        .with_version(env!("CARGO_PKG_VERSION"))
-        .build();
-    let _ = global::set_tracer_provider(provider);
-    tracer
+
+    provider_builder.build()
 }
 
 fn build_batch_with_exporter<R: RuntimeChannel>(
     exporter: SpanExporter,
     trace_config: Option<sdk::trace::Config>,
     runtime: R,
     batch_config: Option<sdk::trace::BatchConfig>,
-) -> sdk::trace::Tracer {
+) -> sdk::trace::TracerProvider {
     let mut provider_builder = sdk::trace::TracerProvider::builder();
     let batch_processor = sdk::trace::BatchSpanProcessor::builder(exporter, runtime)
         .with_batch_config(batch_config.unwrap_or_default())
@@ -162,13 +154,7 @@ fn build_batch_with_exporter<R: RuntimeChannel>(
     if let Some(config) = trace_config {
         provider_builder = provider_builder.with_config(config);
     }
-    let provider = provider_builder.build();
-    let tracer = provider
-        .tracer_builder("opentelemetry-otlp")
-        .with_version(env!("CARGO_PKG_VERSION"))
-        .build();
-    let _ = global::set_tracer_provider(provider);
-    tracer
+    provider_builder.build()
 }
 
 /// OTLP span exporter builder.

opentelemetry-otlp/tests/integration_test/tests/traces.rs

@@ -13,7 +13,7 @@ use std::error::Error;
 use std::fs::File;
 use std::os::unix::fs::MetadataExt;
 
-fn init_tracer() -> Result<sdktrace::Tracer, TraceError> {
+fn init_tracer_provider() -> Result<sdktrace::TracerProvider, TraceError> {
     opentelemetry_otlp::new_pipeline()
         .tracing()
         .with_exporter(opentelemetry_otlp::new_exporter().tonic())
@@ -30,10 +30,8 @@ const LEMONS_KEY: Key = Key::from_static_str("lemons");
 const ANOTHER_KEY: Key = Key::from_static_str("ex.com/another");
 
 pub async fn traces() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
-    // By binding the result to an unused variable, the lifetime of the variable
-    // matches the containing block, reporting traces and metrics during the whole
-    // execution.
-    let _ = init_tracer()?;
+    let tracer_provider = init_tracer_provider().expect("Failed to initialize tracer provider.");
+    global::set_tracer_provider(tracer_provider.clone());
 
     let tracer = global::tracer("ex.com/basic");
 

opentelemetry-otlp/tests/smoke.rs

@@ -1,4 +1,5 @@
 use futures_util::StreamExt;
+use opentelemetry::global;
 use opentelemetry::global::shutdown_tracer_provider;
 use opentelemetry::trace::{Span, SpanKind, Tracer};
 use opentelemetry_otlp::WithExportConfig;
@@ -80,10 +81,10 @@ async fn smoke_tracer() {
     let (addr, mut req_rx) = setup().await;
 
     {
-        println!("Installing tracer...");
+        println!("Installing tracer provider...");
         let mut metadata = tonic::metadata::MetadataMap::new();
         metadata.insert("x-header-key", "header-value".parse().unwrap());
-        let tracer = opentelemetry_otlp::new_pipeline()
+        let tracer_provider = opentelemetry_otlp::new_pipeline()
             .tracing()
             .with_exporter(
                 #[cfg(feature = "gzip-tonic")]
@@ -101,6 +102,10 @@ async fn smoke_tracer() {
             .install_batch(opentelemetry_sdk::runtime::Tokio)
             .expect("failed to install");
 
+        global::set_tracer_provider(tracer_provider);
+
+        let tracer = global::tracer("smoke");
+
         println!("Sending span...");
         let mut span = tracer
             .span_builder("my-test-span")

scripts/msrv.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+
+set -eu
+
+echo "Running msrv check for opentelemetry package"
+cargo check --manifest-path=opentelemetry/Cargo.toml --all-features
+
+echo "Running msrv check for opentelemetry-sdk package"
+cargo check --manifest-path=opentelemetry-sdk/Cargo.toml --all-features
+
+echo "Running msrv check for opentelemetry-stdout package"
+cargo check --manifest-path=opentelemetry-stdout/Cargo.toml --all-features
+
+# TODO: Ignoring as this is failing with the following error:
+# error: package `prost-derive v0.12.6` cannot be built because it requires rustc 1.70 or newer, while the currently active rustc version is 1.65.0
+#echo "Running msrv check for opentelemetry-otlp package"
+# cargo check --manifest-path=opentelemetry-otlp/Cargo.toml --all-features
+
+echo "Running msrv check for opentelemetry-http package"
+cargo check --manifest-path=opentelemetry-http/Cargo.toml --all-features
+
+echo "Running msrv check for opentelemetry-jaeger-propagator package"
+cargo check --manifest-path=opentelemetry-jaeger-propagator/Cargo.toml --all-features
+
+echo "Running msrv check for opentelemetry-zipkin package"
+cargo check --manifest-path=opentelemetry-zipkin/Cargo.toml --all-features
+
+echo "Running msrv check for opentelemetry-appender-log package"
+cargo check --manifest-path=opentelemetry-appender-log/Cargo.toml --all-features
+
+echo "Running msrv check for opentelemetry-appender-tracing package"
+cargo check --manifest-path=opentelemetry-appender-tracing/Cargo.toml --all-features
+