Skip to content

Commit 7bdceb5

Browse files
tarekghgewarren
andauthored
Add a remark to AddEvent method (#4871)
* Add a remark to AddEvent method * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: Genevieve Warren <[email protected]>
1 parent 2f85441 commit 7bdceb5

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

xml/System.Diagnostics/Activity.xml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,17 @@ This key/value pair is included in the collection returned by the <xref:System.D
172172
<summary>Adds the specified activity event to the events list.</summary>
173173
<returns>
174174
<see langword="this" /> for convenient chaining.</returns>
175-
<remarks>To be added.</remarks>
175+
<remarks>
176+
<format type="text/markdown"><![CDATA[
177+
178+
## Remarks
179+
180+
`AddEvent` is not intended for adding many events over a long period of time, because the event objects are stored in memory. Adding too many events to the same `Activity` object can impact app performance.
181+
Callers should either restrict the number of events added to the same `Activity` object or choose another logging mechanism, for example, <xref:Microsoft.Extensions.Logging?displayProperty=fullName>.
182+
183+
]]></format>
184+
</remarks>
185+
176186
</Docs>
177187
</Member>
178188
<Member MemberName="AddTag">

0 commit comments

Comments
 (0)