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

[chore] Add clarification on event attributes vs body fields #1263

Merged
merged 4 commits into from
Jul 22, 2024

Conversation

JamieDanielson
Copy link
Member

Changes

  • Add clarification describing when to use attributes and when to use body fields for an event
    • This was discussed briefly during SemConv SIG meeting, with the goal of helping clarify the structure of events.
  • Rename data to body
    • The name of the body had gone through several iterations before deciding on the final term body. I'm not sure whether the word payload is still necessary here or if it's a relic of the previous term, so I've left it but could see renaming these to just body from payload (data). This can also be a separate PR if further discussion is warranted.

Merge requirement checklist

I cannot tell if this would require a changelog, happy to add if deemed appropriate.

@JamieDanielson JamieDanielson requested review from a team July 16, 2024 23:02
@JamieDanielson
Copy link
Member Author

@open-telemetry/semconv-event-approvers please take a look!

@joaopgrassi joaopgrassi enabled auto-merge (squash) July 22, 2024 15:05
@joaopgrassi joaopgrassi merged commit c0dd298 into open-telemetry:main Jul 22, 2024
12 checks passed
maryliag pushed a commit to maryliag/semantic-conventions that referenced this pull request Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants