From 575cd01437cff29438912fb6e544adb61fda7ac2 Mon Sep 17 00:00:00 2001 From: Dirkjan Ochtman Date: Wed, 9 Oct 2024 10:46:54 +0200 Subject: [PATCH] Add note on version numbers Co-authored-by: John Landahl --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 2df3f25..955b526 100644 --- a/README.md +++ b/README.md @@ -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