Skip to content

Commit

Permalink
Add note on version numbers
Browse files Browse the repository at this point in the history
Co-authored-by: John Landahl <john@landahl.org>
  • Loading branch information
djc and jlandahl committed Oct 9, 2024
1 parent bd9c30e commit 575cd01
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,16 @@ The crate provides the following types:

[msrv]: #supported-rust-versions

## Compatibility with OpenTelemetry crates

Note that version numbers for this crate are **not** synchronized with the
various OpenTelemetry crates, despite having similar version numbers. For
discussion, see [issue #170](https://github.com/tokio-rs/tracing-opentelemetry/issues/170).

As of 0.26, tracing-opentelemetry is one version ahead of the opentelemetry
crates, such that tracing-opentelemetry 0.26.0 is compatible with opentelemetry 0.25.0,
but due to semver compatibility concerns, this may not always be the case.

## Visualizing traces with Jaeger

```console
Expand Down

0 comments on commit 575cd01

Please sign in to comment.