Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added notes to README to clarify version compatibility #171

Closed
wants to merge 3 commits into from

Conversation

jlandahl
Copy link
Contributor

@jlandahl jlandahl commented Oct 8, 2024

Motivation

Version compatibility with the OpenTelemetry crates is potentially confusing to new adopters, as the current version of this crate is 0.26, but it is not compatible with 0.26 of the OpenTelemetry crates. A naive developer might simply set the versions for all the dependencies to 0.26 in their own project, which results in some very confusing compiler errors that take some research to figure out (ask me how I know!).

Solution

I added a new section titled "Compatibility with OpenTelemetry crates" just below the "Overview" section. It includes a link to the discussion in #170 as well as a special note about the current 0.26 versus 0.25 situation.

While I was at it, I updated the dependencies in the Cargo.toml example in the "Basic Usage" section and ensured that the example code still works with the updated versions.

I also added to the "Visualization example" section, including a link to the opentelemetry-otlp.rs example and a minimum Cargo.toml example for using that code in a separate project. I simplified the dependencies there to include only the minimum features necessary for the example to work.

Added a new section titled "Compatibility with OpenTelemetry" crates to explain the differences in version numbers, with particular attention to 0.25 versus 0.26.

Also updated the `Cargo.toml` example and added to the "visualization example" section.
@djc
Copy link
Collaborator

djc commented Oct 9, 2024

Wanted something slightly different, proposed in #172, mentioning you as a co-author on the relevant commit. Thanks!

@djc djc closed this Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants