Remove confusing description from Body field in Logs Data Model #3827
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
jsuereth
approved these changes
Jan 16, 2024
jack-berg
reviewed
Jan 16, 2024
MrAlias
approved these changes
Jan 16, 2024
jack-berg
reviewed
Jan 16, 2024
jack-berg
approved these changes
Jan 16, 2024
Co-authored-by: jack-berg <34418638+jack-berg@users.noreply.github.com>
|
@tigrannajaryan PTAL |
|
I agree that the removed wording does not belong to the data model and is not helpful. However, before we remove it I want to make sure we are not breaking our Stability guarantees. It seems OK to me since I can't see how it is actionable by SDK implementors. It is more of a usage recommendation for end users and would be better suited to a non-normative document like a library guideline. I would like @open-telemetry/specs-logs-approvers to confirm that they do not think this is a breaking change and we are not breaking our stability promise. |
trask
approved these changes
Jan 25, 2024
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
MSNev
reviewed
Jan 30, 2024
|
I made some editorial changes. In my opinion, it is better but it may be good to double-check. |
tigrannajaryan
approved these changes
Feb 1, 2024
cijothomas
reviewed
Feb 1, 2024
cijothomas
approved these changes
Feb 1, 2024
cijothomas
approved these changes
Feb 1, 2024
scheler
approved these changes
Feb 2, 2024
MSNev
approved these changes
Feb 6, 2024
|
Please resolve the conflicts. |
@tigrannajaryan, done. |
carlosalberto
pushed a commit
to carlosalberto/opentelemetry-specification
that referenced
this pull request
Oct 31, 2024
…-telemetry#3827) Related to open-telemetry#3814 ## Changes Remove confusing description from Body field in Logs Data Model. The description makes the specification not clear as the language authors may understand that the Bridge API must only accept Body as `string`. Additionally, I do not think that the following recommendation is actually a good one: > First-party Applications SHOULD use a string message --------- Co-authored-by: jack-berg <34418638+jack-berg@users.noreply.github.com> Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com> Co-authored-by: Cijo Thomas <cithomas@microsoft.com>
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.
Related to #3814
Changes
Remove confusing description from Body field in Logs Data Model.
The description makes the specification not clear as the language authors may understand that the Bridge API must only accept Body as
string.Additionally, I do not think that the following recommendation is actually a good one: