Skip to content

Commit 92e84fa

Browse files
ericstjericstj
committed
System.Diagnostics docs
1 parent e9bf3ba commit 92e84fa

14 files changed

+96
-55
lines changed

‎xml/System.Diagnostics.Metrics/Measurement`1.xml‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -160,9 +160,11 @@
160160
</Parameter>
161161
</Parameters>
162162
<Docs>
163-
<param name="value">To be added.</param>
164-
<param name="tags">To be added.</param>
165-
<summary>To be added.</summary>
163+
<param name="value">The value of the measurement.</param>
164+
<param name="tags">A <see cref="T:System.Diagnostics.TagList" /> containing the <see cref="T:System.Collections.Generic.KeyValuePair`2" /> tags associated with the measurement.</param>
165+
<summary>
166+
<para>Initializes a new instance of the Measurement with the provided <paramref name="value" /> and a <see cref="T:System.Diagnostics.TagList" /> containing zero or more associated <paramref name="tags" />.</para>
167+
</summary>
166168
<remarks>To be added.</remarks>
167169
</Docs>
168170
</Member>

‎xml/System.Diagnostics.Metrics/Meter.xml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2528,7 +2528,9 @@ UpDownCounter is an Instrument which supports reporting positive or negative met
25282528
<ReturnType>System.String</ReturnType>
25292529
</ReturnValue>
25302530
<Docs>
2531-
<summary>To be added.</summary>
2531+
<summary>
2532+
<para>The optional schema URL specifies a location of a <see href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/schemas/file_format_v1.1.0.md">Schema File</see> that can be retrieved using HTTP or HTTPS protocol.</para>
2533+
</summary>
25322534
<value>To be added.</value>
25332535
<remarks>To be added.</remarks>
25342536
</Docs>

‎xml/System.Diagnostics.Metrics/MeterOptions.xml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,9 @@
146146
<ReturnType>System.String</ReturnType>
147147
</ReturnValue>
148148
<Docs>
149-
<summary>To be added.</summary>
149+
<summary>
150+
<para>The optional schema URL specifies a location of a <see href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/schemas/file_format_v1.1.0.md">Schema File</see> that can be retrieved using HTTP or HTTPS protocol.</para>
151+
</summary>
150152
<value>To be added.</value>
151153
<remarks>To be added.</remarks>
152154
</Docs>

‎xml/System.Diagnostics/Activity.xml‎

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -249,12 +249,13 @@ Callers should either restrict the number of events added to the same `Activity`
249249
<Parameter Name="timestamp" Type="System.DateTimeOffset" Index="2" FrameworkAlternate="net-10.0;net-10.0-pp;net-8.0-pp;net-9.0;net-9.0-pp;netframework-4.6.2-pp;netframework-4.7.1-pp;netframework-4.7.2-pp;netframework-4.7-pp;netframework-4.8.1-pp;netframework-4.8-pp;netstandard-2.0-pp" />
250250
</Parameters>
251251
<Docs>
252-
<param name="exception">To be added.</param>
253-
<param name="tags">To be added.</param>
254-
<param name="timestamp">To be added.</param>
255-
<summary>To be added.</summary>
256-
<returns>To be added.</returns>
257-
<remarks>To be added.</remarks>
252+
<param name="exception">The exception to add to the attached events list.</param>
253+
<param name="tags">The tags to add to the exception event.</param>
254+
<param name="timestamp">The timestamp to add to the exception event.</param>
255+
<summary>Add an <see cref="T:System.Diagnostics.ActivityEvent" /> object containing the exception information to the <see cref="P:System.Diagnostics.Activity.Events" /> list.</summary>
256+
<returns>
257+
<see langword="this" /> for convenient chaining.</returns>
258+
<remarks>&lt;para&gt;&lt;para&gt;- The name of the event will be "exception", and it will include the tags "exception.message", "exception.stacktrace", and "exception.type", in addition to the tags provided in the &lt;paramref name="tags" /&gt; parameter.&lt;/para&gt;&lt;para&gt;- Any registered &lt;see cref="T:System.Diagnostics.ActivityListener" /&gt; with the &lt;see cref="P:System.Diagnostics.ActivityListener.ExceptionRecorder" /&gt; callback will be notified about this exception addition before the &lt;see cref="T:System.Diagnostics.ActivityEvent" /&gt; object is added to the &lt;see cref="P:System.Diagnostics.Activity.Events" /&gt; list.&lt;/para&gt;&lt;para&gt;- Any registered &lt;see cref="T:System.Diagnostics.ActivityListener" /&gt; with the &lt;see cref="P:System.Diagnostics.ActivityListener.ExceptionRecorder" /&gt; callback that adds "exception.message", "exception.stacktrace", or "exception.type" tags will not have these tags overwritten, except by any subsequent &lt;see cref="T:System.Diagnostics.ActivityListener" /&gt; that explicitly overwrites them.&lt;/para&gt;</remarks>
258259
</Docs>
259260
</Member>
260261
<Member MemberName="AddLink">
@@ -277,10 +278,13 @@ Callers should either restrict the number of events added to the same `Activity`
277278
<Parameter Name="link" Type="System.Diagnostics.ActivityLink" Index="0" FrameworkAlternate="net-10.0;net-10.0-pp;net-8.0-pp;net-9.0;net-9.0-pp;netframework-4.6.2-pp;netframework-4.7.1-pp;netframework-4.7.2-pp;netframework-4.7-pp;netframework-4.8.1-pp;netframework-4.8-pp;netstandard-2.0-pp" />
278279
</Parameters>
279280
<Docs>
280-
<param name="link">To be added.</param>
281-
<summary>To be added.</summary>
282-
<returns>To be added.</returns>
283-
<remarks>To be added.</remarks>
281+
<param name="link">The <see cref="T:System.Diagnostics.ActivityLink" /> to add.</param>
282+
<summary>Add an <see cref="T:System.Diagnostics.ActivityLink" /> to the <see cref="P:System.Diagnostics.Activity.Links" /> list.</summary>
283+
<returns>
284+
<see langword="this" /> for convenient chaining.</returns>
285+
<remarks>
286+
<para>For contexts that are available during span creation, adding links at span creation is preferred to calling <see cref="M:System.Diagnostics.Activity.AddLink(System.Diagnostics.ActivityLink)" /> later, because head sampling decisions can only consider information present during span creation.</para>
287+
</remarks>
284288
</Docs>
285289
</Member>
286290
<Member MemberName="AddTag">
@@ -1236,6 +1240,7 @@ An operation name is the *coarsest* name that is useful for grouping/filtering.
12361240
<summary>Gets the parent <see cref="T:System.Diagnostics.Activity" /> that created this activity.</summary>
12371241
<value>The parent of this <see cref="T:System.Diagnostics.Activity" />, if it is from the same process, or <see langword="null" /> if this instance has no parent (it is a root activity) or if the parent is from outside the process.</value>
12381242
<remarks>To be added.</remarks>
1243+
<seealso cref="P:System.Diagnostics.Activity.ParentId" />
12391244
</Docs>
12401245
</Member>
12411246
<Member MemberName="ParentId">
@@ -1884,6 +1889,8 @@ Use <xref:System.Diagnostics.DiagnosticSource.StartActivity%2A?displayProperty=n
18841889
18851890
]]></format>
18861891
</remarks>
1892+
<seealso cref="M:System.Diagnostics.DiagnosticSource.StartActivity(System.Diagnostics.Activity,System.Object)" />
1893+
<seealso cref="M:System.Diagnostics.Activity.SetStartTime(System.DateTime)" />
18871894
</Docs>
18881895
</Member>
18891896
<Member MemberName="StartTimeUtc">
@@ -2022,6 +2029,8 @@ Call <xref:System.Diagnostics.DiagnosticSource.StopActivity%2A?displayProperty=n
20222029
20232030
]]></format>
20242031
</remarks>
2032+
<seealso cref="M:System.Diagnostics.DiagnosticSource.StopActivity(System.Diagnostics.Activity,System.Object)" />
2033+
<seealso cref="M:System.Diagnostics.Activity.SetEndTime(System.DateTime)" />
20252034
</Docs>
20262035
</Member>
20272036
<Member MemberName="TagObjects">
@@ -2091,6 +2100,7 @@ Call <xref:System.Diagnostics.DiagnosticSource.StopActivity%2A?displayProperty=n
20912100
<summary>Gets a collection of key/value pairs that represent information that will be logged along with the <see cref="T:System.Diagnostics.Activity" /> to the logging system.</summary>
20922101
<value>Information that will be logged along with the <see cref="T:System.Diagnostics.Activity" /> to the logging system.</value>
20932102
<remarks>In .NET 5 and later versions, the order of the tags in the list matches the order in which they're added to the list. In previous versions, the order is reversed, that is, the first item added is last in the list.</remarks>
2103+
<seealso cref="P:System.Diagnostics.Activity.Baggage" />
20942104
</Docs>
20952105
</Member>
20962106
<Member MemberName="TraceId">

‎xml/System.Diagnostics/ActivityListener.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@
165165
<ReturnType>System.Diagnostics.ExceptionRecorder</ReturnType>
166166
</ReturnValue>
167167
<Docs>
168-
<summary>To be added.</summary>
168+
<summary>Set or get the callback used to listen to <see cref="T:System.Diagnostics.Activity" /> events when exceptions are added.</summary>
169169
<value>To be added.</value>
170170
<remarks>To be added.</remarks>
171171
</Docs>

‎xml/System.Diagnostics/ActivitySource.xml‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@
4949
<Parameter Name="options" Type="System.Diagnostics.ActivitySourceOptions" Index="0" FrameworkAlternate="net-10.0;net-10.0-pp;net-8.0-pp;net-9.0-pp;netframework-4.6.2-pp;netframework-4.7.1-pp;netframework-4.7.2-pp;netframework-4.7-pp;netframework-4.8.1-pp;netframework-4.8-pp;netstandard-2.0-pp" />
5050
</Parameters>
5151
<Docs>
52-
<param name="options">To be added.</param>
53-
<summary>To be added.</summary>
52+
<param name="options">The <see cref="T:System.Diagnostics.ActivitySourceOptions" /> object to use for initializing the ActivitySource object.</param>
53+
<summary>Initialize a new instance of the ActivitySource object using the <see cref="T:System.Diagnostics.ActivitySourceOptions" />.</summary>
5454
<remarks>To be added.</remarks>
5555
</Docs>
5656
</Member>
@@ -71,8 +71,8 @@
7171
<Parameter Name="name" Type="System.String" Index="0" FrameworkAlternate="net-10.0;net-10.0-pp;net-8.0-pp;net-9.0;net-9.0-pp;netframework-4.6.2-pp;netframework-4.7.1-pp;netframework-4.7.2-pp;netframework-4.7-pp;netframework-4.8.1-pp;netframework-4.8-pp;netstandard-2.0-pp" />
7272
</Parameters>
7373
<Docs>
74-
<param name="name">To be added.</param>
75-
<summary>To be added.</summary>
74+
<param name="name">The name of the ActivitySource object</param>
75+
<summary>Construct an ActivitySource object with the input name</summary>
7676
<remarks>To be added.</remarks>
7777
</Docs>
7878
</Member>
@@ -148,10 +148,10 @@
148148
</Parameter>
149149
</Parameters>
150150
<Docs>
151-
<param name="name">To be added.</param>
152-
<param name="version">To be added.</param>
153-
<param name="tags">To be added.</param>
154-
<summary>To be added.</summary>
151+
<param name="name">The name of the ActivitySource object</param>
152+
<param name="version">The version of the component publishing the tracing info.</param>
153+
<param name="tags">The optional ActivitySource tags.</param>
154+
<summary>Construct an ActivitySource object with the input name</summary>
155155
<remarks>To be added.</remarks>
156156
</Docs>
157157
</Member>
@@ -672,7 +672,7 @@ If the Activity object is created, it will not start automatically. Callers need
672672
<ReturnType>System.Collections.Generic.IEnumerable&lt;System.Collections.Generic.KeyValuePair&lt;System.String,System.Object&gt;&gt;</ReturnType>
673673
</ReturnValue>
674674
<Docs>
675-
<summary>To be added.</summary>
675+
<summary>Returns the tags associated with the ActivitySource.</summary>
676676
<value>To be added.</value>
677677
<remarks>To be added.</remarks>
678678
</Docs>
@@ -699,7 +699,7 @@ If the Activity object is created, it will not start automatically. Callers need
699699
<ReturnType>System.String</ReturnType>
700700
</ReturnValue>
701701
<Docs>
702-
<summary>To be added.</summary>
702+
<summary>Returns the telemetry schema URL associated with the ActivitySource.</summary>
703703
<value>To be added.</value>
704704
<remarks>To be added.</remarks>
705705
</Docs>

‎xml/System.Diagnostics/ActivitySourceOptions.xml‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
23+
<summary>Options for creating a <see cref="T:System.Diagnostics.ActivitySource" />.</summary>
2424
<remarks>To be added.</remarks>
2525
</Docs>
2626
<Members>
@@ -40,8 +40,8 @@
4040
<Parameter Name="name" Type="System.String" />
4141
</Parameters>
4242
<Docs>
43-
<param name="name">To be added.</param>
44-
<summary>To be added.</summary>
43+
<param name="name">The name of the <see cref="T:System.Diagnostics.ActivitySourceOptions" /> object</param>
44+
<summary>Constructs a new instance of <see cref="T:System.Diagnostics.ActivitySourceOptions" />.</summary>
4545
<remarks>To be added.</remarks>
4646
</Docs>
4747
</Member>
@@ -67,7 +67,7 @@
6767
<ReturnType>System.String</ReturnType>
6868
</ReturnValue>
6969
<Docs>
70-
<summary>To be added.</summary>
70+
<summary>Get or set the <see cref="T:System.Diagnostics.ActivitySourceOptions" /> object name. Cannot be <see langword="null" />.</summary>
7171
<value>To be added.</value>
7272
<remarks>To be added.</remarks>
7373
</Docs>
@@ -94,7 +94,7 @@
9494
<ReturnType>System.Collections.Generic.IEnumerable&lt;System.Collections.Generic.KeyValuePair&lt;System.String,System.Object&gt;&gt;</ReturnType>
9595
</ReturnValue>
9696
<Docs>
97-
<summary>To be added.</summary>
97+
<summary>The optional list of key-value pair tags associated with the <see cref="T:System.Diagnostics.ActivitySourceOptions" />.</summary>
9898
<value>To be added.</value>
9999
<remarks>To be added.</remarks>
100100
</Docs>
@@ -115,7 +115,9 @@
115115
<ReturnType>System.String</ReturnType>
116116
</ReturnValue>
117117
<Docs>
118-
<summary>To be added.</summary>
118+
<summary>
119+
<para>The optional schema URL specifies a location of a <see href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/schemas/file_format_v1.1.0.md">Schema File</see> that can be retrieved using HTTP or HTTPS protocol.</para>
120+
</summary>
119121
<value>To be added.</value>
120122
<remarks>To be added.</remarks>
121123
</Docs>
@@ -136,7 +138,7 @@
136138
<ReturnType>System.String</ReturnType>
137139
</ReturnValue>
138140
<Docs>
139-
<summary>To be added.</summary>
141+
<summary>The optional <see cref="T:System.Diagnostics.ActivitySourceOptions" /> version. Defaulted to empty string.</summary>
140142
<value>To be added.</value>
141143
<remarks>To be added.</remarks>
142144
</Docs>

‎xml/System.Diagnostics/DiagnosticSource.xml‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,7 @@ If there is expensive setup for the notification, you can call this method and p
156156
157157
]]></format>
158158
</remarks>
159+
<seealso cref="M:System.Diagnostics.DiagnosticSource.IsEnabled(System.String)" />
159160
</Docs>
160161
</Member>
161162
<Member MemberName="OnActivityExport">
@@ -331,6 +332,7 @@ Producers may pass additional details to the consumer in the payload.
331332
332333
]]></format>
333334
</remarks>
335+
<seealso cref="T:System.Diagnostics.Activity" />
334336
</Docs>
335337
</Member>
336338
<Member MemberName="StartActivity&lt;T&gt;">
@@ -375,12 +377,13 @@ Producers may pass additional details to the consumer in the payload.
375377
<Parameter Name="args" Type="T" Index="1" FrameworkAlternate="net-10.0;net-10.0-pp;net-8.0;net-8.0-pp;net-9.0;net-9.0-pp;netframework-4.6.2-pp;netframework-4.7.1-pp;netframework-4.7.2-pp;netframework-4.7-pp;netframework-4.8.1-pp;netframework-4.8-pp;netstandard-2.0-pp" />
376378
</Parameters>
377379
<Docs>
378-
<typeparam name="T">To be added.</typeparam>
380+
<typeparam name="T">The type of the value being passed as a payload for the event.</typeparam>
379381
<param name="activity">To be added.</param>
380382
<param name="args">To be added.</param>
381383
<summary>To be added.</summary>
382384
<returns>To be added.</returns>
383385
<remarks>To be added.</remarks>
386+
<inheritdoc cref="M:System.Diagnostics.DiagnosticSource.StartActivity(System.Diagnostics.Activity,System.Object)" />
384387
</Docs>
385388
</Member>
386389
<Member MemberName="StopActivity">
@@ -445,6 +448,7 @@ Consumers can access <xref:System.Diagnostics.Activity.Current?displayProperty=n
445448
446449
]]></format>
447450
</remarks>
451+
<seealso cref="T:System.Diagnostics.Activity" />
448452
</Docs>
449453
</Member>
450454
<Member MemberName="StopActivity&lt;T&gt;">
@@ -489,11 +493,12 @@ Consumers can access <xref:System.Diagnostics.Activity.Current?displayProperty=n
489493
<Parameter Name="args" Type="T" Index="1" FrameworkAlternate="net-10.0;net-10.0-pp;net-8.0;net-8.0-pp;net-9.0;net-9.0-pp;netframework-4.6.2-pp;netframework-4.7.1-pp;netframework-4.7.2-pp;netframework-4.7-pp;netframework-4.8.1-pp;netframework-4.8-pp;netstandard-2.0-pp" />
490494
</Parameters>
491495
<Docs>
492-
<typeparam name="T">To be added.</typeparam>
496+
<typeparam name="T">The type of the value being passed as a payload for the event.</typeparam>
493497
<param name="activity">To be added.</param>
494498
<param name="args">To be added.</param>
495499
<summary>To be added.</summary>
496500
<remarks>To be added.</remarks>
501+
<inheritdoc cref="M:System.Diagnostics.DiagnosticSource.StartActivity(System.Diagnostics.Activity,System.Object)" />
497502
</Docs>
498503
</Member>
499504
<Member MemberName="Write">
@@ -606,11 +611,12 @@ Assume that listeners will use string prefixing to filter groups. Therefore, hav
606611
<Parameter Name="value" Type="T" Index="1" FrameworkAlternate="net-10.0;net-10.0-pp;net-8.0;net-8.0-pp;net-9.0;net-9.0-pp;netframework-4.6.2-pp;netframework-4.7.1-pp;netframework-4.7.2-pp;netframework-4.7-pp;netframework-4.8.1-pp;netframework-4.8-pp;netstandard-2.0-pp" />
607612
</Parameters>
608613
<Docs>
609-
<typeparam name="T">To be added.</typeparam>
614+
<typeparam name="T">The type of the value being passed as a payload for the event.</typeparam>
610615
<param name="name">To be added.</param>
611616
<param name="value">To be added.</param>
612617
<summary>To be added.</summary>
613618
<remarks>To be added.</remarks>
619+
<inheritdoc cref="M:System.Diagnostics.DiagnosticSource.Write(System.String,System.Object)" />
614620
</Docs>
615621
</Member>
616622
</Members>

‎xml/System.Diagnostics/DistributedContextPropagator.xml‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,9 +157,14 @@
157157
</ReturnValue>
158158
<Parameters />
159159
<Docs>
160-
<summary>To be added.</summary>
160+
<summary>Returns a propagator that encodes and decodes distributed context and baggage information in a backward-compatible manner.</summary>
161161
<returns>To be added.</returns>
162-
<remarks>To be added.</remarks>
162+
<remarks>
163+
<para>This propagator is not fully compliant with the W3C specification.</para>
164+
<para>It inserts baggage using the "Correlation-Context" header instead of "baggage".</para>
165+
<para>It also takes a more relaxed approach to handling trace state and baggage key-value pairs, allowing characters that are not permitted by the W3C specification.</para>
166+
<para>Additionally, this propagator supports injecting values from Activity objects that use the ActivityIdFormat.Hierarchical format, which is not supported by the W3C specification.</para>
167+
</remarks>
163168
</Docs>
164169
</Member>
165170
<Member MemberName="CreateW3CPropagator">
@@ -179,7 +184,7 @@
179184
</ReturnValue>
180185
<Parameters />
181186
<Docs>
182-
<summary>To be added.</summary>
187+
<summary>Returns a propagator that encodes and decodes distributed context information in accordance with the W3C Trace Context and Baggage specifications.</summary>
183188
<returns>To be added.</returns>
184189
<remarks>To be added.</remarks>
185190
</Docs>

‎xml/System.Diagnostics/ExceptionRecorder.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
<param name="activity">To be added.</param>
2626
<param name="exception">To be added.</param>
2727
<param name="tags">To be added.</param>
28-
<summary>To be added.</summary>
28+
<summary>Define the callback to be used in <see cref="T:System.Diagnostics.ActivityListener" /> to receive notifications when exceptions are added to the <see cref="T:System.Diagnostics.Activity" />.</summary>
2929
<remarks>To be added.</remarks>
3030
</Docs>
3131
</Type>

0 commit comments

Comments
 (0)