Move 3rd party propagators and merge exporter into sdk::export (#375)

open-telemetry · Dec 7, 2020 · 5192fba · 5192fba
1 parent a0ade71
commit 5192fba
Show file tree

Hide file tree

Showing 75 changed files with 897 additions and 867 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -52,7 +52,7 @@ jobs:
         override: true
     - name: Run tests
       run: cargo --version &&
-        cargo test --verbose --manifest-path=opentelemetry/Cargo.toml --features trace,metrics,serialize,tokio,serde,http,tonic,reqwest &&
+        cargo test --verbose --manifest-path=opentelemetry/Cargo.toml --features trace,metrics,serialize,tokio,serde,http,tonic,reqwest,testing &&
         cargo test --manifest-path=opentelemetry-jaeger/Cargo.toml &&
         cargo test --manifest-path=opentelemetry-zipkin/Cargo.toml
   meta:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -129,3 +129,7 @@ See the [code owners](CODEOWNERS) file.
 
 See the [community membership document in OpenTelemetry community
 repo](https://github.com/open-telemetry/community/blob/master/community-membership.md).
+
+## FAQ
+### Where should I put third party propagators/exporters, contrib or standalone crates?
+As of now, the specification classify the propagators into three categories: Fully opened standards, platform-specific standards, proprietary headers. The conclusion is only the fully opened standards should live in SDK packages/repos. So here, only fully opened standards should live as independent crate. For more detail and discussion, see [this pr](https://github.com/open-telemetry/opentelemetry-specification/pull/1144).  
diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@ observability tools.
 ## Getting Started
 
 ```rust
-use opentelemetry::{exporter::trace::stdout, trace::Tracer};
+use opentelemetry::{sdk::export::trace::stdout, trace::Tracer};
 
 fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
     // Create a new instrumentation pipeline

diff --git a/examples/aws-xray/Cargo.toml b/examples/aws-xray/Cargo.toml
@@ -17,4 +17,4 @@ path = "src/client.rs"
 hyper = "0.13"
 tokio = { version = "0.2", features = ["full"] }
 opentelemetry = { path = "../../opentelemetry", features = ["http"] }
-opentelemetry-contrib = { path = "../../opentelemetry-contrib" }
+opentelemetry-contrib = { path = "../../opentelemetry-contrib", features = ["aws-xray"] }
diff --git a/examples/aws-xray/src/client.rs b/examples/aws-xray/src/client.rs
@@ -1,11 +1,12 @@
 use hyper::{body::Body, Client};
 use opentelemetry::{
-    exporter::trace::stdout,
     global,
-    sdk::{propagation::XrayPropagator, trace as sdktrace},
+    sdk::export::trace::stdout,
+    sdk::trace as sdktrace,
     trace::{TraceContextExt, Tracer},
     Context, KeyValue,
 };
+use opentelemetry_contrib::trace::propagator::XrayPropagator;
 
 fn init_tracer() -> (sdktrace::Tracer, stdout::Uninstall) {
     global::set_text_map_propagator(XrayPropagator::new());

diff --git a/examples/aws-xray/src/server.rs b/examples/aws-xray/src/server.rs
@@ -1,11 +1,12 @@
 use hyper::service::{make_service_fn, service_fn};
 use hyper::{Body, Request, Response, Server};
 use opentelemetry::{
-    exporter::trace::stdout,
     global,
-    sdk::{propagation::XrayPropagator, trace as sdktrace},
+    sdk::export::trace::stdout,
+    sdk::trace as sdktrace,
     trace::{Span, Tracer},
 };
+use opentelemetry_contrib::trace::propagator::XrayPropagator;
 use std::{convert::Infallible, net::SocketAddr};
 
 async fn handle(req: Request<Body>) -> Result<Response<Body>, Infallible> {

diff --git a/examples/basic-otlp/src/main.rs b/examples/basic-otlp/src/main.rs
@@ -1,5 +1,4 @@
 use futures::stream::{Stream, StreamExt};
-use opentelemetry::exporter;
 use opentelemetry::sdk::metrics::PushController;
 use opentelemetry::trace::TraceError;
 use opentelemetry::{
@@ -22,7 +21,7 @@ fn delayed_interval(duration: Duration) -> impl Stream<Item = tokio::time::Insta
 }
 
 fn init_meter() -> metrics::Result<PushController> {
-    exporter::metrics::stdout(tokio::spawn, delayed_interval)
+    opentelemetry::sdk::export::metrics::stdout(tokio::spawn, delayed_interval)
         .with_quantiles(vec![0.5, 0.9, 0.99])
         .with_formatter(|batch| {
             serde_json::to_value(batch)

diff --git a/examples/basic/src/main.rs b/examples/basic/src/main.rs
@@ -1,5 +1,4 @@
 use futures::stream::{Stream, StreamExt};
-use opentelemetry::exporter;
 use opentelemetry::global;
 use opentelemetry::sdk::{metrics::PushController, trace as sdktrace};
 use opentelemetry::trace::TraceError;
@@ -28,7 +27,7 @@ fn delayed_interval(duration: Duration) -> impl Stream<Item = tokio::time::Insta
 }
 
 fn init_meter() -> metrics::Result<PushController> {
-    exporter::metrics::stdout(tokio::spawn, delayed_interval)
+    opentelemetry::sdk::export::metrics::stdout(tokio::spawn, delayed_interval)
         .with_quantiles(vec![0.5, 0.9, 0.99])
         .with_formatter(|batch| {
             serde_json::to_value(batch)

diff --git a/examples/http/src/client.rs b/examples/http/src/client.rs
@@ -1,6 +1,6 @@
 use hyper::{body::Body, Client};
-use opentelemetry::exporter::trace::stdout;
 use opentelemetry::global;
+use opentelemetry::sdk::export::trace::stdout;
 use opentelemetry::sdk::{
     propagation::TraceContextPropagator,
     trace::{Config, Sampler},

diff --git a/examples/http/src/server.rs b/examples/http/src/server.rs
@@ -1,8 +1,8 @@
 use hyper::service::{make_service_fn, service_fn};
 use hyper::{Body, Request, Response, Server};
 use opentelemetry::{
-    exporter::trace::stdout,
     global,
+    sdk::export::trace::stdout,
     sdk::{
         propagation::TraceContextPropagator,
         trace::{Config, Sampler},

diff --git a/examples/stdout.rs b/examples/stdout.rs
@@ -1,5 +1,5 @@
 use opentelemetry::{
-    exporter::trace::stdout,
+    sdk::export::trace::stdout,
     sdk::trace::{self, Sampler},
     trace::Tracer,
 };

diff --git a/opentelemetry-contrib/Cargo.toml b/opentelemetry-contrib/Cargo.toml
@@ -26,6 +26,7 @@ datadog = ["indexmap", "rmp", "async-trait", "thiserror"]
 reqwest-blocking-client = ["reqwest/blocking", "opentelemetry/reqwest"]
 reqwest-client = ["reqwest", "opentelemetry/reqwest"]
 surf-client = ["surf", "opentelemetry/surf"]
+aws-xray = []
 
 [dependencies]
 async-trait = { version = "0.1", optional = true }
@@ -42,3 +43,4 @@ thiserror = { version = "1.0", optional = true }
 [dev-dependencies]
 base64 = "0.13"
 isahc = "0.9"
+opentelemetry = { path = "../opentelemetry", features = ["trace", "http", "testing"] }
diff --git a/opentelemetry-contrib/src/trace/exporter/datadog/mod.rs b/opentelemetry-contrib/src/trace/exporter/datadog/mod.rs
@@ -72,8 +72,8 @@
 //! ```no_run
 //! use opentelemetry::{KeyValue, trace::Tracer};
 //! use opentelemetry::sdk::{trace::{self, IdGenerator, Sampler}, Resource};
-//! use opentelemetry::exporter::trace::ExportResult;
-//! use opentelemetry::exporter::trace::HttpClient;
+//! use opentelemetry::sdk::export::trace::ExportResult;
+//! use opentelemetry::sdk::export::trace::HttpClient;
 //! use opentelemetry_contrib::trace::exporter::datadog::{new_pipeline, ApiVersion};
 //! use async_trait::async_trait;
 //! use opentelemetry_contrib::trace::exporter::datadog::Error;
@@ -127,8 +127,8 @@ pub use model::Error;
 
 use async_trait::async_trait;
 use http::{Method, Request, Uri};
-use opentelemetry::exporter::trace;
-use opentelemetry::exporter::trace::{HttpClient, SpanData};
+use opentelemetry::sdk::export::trace;
+use opentelemetry::sdk::export::trace::{HttpClient, SpanData};
 use opentelemetry::trace::TraceError;
 use opentelemetry::{global, sdk, trace::TracerProvider};
 

diff --git a/opentelemetry-contrib/src/trace/exporter/datadog/model/mod.rs b/opentelemetry-contrib/src/trace/exporter/datadog/model/mod.rs
@@ -1,4 +1,4 @@
-use opentelemetry::exporter::{trace, ExportError};
+use opentelemetry::sdk::export::{trace, ExportError};
 
 mod v03;
 mod v05;

diff --git a/opentelemetry-contrib/src/trace/exporter/datadog/model/v03.rs b/opentelemetry-contrib/src/trace/exporter/datadog/model/v03.rs
@@ -1,5 +1,5 @@
 use crate::trace::exporter::datadog::model::Error;
-use opentelemetry::exporter::trace;
+use opentelemetry::sdk::export::trace;
 use opentelemetry::{Key, Value};
 use std::time::SystemTime;
 

diff --git a/opentelemetry-contrib/src/trace/exporter/datadog/model/v05.rs b/opentelemetry-contrib/src/trace/exporter/datadog/model/v05.rs
@@ -1,6 +1,6 @@
 use crate::trace::exporter::datadog::intern::StringInterner;
-use crate::trace::exporter::datadog::model::Error;
-use opentelemetry::exporter::trace;
+use crate::trace::exporter::datadog::Error;
+use opentelemetry::sdk::export::trace;
 use opentelemetry::{Key, Value};
 use std::time::SystemTime;
 

diff --git a/opentelemetry/src/sdk/propagation/aws.rs → ...metry-contrib/src/trace/propagator/aws.rs b/opentelemetry/src/sdk/propagation/aws.rs → ...metry-contrib/src/trace/propagator/aws.rs
@@ -1,4 +1,4 @@
-use crate::{
+use opentelemetry::{
     propagation::{text_map_propagator::FieldIter, Extractor, Injector, TextMapPropagator},
     trace::{
         SpanContext, SpanId, TraceContextExt, TraceId, TraceState, TRACE_FLAG_DEFERRED,
@@ -32,7 +32,7 @@ lazy_static::lazy_static! {
 ///
 /// ```
 /// use opentelemetry::global;
-/// use opentelemetry::sdk::propagation::XrayPropagator;
+/// use opentelemetry_contrib::trace::propagator::XrayPropagator;
 ///
 /// global::set_text_map_propagator(XrayPropagator::default());
 /// ```
@@ -236,8 +236,8 @@ fn title_case(s: &str) -> String {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::testing::trace::TestSpan;
-    use crate::trace::TraceState;
+    use opentelemetry::testing::trace::TestSpan;
+    use opentelemetry::trace::TraceState;
     use std::collections::HashMap;
     use std::str::FromStr;
 

diff --git a/opentelemetry-contrib/src/trace/propagator/mod.rs b/opentelemetry-contrib/src/trace/propagator/mod.rs
@@ -6,4 +6,12 @@
 //! Currently, the following propagators are supported:
 //!
 //! * `binary_propagator`, propagating trace context in the binary format.
+//! * `XrayPropagator`, propagating via AWS XRay protocol.
+//!
+//! This module also provides relative types for those propagators.
+#[cfg(feature = "aws-xray")]
+mod aws;
 pub mod binary;
+
+#[cfg(feature = "aws-xray")]
+pub use aws::XrayPropagator;
diff --git a/opentelemetry-jaeger/Cargo.toml b/opentelemetry-jaeger/Cargo.toml
@@ -34,6 +34,10 @@ tokio = { version = "0.2", features = ["udp", "sync"], optional = true }
 wasm-bindgen = { version = "0.2", optional = true }
 wasm-bindgen-futures = { version = "0.4.18", optional = true }
 thiserror = "1.0"
+lazy_static = "1.4"
+
+[dev-dependencies]
+opentelemetry = { version = "0.10", default-features = false, features = ["trace", "testing"], path = "../opentelemetry" }
 
 [dependencies.web-sys]
 version = "0.3.4"

diff --git a/opentelemetry-jaeger/README.md b/opentelemetry-jaeger/README.md
@@ -4,7 +4,7 @@
 
 # OpenTelemetry Jaeger
 
-[`Jaeger`] integration for applications instrumented with [`OpenTelemetry`].
+[`Jaeger`] integration for applications instrumented with [`OpenTelemetry`]. This includes a jaeger exporter and a jaeger propagator.
 
 [![Crates.io: opentelemetry-jaeger](https://img.shields.io/crates/v/opentelemetry-jaeger.svg)](https://crates.io/crates/opentelemetry-jaeger)
 [![Documentation](https://docs.rs/opentelemetry-jaeger/badge.svg)](https://docs.rs/opentelemetry-jaeger)
@@ -43,8 +43,10 @@ exporting telemetry:
 
 ```rust
 use opentelemetry::tracer;
+use opentelemetry::global;
 
 fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
+    global::set_text_map_propagator(opentelemetry_jaeger::Propagator::new());
     let (tracer, _uninstall) = opentelemetry_jaeger::new_pipeline().install()?;
 
     tracer.in_span("doing_work", |cx| {
@@ -84,8 +86,10 @@ in the [jaeger variables spec].
 
 ```rust
 use opentelemetry::tracer;
+use opentelemetry::global;
 
 fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
+    global::set_text_map_propagator(opentelemetry_jaeger::Propagator::new());
     // export OTEL_SERVICE_NAME=my-service-name
     let (tracer, _uninstall) = opentelemetry_jaeger::new_pipeline().from_env().install()?;
 
@@ -142,8 +146,10 @@ Example showing how to override all configuration options. See the
 ```rust
 use opentelemetry::{KeyValue, Tracer};
 use opentelemetry::sdk::{trace, IdGenerator, Resource, Sampler};
+use opentelemetry::global;
 
 fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
+    global::set_text_map_propagator(opentelemetry_jaeger::Propagator::new());
     let (tracer, _uninstall) = opentelemetry_jaeger::new_pipeline()
         .from_env()
         .with_agent_endpoint("localhost:6831")

diff --git a/opentelemetry-jaeger/src/agent.rs → opentelemetry-jaeger/src/exporter/agent.rs b/opentelemetry-jaeger/src/agent.rs → opentelemetry-jaeger/src/exporter/agent.rs
@@ -1,9 +1,9 @@
 //! # UDP Jaeger Agent Client
-use crate::thrift::{
+use crate::exporter::thrift::{
     agent::{self, TAgentSyncClient},
     jaeger,
 };
-use crate::transport::{TBufferChannel, TNoopChannel};
+use crate::exporter::transport::{TBufferChannel, TNoopChannel};
 use std::fmt;
 use std::net::{ToSocketAddrs, UdpSocket};
 use thrift::{

diff --git a/opentelemetry-jaeger/src/collector.rs → ...elemetry-jaeger/src/exporter/collector.rs b/opentelemetry-jaeger/src/collector.rs → ...elemetry-jaeger/src/exporter/collector.rs
@@ -23,7 +23,7 @@ struct WasmHttpClient {
 #[cfg(feature = "collector_client")]
 mod collector_client {
     use super::*;
-    use crate::thrift::jaeger;
+    use crate::exporter::thrift::jaeger;
     use http::{Request, Uri};
     use isahc::{
         auth::{Authentication, Credentials},
@@ -106,7 +106,7 @@ mod collector_client {
 #[cfg(all(feature = "wasm_collector_client", not(feature = "collector_client")))]
 mod wasm_collector_client {
     use super::*;
-    use crate::thrift::jaeger;
+    use crate::exporter::thrift::jaeger;
     use futures_util::future;
     use http::Uri;
     use js_sys::Uint8Array;

diff --git a/opentelemetry-jaeger/src/env.rs → opentelemetry-jaeger/src/exporter/env.rs b/opentelemetry-jaeger/src/env.rs → opentelemetry-jaeger/src/exporter/env.rs