Skip to content

Commit 2c90133

Browse files
gewarrengewarren
authored
Add see also links to conceptual docs (#7510)
1 parent 73fc474 commit 2c90133

File tree

10 files changed

+38
-42
lines changed

10 files changed

+38
-42
lines changed

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

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,17 @@
2727
<Interfaces />
2828
<Docs>
2929
<typeparam name="T">The type that the counter represents.</typeparam>
30-
<summary>Represents an instrument that supports adding non-negative values. For example, you might call counter.Add(1) each time a request is processed to track the total number of requests. Most metric viewers display counters using a rate (requests/sec), by default, but can also display a cumulative total.</summary>
30+
<summary>Represents an instrument that supports adding non-negative values. For example, you might call <c>counter.Add(1)</c> each time a request is processed to track the total number of requests. Most metric viewers display counters using a rate (requests/sec), by default, but can also display a cumulative total.</summary>
3131
<remarks>
3232
<format type="text/markdown"><![CDATA[
3333
3434
## Remarks
3535
36-
This class supports only the following generic parameter types: <xref:System.Byte>, <xref:System.Int16>, <xref:System.Int32>, <xref:System.Int64>, <xref:System.Single>, <xref:System.Double>, and <xref:System.Decimal>
36+
This class supports only the following generic parameter types: <xref:System.Byte>, <xref:System.Int16>, <xref:System.Int32>, <xref:System.Int64>, <xref:System.Single>, <xref:System.Double>, and <xref:System.Decimal>.
3737
3838
]]></format>
3939
</remarks>
40+
<related type="Article" href="/dotnet/core/diagnostics/metrics-instrumentation">Creating metrics</related>
4041
</Docs>
4142
<Members>
4243
<Member MemberName="Add">
@@ -59,7 +60,7 @@ This class supports only the following generic parameter types: <xref:System.Byt
5960
</Parameters>
6061
<Docs>
6162
<param name="delta">The increment measurement.</param>
62-
<summary>Record the increment value of the measurement.</summary>
63+
<summary>Records the increment value of the measurement.</summary>
6364
<remarks>To be added.</remarks>
6465
</Docs>
6566
</Member>
@@ -85,7 +86,7 @@ This class supports only the following generic parameter types: <xref:System.Byt
8586
<Docs>
8687
<param name="delta">The increment measurement.</param>
8788
<param name="tag">A key-value pair tag associated with the measurement.</param>
88-
<summary>Record the increment value of the measurement.</summary>
89+
<summary>Records the increment value of the measurement.</summary>
8990
<remarks>To be added.</remarks>
9091
</Docs>
9192
</Member>
@@ -118,7 +119,7 @@ This class supports only the following generic parameter types: <xref:System.Byt
118119
<Docs>
119120
<param name="delta">The increment measurement.</param>
120121
<param name="tags">A list of key-value pair tags associated with the measurement.</param>
121-
<summary>Record the increment value of the measurement.</summary>
122+
<summary>Records the increment value of the measurement.</summary>
122123
<remarks>To be added.</remarks>
123124
</Docs>
124125
</Member>
@@ -177,7 +178,7 @@ This class supports only the following generic parameter types: <xref:System.Byt
177178
<Docs>
178179
<param name="delta">The increment measurement.</param>
179180
<param name="tags">A span of key-value pair tags associated with the measurement.</param>
180-
<summary>Record the increment value of the measurement.</summary>
181+
<summary>Records the increment value of the measurement.</summary>
181182
<remarks>To be added.</remarks>
182183
</Docs>
183184
</Member>
@@ -205,7 +206,7 @@ This class supports only the following generic parameter types: <xref:System.Byt
205206
<param name="delta">The increment measurement.</param>
206207
<param name="tag1">A first key-value pair tag associated with the measurement.</param>
207208
<param name="tag2">A second key-value pair tag associated with the measurement.</param>
208-
<summary>Record the increment value of the measurement.</summary>
209+
<summary>Records the increment value of the measurement.</summary>
209210
<remarks>To be added.</remarks>
210211
</Docs>
211212
</Member>
@@ -235,7 +236,7 @@ This class supports only the following generic parameter types: <xref:System.Byt
235236
<param name="tag1">A first key-value pair tag associated with the measurement.</param>
236237
<param name="tag2">A second key-value pair tag associated with the measurement.</param>
237238
<param name="tag3">A third key-value pair tag associated with the measurement.</param>
238-
<summary>Record the increment value of the measurement.</summary>
239+
<summary>Records the increment value of the measurement.</summary>
239240
<remarks>To be added.</remarks>
240241
</Docs>
241242
</Member>

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

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,17 @@
2727
<Interfaces />
2828
<Docs>
2929
<typeparam name="T">The type that the histogram represents.</typeparam>
30-
<summary>Represents a metrics Instrument that can be used to report arbitrary values that are likely to be statistically meaningful.
31-
e.g. the request duration.
32-
Use <see cref="M:System.Diagnostics.Metrics.Meter.CreateHistogram``1(System.String,System.String,System.String)" /> method to create the Histogram object.</summary>
30+
<summary>Represents a metrics instrument that can be used to report arbitrary values that are likely to be statistically meaningful, for example, the request duration. Call <see cref="M:System.Diagnostics.Metrics.Meter.CreateHistogram``1(System.String,System.String,System.String)" /> to create a Histogram object.</summary>
3331
<remarks>
3432
<format type="text/markdown"><![CDATA[
3533
3634
## Remarks
3735
38-
This class supports only the following generic parameter types: <xref:System.Byte>, <xref:System.Int16>, <xref:System.Int32>, <xref:System.Int64>, <xref:System.Single>, <xref:System.Double>, and <xref:System.Decimal>
36+
This class supports only the following generic parameter types: <xref:System.Byte>, <xref:System.Int16>, <xref:System.Int32>, <xref:System.Int64>, <xref:System.Single>, <xref:System.Double>, and <xref:System.Decimal>.
3937
4038
]]></format>
4139
</remarks>
40+
<related type="Article" href="/dotnet/core/diagnostics/metrics-instrumentation">Creating metrics</related>
4241
</Docs>
4342
<Members>
4443
<Member MemberName="Record">
@@ -61,7 +60,7 @@ This class supports only the following generic parameter types: <xref:System.Byt
6160
</Parameters>
6261
<Docs>
6362
<param name="value">The measurement value.</param>
64-
<summary>Record a measurement value.</summary>
63+
<summary>Records a measurement value.</summary>
6564
<remarks>To be added.</remarks>
6665
</Docs>
6766
</Member>
@@ -87,7 +86,7 @@ This class supports only the following generic parameter types: <xref:System.Byt
8786
<Docs>
8887
<param name="value">The measurement value.</param>
8988
<param name="tag">A key-value pair tag associated with the measurement.</param>
90-
<summary>Record a measurement value.</summary>
89+
<summary>Records a measurement value.</summary>
9190
<remarks>To be added.</remarks>
9291
</Docs>
9392
</Member>
@@ -120,7 +119,7 @@ This class supports only the following generic parameter types: <xref:System.Byt
120119
<Docs>
121120
<param name="value">The measurement value.</param>
122121
<param name="tags">A list of key-value pair tags associated with the measurement.</param>
123-
<summary>Record a measurement value.</summary>
122+
<summary>Records a measurement value.</summary>
124123
<remarks>To be added.</remarks>
125124
</Docs>
126125
</Member>
@@ -179,7 +178,7 @@ This class supports only the following generic parameter types: <xref:System.Byt
179178
<Docs>
180179
<param name="value">The measurement value.</param>
181180
<param name="tags">A span of key-value pair tags associated with the measurement.</param>
182-
<summary>Record a measurement value.</summary>
181+
<summary>Records a measurement value.</summary>
183182
<remarks>To be added.</remarks>
184183
</Docs>
185184
</Member>
@@ -207,7 +206,7 @@ This class supports only the following generic parameter types: <xref:System.Byt
207206
<param name="value">The measurement value.</param>
208207
<param name="tag1">A first key-value pair tag associated with the measurement.</param>
209208
<param name="tag2">A second key-value pair tag associated with the measurement.</param>
210-
<summary>Record a measurement value.</summary>
209+
<summary>Records a measurement value.</summary>
211210
<remarks>To be added.</remarks>
212211
</Docs>
213212
</Member>
@@ -237,7 +236,7 @@ This class supports only the following generic parameter types: <xref:System.Byt
237236
<param name="tag1">A first key-value pair tag associated with the measurement.</param>
238237
<param name="tag2">A second key-value pair tag associated with the measurement.</param>
239238
<param name="tag3">A third key-value pair tag associated with the measurement.</param>
240-
<summary>Record a measurement value.</summary>
239+
<summary>Records a measurement value.</summary>
241240
<remarks>To be added.</remarks>
242241
</Docs>
243242
</Member>

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
<Docs>
2121
<summary>Meter is the class responsible for creating and tracking the Instruments.</summary>
2222
<remarks>To be added.</remarks>
23+
<related type="Article" href="/dotnet/core/diagnostics/metrics-instrumentation">Tutorial: Create metrics</related>
2324
</Docs>
2425
<Members>
2526
<Member MemberName=".ctor">

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,17 @@
2727
<Interfaces />
2828
<Docs>
2929
<typeparam name="T">The type that the observable counter represents.</typeparam>
30-
<summary>ObservableCounter is a metrics observable Instrument which reports monotonically increasing value(s) when the instrument is being observed.
31-
e.g. CPU time (for different processes, threads, user mode or kernel mode).
32-
Use Meter.CreateObservableCounter methods to create the observable counter object.</summary>
30+
<summary>Represents a metrics-observable instrument that reports monotonically increasing values when the instrument is being observed, for example, CPU time (for different processes, threads, user mode, or kernel mode). Call <see cref="Overload:System.Diagnostics.Metrics.Meter.CreateObservableCounter" /> to create the observable counter object.</summary>
3331
<remarks>
3432
<format type="text/markdown"><![CDATA[
3533
3634
## Remarks
3735
38-
This class supports only the following generic parameter types: <xref:System.Byte>, <xref:System.Int16>, <xref:System.Int32>, <xref:System.Int64>, <xref:System.Single>, <xref:System.Double>, and <xref:System.Decimal>
36+
This class supports only the following generic parameter types: <xref:System.Byte>, <xref:System.Int16>, <xref:System.Int32>, <xref:System.Int64>, <xref:System.Single>, <xref:System.Double>, and <xref:System.Decimal>.
3937
4038
]]></format>
4139
</remarks>
40+
<related type="Article" href="/dotnet/core/diagnostics/metrics-instrumentation">Creating metrics</related>
4241
</Docs>
4342
<Members>
4443
<Member MemberName="Observe">

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,17 @@
2727
<Interfaces />
2828
<Docs>
2929
<typeparam name="T">To be added.</typeparam>
30-
<summary>ObservableGauge is an observable Instrument that reports non-additive value(s) when the instrument is being observed.
31-
e.g. the current room temperature Use Meter.CreateObservableGauge methods to create the observable counter object.</summary>
30+
<summary>Represents an observable instrument that reports non-additive values when the instrument is being observed, for example, the current room temperature. Call <see cref="Overload:System.Diagnostics.Metrics.Meter.CreateObservableGauge" /> to create the observable counter object.</summary>
3231
<remarks>
3332
<format type="text/markdown"><![CDATA[
3433
3534
## Remarks
3635
37-
This class supports only the following generic parameter types: <xref:System.Byte>, <xref:System.Int16>, <xref:System.Int32>, <xref:System.Int64>, <xref:System.Single>, <xref:System.Double>, and <xref:System.Decimal>
36+
This class supports only the following generic parameter types: <xref:System.Byte>, <xref:System.Int16>, <xref:System.Int32>, <xref:System.Int64>, <xref:System.Single>, <xref:System.Double>, and <xref:System.Decimal>.
3837
3938
]]></format>
4039
</remarks>
40+
<related type="Article" href="/dotnet/core/diagnostics/metrics-instrumentation">Creating metrics</related>
4141
</Docs>
4242
<Members>
4343
<Member MemberName="Observe">
@@ -57,8 +57,8 @@ This class supports only the following generic parameter types: <xref:System.Byt
5757
</ReturnValue>
5858
<Parameters />
5959
<Docs>
60-
<summary>Observe() fetches the current measurements being tracked by this observable counter.</summary>
61-
<returns>To be added.</returns>
60+
<summary>Fetches the current measurements being tracked by this observable counter.</summary>
61+
<returns>An enumeration of measurements of type `<typeparamref name="T"/>` that are being tracked by this observable counter.</returns>
6262
<remarks>To be added.</remarks>
6363
</Docs>
6464
</Member>

‎xml/System.Diagnostics.Tracing/EventCounter.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ For an example of how to use the <xref:System.Diagnostics.Tracing.EventCounter>
6868
6969
]]></format>
7070
</remarks>
71+
<related type="Article" href="/dotnet/core/diagnostics/event-counters">EventCounters in .NET</related>
7172
</Docs>
7273
<Members>
7374
<Member MemberName=".ctor">

‎xml/System.Diagnostics.Tracing/IncrementingEventCounter.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343
4444
]]></format>
4545
</remarks>
46+
<related type="Article" href="/dotnet/core/diagnostics/event-counters">EventCounters in .NET</related>
4647
</Docs>
4748
<Members>
4849
<Member MemberName=".ctor">

‎xml/System.Diagnostics.Tracing/IncrementingPollingCounter.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ For an example that uses <xref:System.Diagnostics.Tracing.IncrementingPollingCou
4747
4848
]]></format>
4949
</remarks>
50+
<related type="Article" href="/dotnet/core/diagnostics/event-counters">EventCounters in .NET</related>
5051
</Docs>
5152
<Members>
5253
<Member MemberName=".ctor">

‎xml/System.Diagnostics.Tracing/PollingCounter.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ For an example that uses <xref:System.Diagnostics.Tracing.PollingCounter> inside
4747
4848
]]></format>
4949
</remarks>
50+
<related type="Article" href="/dotnet/core/diagnostics/event-counters">EventCounters in .NET</related>
5051
</Docs>
5152
<Members>
5253
<Member MemberName=".ctor">

0 commit comments

Comments
 (0)