Adding EventName to LogRecord #6306

juliuskoval · 2025-06-05T04:56:05Z

Addresses #6108

Changes

I added a new property to LogRecord called EventName.
Added a field called EventName to the LogRecordData struct which enables specifying EventName when using the log bridge API.
The OTLP exporter exports EventName according to the proto definition.

Merge requirement checklist

CONTRIBUTING guidelines followed (license requirements, nullable enabled, static analysis, etc.)
Unit tests added/updated
Appropriate CHANGELOG.md files updated for non-trivial changes
Changes in public API reviewed (if applicable)

codecov · 2025-06-05T04:58:59Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.64%. Comparing base (1f9fa9f) to head (e23c391).
Report is 2 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6306      +/-   ##
==========================================
- Coverage   86.72%   86.64%   -0.09%     
==========================================
  Files         258      258              
  Lines       11879    11881       +2     
==========================================
- Hits        10302    10294       -8     
- Misses       1577     1587      +10

Flag	Coverage Δ
unittests-Project-Experimental	`86.34% <100.00%> (-0.26%)`	⬇️
unittests-Project-Stable	`86.53% <100.00%> (-0.03%)`	⬇️
unittests-Solution	`86.60% <100.00%> (+0.17%)`	⬆️
unittests-UnstableCoreLibraries-Experimental	`85.78% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
src/OpenTelemetry.Api/Logs/LogRecordData.cs	`100.00% <100.00%> (ø)`
...etryProtocol/Implementation/ExperimentalOptions.cs	`89.47% <ø> (ø)`
...ementation/Serializer/ProtobufOtlpLogSerializer.cs	`98.49% <100.00%> (ø)`
src/OpenTelemetry/Logs/LoggerSdk.cs	`100.00% <100.00%> (ø)`

... and 4 files with indirect coverage changes

cijothomas · 2025-06-05T15:05:15Z

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/CHANGELOG.md

@@ -12,6 +12,10 @@ Notes](../../RELEASENOTES.md).
  write position, resulting in gRPC protocol errors.
  ([#6280](https://github.com/open-telemetry/opentelemetry-dotnet/pull/6280))

+* **Breaking change**: If `EventName` is specified either through `ILogger`


I suggest to rephrase this.

Given this is a stable package, there cannot be breaking changes.

However, event-name was only exported when enabling the experimental_feature_flag "OTEL_DOTNET_EXPERIMENTAL_OTLP_EMIT_EVENT_LOG_ATTRIBUTES".

The change here is, ILogger's EventName is now exported by default, as LogRecord's EventName. "OTEL_DOTNET_EXPERIMENTAL_OTLP_EMIT_EVENT_LOG_ATTRIBUTES" feature is still required to export EventId.Id as before.

(Not sure of the log-bridge part whether it supported it before or not. If new capability, this is just a feature enhancement, not a breaking change)

cijothomas · 2025-06-05T15:06:22Z

src/OpenTelemetry.Api/CHANGELOG.md

@@ -6,6 +6,8 @@ Notes](../../RELEASENOTES.md).

 ## Unreleased

+* Added the `EventName` property to `LogRecordData` ([#6306](https://github.com/open-telemetry/opentelemetry-dotnet/pull/6306))


maybe make it explicit that this feature (entire log bridge) is still under experimental ?

rajkumar-rangaraj · 2025-06-05T15:18:11Z

There was a previous conversation on this topic. Please ensure that everything mentioned there is addressed: #4754.

juliuskoval · 2025-06-05T20:19:11Z

There was a previous conversation on this topic. Please ensure that everything mentioned there is addressed: #4754.

As far as this goes, I only made it so that EventName will be exported by default according to the spec but I didn't do anything with logrecord.event.id.

cijothomas · 2025-06-10T16:47:10Z

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/CHANGELOG.md

@@ -12,6 +12,13 @@ Notes](../../RELEASENOTES.md).
  write position, resulting in gRPC protocol errors.
  ([#6280](https://github.com/open-telemetry/opentelemetry-dotnet/pull/6280))

+* If `EventName` is specified either through `ILogger` or the experimental


Good writeup!

cijothomas · 2025-06-10T16:50:42Z

src/OpenTelemetry/Logs/LoggerSdk.cs

@@ -35,6 +36,7 @@ public override void EmitLog(in LogRecordData data, in LogRecordAttributeList at

            logRecord.Data = data;
            logRecord.ILoggerData = default;
+            logRecord.ILoggerData.EventId = new EventId(0, data.EventName);


nit: Use something to indicate 0 is a conscious default choice.
new EventId(default, data.EventName) does this work?

Sure, that makes sense.

cijothomas

LGTM. (I recommend to get more eyes before merging, as I am not fully familiar with the experimental bridge side of things.)

CodeBlanch · 2025-06-10T18:30:19Z

src/OpenTelemetry.Api/CHANGELOG.md

@@ -6,6 +6,10 @@ Notes](../../RELEASENOTES.md).

 ## Unreleased

+* Experimental (only in pre-release versions): Added the `EventName` property


nit: This should be added below the existing entries in the "Unreleased" section

CodeBlanch · 2025-06-10T18:56:28Z

src/OpenTelemetry/Logs/LogRecord.cs

+    /// <summary>
+    /// Gets or sets the name of the event associated with the log.
+    /// </summary>
+    public string? EventName


Do we need this? Export authors can access EventName via existing logRecord.EventId.Name (which they should already be doing). Concerns are it is more public API to maintain and it could introduce confusion in the API.

An alternative approach could be: a) Leave this out for now. b) Wait for EventId to land in the spec. c) Once that happens obsolete LogRecord.EventId and add spots for official EventName and EventId (whatever it ends up being).

That makes sense. Do you know if there is currently a proposal to add EventId to the spec? I couldn't find anything in the repository for semantic conventions.

None that is open/active. (open-telemetry/semantic-conventions#372 is the old one)
A lot has changed in the past few months (EventName being a top-level field is a new thing!), and I think it's best to create a new issue to propose adding EventId.Id to spec/convention

alanwest

Because there is some ambiguity in translating ILogger events to OpenTelemetry events, we're discussing an idea to provide an "event name resolver". We need to make a decision about this design before moving forward with this PR.

@juliuskoval What is the main thing you want? Do you require support via ILogger, or do you mainly want support from the experimental bridge API? If the latter, then one suggestion is that you could reduce the scope of this PR to leave the ILogger behavior alone for now while we settle on the design. Either way we can discuss this further at the next SIG meeting.

juliuskoval · 2025-06-15T20:25:50Z

Because there is some ambiguity in translating ILogger events to OpenTelemetry events, we're discussing an idea to provide an "event name resolver". We need to make a decision about this design before moving forward with this PR.

@juliuskoval What is the main thing you want? Do you require support via ILogger, or do you mainly want support from the experimental bridge API? If the latter, then one suggestion is that you could reduce the scope of this PR to leave the ILogger behavior alone for now while we settle on the design. Either way we can discuss this further at the next SIG meeting.

I mostly cared about the bridge API but I'm not in a hurry, so we can just wait. But either way I'll try to join the next SIG meeting.

juliuskoval changed the title ~~Adding event name~~ Adding EventName to LogRecord Jun 5, 2025

github-actions bot added the documentation Documentation related label Jun 5, 2025

juliuskoval force-pushed the adding-EventName branch from 69a64d5 to ff31fb8 Compare June 5, 2025 05:24

github-actions bot removed the documentation Documentation related label Jun 5, 2025

juliuskoval force-pushed the adding-EventName branch from ff31fb8 to 0bca940 Compare June 5, 2025 05:25

martincostello approved these changes Jun 5, 2025

View reviewed changes

juliuskoval marked this pull request as ready for review June 5, 2025 06:21

juliuskoval requested a review from a team as a code owner June 5, 2025 06:21

juliuskoval requested a review from martincostello June 5, 2025 06:29

cijothomas reviewed Jun 5, 2025

View reviewed changes

juliuskoval requested a review from cijothomas June 10, 2025 16:37

juliuskoval added 7 commits June 10, 2025 18:40

adding EventName property to LogRecord

c6434bb

removing event attribute

b27aa04

editing changelogs

df7575c

fix

0e9c401

fix

87c3e1a

fix

8df756a

fix typo

4267ca3

juliuskoval force-pushed the adding-EventName branch from 71ea9a5 to 4267ca3 Compare June 10, 2025 16:42

cijothomas reviewed Jun 10, 2025

View reviewed changes

cijothomas approved these changes Jun 10, 2025

View reviewed changes

CodeBlanch reviewed Jun 10, 2025

View reviewed changes

fixes

e23c391

alanwest requested changes Jun 13, 2025

View reviewed changes

		@@ -6,6 +6,8 @@ Notes](../../RELEASENOTES.md).

		## Unreleased

		* Added the `EventName` property to `LogRecordData` ([#6306](https://github.com/open-telemetry/opentelemetry-dotnet/pull/6306))

		@@ -6,6 +6,10 @@ Notes](../../RELEASENOTES.md).

		## Unreleased

		* Experimental (only in pre-release versions): Added the `EventName` property

Adding EventName to LogRecord #6306

Are you sure you want to change the base?

Adding EventName to LogRecord #6306

Uh oh!

Conversation

juliuskoval commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Merge requirement checklist

Uh oh!

codecov bot commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

cijothomas Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rajkumar-rangaraj commented Jun 5, 2025

Uh oh!

juliuskoval commented Jun 5, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cijothomas left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alanwest left a comment

Choose a reason for hiding this comment

Uh oh!

juliuskoval commented Jun 15, 2025

Uh oh!

Uh oh!

juliuskoval commented Jun 5, 2025 •

edited

Loading

codecov bot commented Jun 5, 2025 •

edited

Loading

cijothomas Jun 5, 2025 •

edited

Loading