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

Glossary term Event needs more explanation #6069

Open
chalin opened this issue Jan 24, 2025 · 7 comments
Open

Glossary term Event needs more explanation #6069

chalin opened this issue Jan 24, 2025 · 7 comments
Labels
docs enhancement New feature or request

Comments

@chalin
Copy link
Contributor

chalin commented Jan 24, 2025

Context https://cloud-native.slack.com/archives/C01N7PP1THC/p1737719337217569:

... can someone help me to find or explain the difference between events and logs? https://opentelemetry.io/docs/specs/semconv/general/

This should be clarified in the Event glossary entry IMHO.

In particular, we might also want to link to:

WDYT?

/cc @open-telemetry/spec-sponsors

Related:

@Kludex
Copy link

Kludex commented Jan 24, 2025

Can we clarify the use of span events and log records for exceptions? Currently, at least in Python, the opentelemetry-python sdk uses span events to record exceptions, but it seems the spec says that we should use a log record.

@adriangb
Copy link

I also would like a basic clarification of the relationship between span events and the "events" (the ones that are seemingly being replaced by logs).

@adriangb
Copy link

I also would like a basic clarification of the relationship between span events and the "events" (the ones that are seemingly being replaced by logs).

https://github.com/open-telemetry/opentelemetry-specification/blob/main/oteps/0265-event-vision.md#relationship-to-span-events

Events are intended to replace Span Events in the long term. Span Events will be deprecated to signal that users should prefer Events.

Interoperability between Events and Span Events will be defined in the short term.

@pellared
Copy link
Member

pellared commented Jan 24, 2025

Here is how we described it in OTel Go:

A log record with non-empty event name is interpreted as an event record.

You can think of "event.name" like a "log record type".

From the OTel world, I think that we could have span.started events (log records with event name span.started) with the information about the started span. This could e.g. help users that experience long-living spans or people who do not have a tracing backend (like Jaeger) and have to rely on logs.

@adriangb
Copy link

From the OTel world, I think that we could have span.started events (log records with event name span.started) with the information about the started span. This could e.g. help users that experience long-living spans or people who do not have a tracing backend (like Jaeger) and have to rely on logs.

We've already implemented this, it works ~ generally well, but there are gotchas.

@pellared
Copy link
Member

CC @open-telemetry/semconv-event-approvers

@trask
Copy link
Member

trask commented Jan 24, 2025

Can we clarify the use of span events and log records for exceptions? Currently, at least in Python, the opentelemetry-python sdk uses span events to record exceptions, but it seems the spec says that we should use a log record.

the spec doesn't say this yet, though we're going in that direction: open-telemetry/opentelemetry-specification#4333

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs enhancement New feature or request
Projects
Status: No status
Development

No branches or pull requests

5 participants