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

[otlp-exporter] Update support wording in README to state protocol version instead of collector version #3754

Closed
pichlermarc opened this issue Apr 25, 2023 · 4 comments · Fixed by #3938
Assignees
Labels
document Documentation-related enhancement New feature or request

Comments

@pichlermarc
Copy link
Member

pichlermarc commented Apr 25, 2023

Currently, the exporters state a minimum and maximum supported collector version, for instance:

This module provides exporter for node to be used with OTLP (grpc) compatible receivers. Compatible with opentelemetry-collector versions >=0.16 <=0.50.

This refers to the last (manually) tested version; newer versions may actually work fine as long as the protocol version is compatible. We should change the wording to state the supported emitted protocol version instead. In case of a stable protocol, we should state that the exporter also supports later versions of this protocol.

Additional information:

  • currently, we're using proto definitions v0.18.0
  • JSON is not marked as stable for the version we're currently using (v0.18.0). Therefore we should not guarantee that later versions are supported by the JSON exporters.
@pichlermarc pichlermarc added enhancement New feature or request up-for-grabs Good for taking. Extra help will be provided by maintainers document Documentation-related labels Apr 25, 2023
@pichlermarc pichlermarc added this to the OTLP Exporter GA milestone Apr 25, 2023
@dyladan
Copy link
Member

dyladan commented Apr 25, 2023

Are you sure we can't guarantee later versions? The trace, metric, and log protocols are all stable.

@pichlermarc
Copy link
Member Author

Are you sure we can't guarantee later versions? The trace, metric, and log protocols are all stable.

This is only for JSON, and as long as we don't update to v0.19.0. As soon as we bump our proto submodule to 0.19.0 we can also guarantee stability for JSON 🙂

@pichlermarc
Copy link
Member Author

After reading through the comment on #3712, I now think just stating the protocol version we're emitting would be sufficient. I updated the original issue text to reflect this.

Probably 18. I was looking through the proto diffs and there are some changes that might affect compatibility. Not entirely sure as I'm not a proto expert but we should probably just make the guarantee we're sure about and leave the rest to the user to decide. We're emitting version 0.18 proto.

Originally posted by @dyladan in #3712 (comment)

@github-actions
Copy link

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 14 days.

@github-actions github-actions bot added the stale label Jun 26, 2023
@pichlermarc pichlermarc removed stale up-for-grabs Good for taking. Extra help will be provided by maintainers labels Jun 27, 2023
@pichlermarc pichlermarc self-assigned this Jun 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
document Documentation-related enhancement New feature or request
Projects
None yet
2 participants