Skip to content

Commit 0d666d4

Browse files
authored
Add warning to jaeger docs about future deprecation: (#996)
1 parent 592e77a commit 0d666d4

File tree

1 file changed

+6
-0
lines changed
  • opentelemetry-jaeger/src

1 file changed

+6
-0
lines changed

opentelemetry-jaeger/src/lib.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
//! Collects OpenTelemetry spans and reports them to a given Jaeger
22
//! `agent` or `collector` endpoint, propagate the tracing context between the applications using [Jaeger propagation format].
33
//!
4+
//! *Warning*: Note that the exporter component from this crate will be [deprecated][jaeger-deprecation]
5+
//! in the future. Users are advised to move to [opentelemetry_otlp][otlp-exporter] instead as [Jaeger][jaeger-otlp]
6+
//! supports accepting data in the OTLP protocol.
47
//! See the [Jaeger Docs] for details about Jaeger and deployment information.
58
//!
69
//! *Compiler support: [requires `rustc` 1.60+][msrv]*
710
//!
811
//! [Jaeger Docs]: https://www.jaegertracing.io/docs/
12+
//! [jaeger-deprecation]: https://github.com/open-telemetry/opentelemetry-specification/pull/2858/files
13+
//! [jaeger-otlp]: https://www.jaegertracing.io/docs/1.38/apis/#opentelemetry-protocol-stable
14+
//! [otlp-exporter]: https://docs.rs/opentelemetry-otlp/latest/opentelemetry_otlp/
915
//! [msrv]: #supported-rust-versions
1016
//! [jaeger propagation format]: https://www.jaegertracing.io/docs/1.18/client-libraries/#propagation-format
1117
//!

0 commit comments

Comments
 (0)