opentelemetry-java icon indicating copy to clipboard operation
opentelemetry-java copied to clipboard

Please document the matching versions of agent, collector, and sdk

Open serv-inc opened this issue 1 year ago • 4 comments

Is your feature request related to a problem? Please describe. Since it is a bit tedious to dig through the source code to find the version of opentelemetry-proto, and to link that to the correct opentelemetry-collector, and the correct opentelemetry-javaagent , which both have different versions: is there a list detailing the relationships ?

Which versions of the agent need to be used with which versions of

  1. collector, and
  2. e.g. the java sdk

Describe the solution you'd like A table which the matching versions, either specific versions or version ranges.

Describe alternatives you've considered A BOM seems suboptimal, since the collector is e.g. deployed via rpm as a standalong tool, the java agent is a file on the host system, and the library is most often deployed via e.g. maven.

Additional context Suggested in https://github.com/open-telemetry/opentelemetry-java/discussions/6802#discussioncomment-11830428

serv-inc avatar Jan 16 '25 10:01 serv-inc

For reference, the version of opentelemetry-proto we work off of is defined here: https://github.com/open-telemetry/opentelemetry-java/blob/main/dependencyManagement/build.gradle.kts#L75

Should find a way to allow this version to be highlighted in the README and possibly on the otel java docs intro page.

jack-berg avatar Jan 17 '25 19:01 jack-berg

Did you mean https://github.com/open-telemetry/opentelemetry-java/blob/main/dependencyManagement/build.gradle.kts#L88 ? (just to save others the confusion)

serv-inc avatar Mar 04 '25 16:03 serv-inc

Yes, the line number is subject to change, but here's a permalink to the version in the latest commit in main as of 3/4: https://github.com/open-telemetry/opentelemetry-java/blob/0a993b392c8696d09922615938a8e05c50cc5ed6/dependencyManagement/build.gradle.kts#L88

jack-berg avatar Mar 04 '25 16:03 jack-berg

@jack-berg : the version in the repo seems to always be the alpha version. Should this simply be extrapolated to the release version on each tag, or did I overlook something?

serv-inc avatar Mar 18 '25 15:03 serv-inc