[editorial] Remove implementation detail from Logs Bridge API #3884
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The bridge-api.md document specifies the Logs Bridge API, it does not defined the OpenTelemetry defined implementations of this API. Remove this detail from the API and leave it for the implementation specification to define. Importantly, the API is decoupled from implementation for a reason. Third-party implementation may exists that OTel does not have domain over. This document needs to written with that in mind.
jack-berg
approved these changes
Feb 20, 2024
pellared
approved these changes
Feb 23, 2024
trask
approved these changes
Feb 27, 2024
reyang
approved these changes
Feb 28, 2024
reyang
added
the
editorial
jaydeluca
pushed a commit
to jaydeluca/opentelemetry-specification
that referenced
this pull request
Feb 29, 2024
carlosalberto
pushed a commit
to carlosalberto/opentelemetry-specification
that referenced
this pull request
Oct 31, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The bridge-api.md document specifies the Logs Bridge API, it does not defined the OpenTelemetry defined implementations of this API. Remove this detail from the API and leave it for the implementation specification to define.
Importantly, the API is decoupled from implementation for a reason. Third-party implementation may exists that OTel does not have domain over. This document needs to written with that in mind.
Related to #3171 and #3071 which were similar issues resolved for the metric API definition.