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

Describe the use cases for events in greater detail #3969

Merged
merged 21 commits into from
Jun 3, 2024

Conversation

tedsuo
Copy link
Contributor

@tedsuo tedsuo commented Mar 29, 2024

Resolves #3254 and #4045

The PR adds clarity to the features provided by Events, as well as guidance on when it is appropriate to use the Event API.

Changes

  • Reorganized the Data Model section for clarity
  • Include MUST for the requirement that Event Body and Attributes fields conform to a schema.
  • Include use cases for when Events are appropriate.
  • Include a warning that advanced logging features are not currently accessible when using Events.

@yurishkuro
Copy link
Member

@tedsuo are there existing Event API language implementations? I don't see events mentioned in the compliance matrix.

@tedsuo
Copy link
Contributor Author

tedsuo commented Mar 30, 2024

@yurishkuro there is a Java prototype and a Web JS prototype.

The API is experimental and still hasn't been exercised, it feels a little too early to add it to the compliance matrix.

Copy link

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Apr 12, 2024
@reyang reyang removed the Stale label Apr 19, 2024
Copy link

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Apr 27, 2024
Copy link

github-actions bot commented May 4, 2024

Closed as inactive. Feel free to reopen if this PR is still being worked on.

@tedsuo
Copy link
Contributor Author

tedsuo commented May 17, 2024

At this point, all conversations are resolved and this is ready to merge, except fucking javadoc.io is down which is causing the lint checker to fail. 🫠

"A distributed system is one in which the failure of a computer you didn't even know existed can render your own computer unusable" -Leslie Lamport

larry

@reyang
Copy link
Member

reyang commented May 17, 2024

At this point, all conversations are resolved and this is ready to merge, except fucking javadoc.io is down which is causing the lint checker to fail. 🫠

It is not a required CI check.

@tedsuo tedsuo requested a review from jack-berg May 20, 2024 19:10
@carlosalberto
Copy link
Contributor

@martinkuba @MSNev ping

specification/logs/event-api.md Outdated Show resolved Hide resolved
specification/logs/event-api.md Outdated Show resolved Hide resolved
specification/logs/event-api.md Outdated Show resolved Hide resolved
specification/logs/event-api.md Outdated Show resolved Hide resolved
specification/logs/event-api.md Outdated Show resolved Hide resolved
specification/logs/event-api.md Outdated Show resolved Hide resolved
@carlosalberto carlosalberto merged commit 7deeee8 into open-telemetry:main Jun 3, 2024
6 checks passed
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 31, 2024
)

Resolves open-telemetry#3254 and open-telemetry#4045 

The PR adds clarity to the features provided by Events, as well as
guidance on when it is appropriate to use the Event API.

## Changes

* Reorganized the Data Model section for clarity
* Include MUST for the requirement that Event `Body` and `Attributes`
fields conform to a schema.
* Include use cases for when Events are appropriate.
* Include a warning that advanced logging features are not currently
accessible when using Events.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Proposal: provide guidance on when to use Event API
9 participants