Prepare for 0.3.0 release (#82)

open-telemetry · Mar 24, 2020 · 4efc072 · 4efc072
1 parent 4ae0275
commit 4efc072
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 21 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,19 @@
 # Changelog
 
+## [v0.3.0](https://github.com/open-telemetry/opentelemetry-rust/compare/v0.2.0...v0.3.0)
+
+### Added
+- New Base64 propagator
+- New SpanBuilder api
+- Zipkin Exporter crate 
+
+### Changed
+- Switch to `SpanId` and `TraceId` from `u64` and `u128`
+- Remove `&mut self` requirements for `Span` API
+
+### Fixed
+- circular Tracer debug impl
+
 ## [v0.2.0](https://github.com/open-telemetry/opentelemetry-rust/compare/b5918251cc07f9f6957434ccddc35306f68bd791..v0.2.0)
 
 ### Added

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,13 +1,17 @@
 [package]
 name = "opentelemetry"
-version = "0.2.0"
+version = "0.3.0"
 authors = ["OpenTelemetry Authors <[email protected]>"]
-description = "A Rust OpenTelemetry client"
+description = "A metrics collection and distributed tracing framework"
 homepage = "https://github.com/open-telemetry/opentelemetry-rust"
 repository = "https://github.com/open-telemetry/opentelemetry-rust"
 readme = "README.md"
-categories = ["development-tools::debugging"]
-keywords = ["opentelemetry", "jaeger", "prometheus"]
+categories = [
+    "development-tools::debugging",
+    "development-tools::profiling",
+    "asynchronous",
+]
+keywords = ["opentelemetry", "logging", "tracing", "metrics", "async"]
 license = "Apache-2.0"
 edition = "2018"
 
@@ -23,7 +27,7 @@ bincode = { version = "1.2.1", optional = true }
 [dev-dependencies]
 criterion = "0.3.1"
 hyper = "0.12.0"
-opentelemetry-jaeger = "0.1.0"
+opentelemetry-jaeger = { version = "0.1.0", path = "opentelemetry-jaeger" }
 thrift = "0.13.0"
 futures = "0.3.1"
 tokio = { version = "0.2.10", features = ["full"] }
@@ -42,10 +46,6 @@ members = [
     "examples/actix",
 ]
 
-[patch.crates-io]
-opentelemetry-jaeger = { path = "opentelemetry-jaeger" }
-opentelemetry = { path = "." }
-
 [[bench]]
 name = "trace"
 harness = false
diff --git a/README.md b/README.md
@@ -6,7 +6,13 @@
 [![GitHub Actions CI](https://github.com/open-telemetry/opentelemetry-rust/workflows/CI/badge.svg)](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amaster)
 [![Gitter chat](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/open-telemetry/opentelemetry-rust)
 
-A Rust [OpenTelemetry](https://opentelemetry.io/) client.
+The Rust [OpenTelemetry](https://opentelemetry.io/) client.
+
+OpenTelemetry provides a single set of APIs, libraries, agents, and collector services to capture distributed traces 
+and metrics from your application. You can analyze them using [Prometheus], [Jaeger], and other observability tools.
+
+[Prometheus]: https://prometheus.io
+[Jaeger]: https://www.jaegertracing.io
 
 ## Quick Start
 

diff --git a/examples/actix/Cargo.toml b/examples/actix/Cargo.toml
@@ -4,10 +4,9 @@ version = "0.1.0"
 edition = "2018"
 
 [dependencies]
-opentelemetry = { path = "../../", version = "0.2.0" }
-opentelemetry-jaeger = { path = "../../opentelemetry-jaeger", version = "0.1.0" }
+opentelemetry = { path = "../../" }
+opentelemetry-jaeger = { path = "../../opentelemetry-jaeger" }
 thrift = "0.13.0"
-
 futures = "0.1.25"
 actix-web = "1.0.9"
 actix-service = "0.4.1"
diff --git a/opentelemetry-jaeger/Cargo.toml b/opentelemetry-jaeger/Cargo.toml
@@ -12,7 +12,7 @@ license = "Apache-2.0"
 edition = "2018"
 
 [dependencies]
-opentelemetry = "0.2.0"
+opentelemetry = { version = "0.3.0", path = ".." }
 reqwest = { version = "0.10.1", features = ["blocking"], optional = true }
 thrift = "0.13.0"
 

diff --git a/opentelemetry-zipkin/Cargo.toml b/opentelemetry-zipkin/Cargo.toml
@@ -12,7 +12,7 @@ license = "Apache-2.0"
 edition = "2018"
 
 [dependencies]
-opentelemetry = "0.2.0"
+opentelemetry = { version = "0.3.0", path = ".." }
 reqwest = { version = "0.10.4", features = ["blocking"] }
 serde_json = "1.0"
 serde = { version = "1.0.104", features = ["derive"] }

diff --git a/src/global.rs b/src/global.rs
@@ -154,7 +154,7 @@ impl api::Span for BoxedSpan {
 /// [`GlobalProvider`]: struct.GlobalProvider.html
 /// [`Tracer`]: ../api/trace/tracer/trait.Tracer.html
 #[derive(Debug)]
-pub struct BoxedTracer(Box<dyn GenericTracer>);
+pub struct BoxedTracer(Box<dyn GenericTracer + Send + Sync>);
 
 impl api::Tracer for BoxedTracer {
     /// Global tracer uses `BoxedSpan`s so that it can be a global singleton,
@@ -300,17 +300,17 @@ where
 /// [`GlobalProvider`]: struct.GlobalProvider.html
 pub trait GenericProvider: fmt::Debug + 'static {
     /// Creates a named tracer instance that is a trait object through the underlying `Provider`.
-    fn get_tracer_boxed(&self, name: &'static str) -> Box<dyn GenericTracer>;
+    fn get_tracer_boxed(&self, name: &'static str) -> Box<dyn GenericTracer + Send + Sync>;
 }
 
 impl<S, T, P> GenericProvider for P
 where
     S: api::Span,
-    T: api::Tracer<Span = S>,
+    T: api::Tracer<Span = S> + Send + Sync,
     P: api::Provider<Tracer = T>,
 {
     /// Return a boxed generic tracer
-    fn get_tracer_boxed(&self, name: &'static str) -> Box<dyn GenericTracer> {
+    fn get_tracer_boxed(&self, name: &'static str) -> Box<dyn GenericTracer + Send + Sync> {
         Box::new(self.get_tracer(name))
     }
 }
@@ -331,7 +331,7 @@ impl GlobalProvider {
     fn new<P, T, S>(provider: P) -> Self
     where
         S: api::Span,
-        T: api::Tracer<Span = S>,
+        T: api::Tracer<Span = S> + Send + Sync,
         P: api::Provider<Tracer = T> + Send + Sync,
     {
         GlobalProvider {
@@ -372,7 +372,7 @@ pub fn trace_provider() -> GlobalProvider {
 pub fn set_provider<P, T, S>(new_provider: P)
 where
     S: api::Span,
-    T: api::Tracer<Span = S>,
+    T: api::Tracer<Span = S> + Send + Sync,
     P: api::Provider<Tracer = T> + Send + Sync,
 {
     let mut global_provider = GLOBAL_TRACER_PROVIDER