Skip to content

Add performance and compatibility details to EtwManifestEventFormat and EtwSelfDescribingEventFormat docs #12000

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

Merged
merged 6 commits into from
Nov 3, 2025
Merged

Add performance and compatibility details to EtwManifestEventFormat and EtwSelfDescribingEventFormat docs #12000

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
45e76d7
Initial plan
Copilot Nov 1, 2025
2c1e34f
Add performance and compatibility info to EtwManifestEventFormat and …
Copilot Nov 1, 2025
d93a5ed
Remove redundant text from EtwManifestEventFormat documentation
Copilot Nov 1, 2025
0586d3a
Update xml/System.Diagnostics.Tracing/EventSourceSettings.xml
jkotas Nov 1, 2025
a88d09b
Add link to EventSource documentation for both enum values
Copilot Nov 1, 2025
baa81b9
Apply suggestions from code review
jkotas Nov 1, 2025
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 xml/System.Diagnostics.Tracing/EventSourceSettings.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>The ETW listener should use a manifest-based format when raising events. Setting this option is a directive to the ETW listener should use manifest-based format when raising events. This is the default option when defining a type derived from <see cref="T:System.Diagnostics.Tracing.EventSource" /> using one of the protected <see cref="T:System.Diagnostics.Tracing.EventSource" /> constructors.</summary>
<summary>The ETW listener should use a manifest-based format when raising events. This is the default option when defining a type derived from <see cref="T:System.Diagnostics.Tracing.EventSource" /> using one of the protected <see cref="T:System.Diagnostics.Tracing.EventSource" /> constructors. This format has lower per-event serialization overhead compared to <see cref="F:System.Diagnostics.Tracing.EventSourceSettings.EtwSelfDescribingEventFormat" />. For more information, see <see href="/dotnet/fundamentals/runtime-libraries/system-diagnostics-tracing-eventsource#self-describing-tracelogging-vs-manifest-event-formats">Self-describing vs. manifest event formats</see>.</summary>
</Docs>
</Member>
<Member MemberName="EtwSelfDescribingEventFormat">
Expand Down Expand Up @@ -177,7 +177,7 @@
</ReturnValue>
<MemberValue>8</MemberValue>
<Docs>
<summary>The ETW listener should use self-describing event format. This is the default option when creating a new instance of the <see cref="T:System.Diagnostics.Tracing.EventSource" /> using one of the public <see cref="T:System.Diagnostics.Tracing.EventSource" /> constructors.</summary>
<summary>The ETW listener should use self-describing event format. This is the default option when creating a new instance of the <see cref="T:System.Diagnostics.Tracing.EventSource" /> using one of the public <see cref="T:System.Diagnostics.Tracing.EventSource" /> constructors. This format has more capabilities and better compatibility with listeners that don't use the TraceEvent library, but has higher per-event serialization overhead compared to <see cref="F:System.Diagnostics.Tracing.EventSourceSettings.EtwManifestEventFormat" />. For more information, see <see href="/dotnet/fundamentals/runtime-libraries/system-diagnostics-tracing-eventsource#self-describing-tracelogging-vs-manifest-event-formats">Self-describing vs. manifest event formats</see>.</summary>
</Docs>
</Member>
<Member MemberName="ThrowOnEventWriteErrors">
Expand Down