Skip to content

Commit 0bf6deb

Browse files
authored
Add performance and compatibility details to EtwManifestEventFormat and EtwSelfDescribingEventFormat docs (#12000)
1 parent 0ddbf94 commit 0bf6deb

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

xml/System.Diagnostics.Tracing/EventSourceSettings.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@
137137
</ReturnValue>
138138
<MemberValue>4</MemberValue>
139139
<Docs>
140-
<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>
140+
<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>
141141
</Docs>
142142
</Member>
143143
<Member MemberName="EtwSelfDescribingEventFormat">
@@ -177,7 +177,7 @@
177177
</ReturnValue>
178178
<MemberValue>8</MemberValue>
179179
<Docs>
180-
<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>
180+
<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>
181181
</Docs>
182182
</Member>
183183
<Member MemberName="ThrowOnEventWriteErrors">

0 commit comments

Comments
 (0)