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.

Sign up for GitHub

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

Add OpCode for activity started and stop in OpenTelemetry-Sdk eventsource #6046

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −2
Open

Add OpCode for activity started and stop in OpenTelemetry-Sdk eventsource #6046

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/OpenTelemetry/Internal/OpenTelemetrySdkEventSource.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,13 +185,13 @@ public void ObservableInstrumentCallbackException(string exception)
this.WriteEvent(16, exception);
}

[Event(24, Message = "Activity started. Name = '{0}', Id = '{1}'.", Level = EventLevel.Verbose)]
[Event(24, Message = "Activity started. Name = '{0}', Id = '{1}'.", Level = EventLevel.Verbose, Opcode = EventOpcode.Start)]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you elaborate why is this important? This code is in SDK's internal logging, and there is no guarantee made on the internal log format. (In fact, internal logging may move to ILogger in the future).

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @cijothomas Thanks for the asking. This is to align with the analyzers like perf view (TraceEvent):

Event source events without OpCode of Start/Stop will be treated as exceptions. Having OpCode marking the start/stop of a request makes it closer to meet the conventions.

And that helps with EventPipe trace / dotnet-trace to better understand those events.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doing it this way will work fine, but I'll also suggest there is naming convention where if you name events with the suffix "Start" and "Stop" then the opcodes are inferred automatically. You don't have to use the naming convention but you will be a little more aligned with names other events on other providers if you do.

https://learn.microsoft.com/en-us/dotnet/core/diagnostics/eventsource-activity-ids#tracking-work-using-an-activity-id

Copy link
Author

@xiaomi7732 xiaomi7732 Jan 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@noahfalk Thanks for pointing that out. That's actually what I really want! @cijothomas, how much impact do you know we will have by changing the name of the events to ActivityStart / ActivityStop from ActivityStarted / ActivityStopped?

public void ActivityStarted(string name, string id)
{
this.WriteEvent(24, name, id);
}

[Event(25, Message = "Activity stopped. Name = '{0}', Id = '{1}'.", Level = EventLevel.Verbose)]
[Event(25, Message = "Activity stopped. Name = '{0}', Id = '{1}'.", Level = EventLevel.Verbose, Opcode = EventOpcode.Stop)]
public void ActivityStopped(string name, string? id)
{
this.WriteEvent(25, name, id);
Expand Down