-
Notifications
You must be signed in to change notification settings - Fork 182
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
Deprecate event.name
attribute in favor of EventName on the log record
#1646
Merged
lmolkova
merged 8 commits into
open-telemetry:main
from
lmolkova:deprecate-event-name-attribute
Dec 17, 2024
Merged
Deprecate event.name
attribute in favor of EventName on the log record
#1646
lmolkova
merged 8 commits into
open-telemetry:main
from
lmolkova:deprecate-event-name-attribute
Dec 17, 2024
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
breedx-splk
reviewed
Dec 5, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know it's still just draft, but this seems fine.
MSNev
reviewed
Dec 9, 2024
MSNev
reviewed
Dec 9, 2024
MSNev
reviewed
Dec 9, 2024
lmolkova
force-pushed
the
deprecate-event-name-attribute
branch
from
December 12, 2024 04:59
adf6a98
to
75746bc
Compare
lmolkova
commented
Dec 12, 2024
breedx-splk
approved these changes
Dec 13, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Onward! 🚀
trask
approved these changes
Dec 13, 2024
lmolkova
force-pushed
the
deprecate-event-name-attribute
branch
from
December 13, 2024 02:31
a00f928
to
39b2ad9
Compare
lmolkova
force-pushed
the
deprecate-event-name-attribute
branch
from
December 13, 2024 18:16
e8148c9
to
11409ed
Compare
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.
Part of open-telemetry/opentelemetry-specification#4260
Logs SIG is working on migrating from
event.name
attribute toEventName
field on LogRecord. This is a WIP that depends on theevent.name
attribute into top-level event name field opentelemetry-specification#4320event_name
to logs proto opentelemetry-proto#600Creating it to socialize the proposal and gather high-level feedback.
Semantic conventions that depend on
event.name
(over-the-wire):az.resource.log
and the corresponding collector receiverdevice.app.lifecycle
event - did not find any instrumentations in otel org.feature_flag.evaluation
akafeature_flag
event - no instrumentations in otel orgexception
andrpc.message
are span events - they should not populateevent.name
and should not be affected at allTransition
event.name
is an experimental attribute and de-facto is used by new-ish conventions and instrumentation libraries.So we (Logs SIG) believe no common transition/migration plan is necessary, but individual instrumentation libraries can provide back-compat story.
event.name
attribute can do a breaking change and start usingLogRecord.EventName
property instead of the attribute. It's up to each instrumentation component to provide (or not provide) transition story.event.name
attribute, newLogRecord.EventName
property or both. When both are present, theLogRecord.EventName
should be used as a source of truth.Future
Instead of deprecating
event.name
, we might want to reserve it for bridges similarly tootel.status_code
. E.g. when users want to report event using logging bridge and the logging facade does not have a notion of event name, theevent.name
attribute maybe used by the end users and translated to top-levelLogRecord
property by the adapter.Deprecating the attribute is reversible, so I'd prefer to do it now and tackle compatibility with external logging libs separately.
Merge requirement checklist
[chore]