System.Diagnostics.Meter API documentation

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

@@ -26,8 +26,8 @@
   </Base>
   <Interfaces />
   <Docs>
-    <typeparam name="T">To be added.</typeparam>
-    <summary>The counter is 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 will display counters using a rate by default (requests/sec) but can also display a cumulative total.</summary>
+    <typeparam name="T">The type that the counter represents.</typeparam>
+    <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>
     <remarks>
       <format type="text/markdown"><![CDATA[
 

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

@@ -26,8 +26,8 @@
   </Base>
   <Interfaces />
   <Docs>
-    <typeparam name="T">To be added.</typeparam>
-    <summary>The histogram is a metrics Instrument which can be used to report arbitrary values that are likely to be statistically meaningful.
+    <typeparam name="T">The type that the histogram represents.</typeparam>
+    <summary>Represents a metrics Instrument that can be used to report arbitrary values that are likely to be statistically meaningful.
             e.g. the request duration.
             Use <see cref="M:System.Diagnostics.Metrics.Meter.CreateHistogram``1(System.String,System.String,System.String)" /> method to create the Histogram object.</summary>
     <remarks>

xml/System.Diagnostics.Metrics/Instrument`1.xml

@@ -23,8 +23,8 @@
   </Base>
   <Interfaces />
   <Docs>
-    <typeparam name="T">To be added.</typeparam>
-    <summary>Instrument{T} is the base class for all non-observable instruments.</summary>
+    <typeparam name="T">The type that the instrument represents.</typeparam>
+    <summary>The base class for all non-observable instruments.</summary>
     <remarks>
       <format type="text/markdown"><![CDATA[
 

xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml

@@ -25,11 +25,11 @@
     <ReturnType>System.Void</ReturnType>
   </ReturnValue>
   <Docs>
-    <typeparam name="T">To be added.</typeparam>
-    <param name="instrument">To be added.</param>
-    <param name="measurement">To be added.</param>
-    <param name="tags">To be added.</param>
-    <param name="state">To be added.</param>
+    <typeparam name="T">The type that the measurement represents.</typeparam>
+    <param name="instrument">The <see cref="T:System.Diagnostics.Metrics.Instrument" /> that was responsible for sending the measurement.</param>
+    <param name="measurement">The measurement value.</param>
+    <param name="tags">A span of key-value pair tags associated with the measurement.</param>
+    <param name="state">The state object originally passed to <see cref="M:System.Diagnostics.Metrics.MeterListener.EnableMeasurementEvents(System.Diagnostics.Metrics.Instrument,System.Object)" /> method.</param>
     <summary>A delegate to represent the Meterlistener callbacks used in measurements recording operation.</summary>
     <remarks>To be added.</remarks>
   </Docs>

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

@@ -29,8 +29,8 @@
     </Attribute>
   </Attributes>
   <Docs>
-    <typeparam name="T">To be added.</typeparam>
-    <summary>Measurement stores one observed metrics value and its associated tags. This type is used by Observable instruments' Observe() method when reporting current measurements.
+    <typeparam name="T">The type that the measurement represents.</typeparam>
+    <summary>Stores one observed metrics value and its associated tags. This type is used by an Observable instrument's Observe() method when reporting current measurements.
             with the associated tags.</summary>
     <remarks>To be added.</remarks>
   </Docs>

xml/System.Diagnostics.Metrics/Meter.xml

@@ -95,12 +95,12 @@
         <Parameter Name="description" Type="System.String" />
       </Parameters>
       <Docs>
-        <typeparam name="T">To be added.</typeparam>
+        <typeparam name="T">The numerical type of the measurement.</typeparam>
         <param name="name">The instrument name. cannot be <see langword="null" />.</param>
         <param name="unit">Optional instrument unit of measurements.</param>
         <param name="description">Optional instrument description.</param>
         <summary>Create a metrics Counter object.</summary>
-        <returns>To be added.</returns>
+        <returns>A new counter.</returns>
         <remarks>
           <format type="text/markdown"><![CDATA[
 
@@ -142,12 +142,12 @@ Counter is an Instrument which supports non-negative increments.
         <Parameter Name="description" Type="System.String" />
       </Parameters>
       <Docs>
-        <typeparam name="T">To be added.</typeparam>
+        <typeparam name="T">The numerical type of the measurement.</typeparam>
         <param name="name">The instrument name. cannot be <see langword="null" />.</param>
         <param name="unit">Optional instrument unit of measurements.</param>
         <param name="description">Optional instrument description.</param>
-        <summary>Histogram is an Instrument which can be used to report arbitrary values that are likely to be statistically meaningful. It is intended for statistics such as histograms, summaries, and percentile.</summary>
-        <returns>To be added.</returns>
+        <summary>Creates a Histogram, which is an instrument that can be used to report arbitrary values that are likely to be statistically meaningful. It is intended for statistics such as histograms, summaries, and percentile.</summary>
+        <returns>A new histogram.</returns>
         <remarks>
           <format type="text/markdown"><![CDATA[
 
@@ -189,13 +189,13 @@ Example uses for Histogram: the request duration and the size of the response pa
         <Parameter Name="description" Type="System.String" />
       </Parameters>
       <Docs>
-        <typeparam name="T">To be added.</typeparam>
+        <typeparam name="T">The numerical type of the measurement.</typeparam>
         <param name="name">The instrument name. cannot be <see langword="null" />.</param>
         <param name="observeValues">The callback to call to get the measurements when the <see cref="M:System.Diagnostics.Metrics.ObservableCounter`1.Observe" /> is called by <see cref="M:System.Diagnostics.Metrics.MeterListener.RecordObservableInstruments" />.</param>
         <param name="unit">Optional instrument unit of measurements.</param>
         <param name="description">Optional instrument description.</param>
-        <summary>ObservableCounter is an Instrument which reports monotonically increasing value(s) when the instrument is being observed.</summary>
-        <returns>To be added.</returns>
+        <summary>Creates an ObservableCounter, which is an instrument that reports monotonically increasing values when the instrument is being observed.</summary>
+        <returns>A new observable counter.</returns>
         <remarks>
           <format type="text/markdown"><![CDATA[
 
@@ -237,13 +237,13 @@ Example uses for ObservableCounter: The number of page faults for each process.
         <Parameter Name="description" Type="System.String" />
       </Parameters>
       <Docs>
-        <typeparam name="T">To be added.</typeparam>
+        <typeparam name="T">The numerical type of the measurement.</typeparam>
         <param name="name">The instrument name. cannot be <see langword="null" />.</param>
         <param name="observeValue">The callback to call to get the measurements when the <see cref="M:System.Diagnostics.Metrics.ObservableCounter`1.Observe" /> is called by <see cref="M:System.Diagnostics.Metrics.MeterListener.RecordObservableInstruments" /></param>
         <param name="unit">Optional instrument unit of measurements.</param>
         <param name="description">Optional instrument description.</param>
-        <summary>ObservableCounter is an Instrument which reports monotonically increasing value(s) when the instrument is being observed.</summary>
-        <returns>To be added.</returns>
+        <summary>Creates an ObservableCounter, which is an instrument that reports monotonically increasing values when the instrument is being observed.</summary>
+        <returns>A new observable counter.</returns>
         <remarks>
           <format type="text/markdown"><![CDATA[
 
@@ -285,13 +285,13 @@ Example uses for ObservableCounter: The number of page faults for each process.
         <Parameter Name="description" Type="System.String" />
       </Parameters>
       <Docs>
-        <typeparam name="T">To be added.</typeparam>
+        <typeparam name="T">The numerical type of the measurement..</typeparam>
         <param name="name">The instrument name. cannot be <see langword="null" />.</param>
         <param name="observeValue">The callback to call to get the measurements when the <see cref="M:System.Diagnostics.Metrics.ObservableCounter`1.Observe" /> is called by <see cref="M:System.Diagnostics.Metrics.MeterListener.RecordObservableInstruments" />.</param>
         <param name="unit">Optional instrument unit of measurements.</param>
         <param name="description">Optional instrument description.</param>
-        <summary>ObservableCounter is an Instrument which reports monotonically increasing value(s) when the instrument is being observed.</summary>
-        <returns>To be added.</returns>
+        <summary>Creates an ObservableCounter, which is an instrument that reports monotonically increasing values when the instrument is being observed.</summary>
+        <returns>A new observable counter.</returns>
         <remarks>
           <format type="text/markdown"><![CDATA[
 
@@ -333,13 +333,13 @@ Example uses for ObservableCounter: The number of page faults for each process.
         <Parameter Name="description" Type="System.String" />
       </Parameters>
       <Docs>
-        <typeparam name="T">To be added.</typeparam>
+        <typeparam name="T">The numerical type of the measurement.</typeparam>
         <param name="name">The instrument name. cannot be <see langword="null" />.</param>
         <param name="observeValues">The callback to call to get the measurements when the <see cref="M:System.Diagnostics.Metrics.ObservableCounter`1.Observe" /> is called by <see cref="M:System.Diagnostics.Metrics.MeterListener.RecordObservableInstruments" />.</param>
         <param name="unit">Optional instrument unit of measurements.</param>
         <param name="description">Optional instrument description.</param>
-        <summary>ObservableGauge is an asynchronous Instrument which reports non-additive value(s) (e.g. the room temperature - it makes no sense to report the temperature value from multiple rooms and sum them up) when the instrument is being observed.</summary>
-        <returns>To be added.</returns>
+        <summary>Creates an ObservableGauge, which is an asynchronous instrument that reports non-additive values when the instrument is being observed. An example of a non-additive value is the room temperature - it makes no sense to report the temperature value from multiple rooms and sum them up.</summary>
+        <returns>A new observable gauge.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -373,13 +373,13 @@ Example uses for ObservableCounter: The number of page faults for each process.
         <Parameter Name="description" Type="System.String" />
       </Parameters>
       <Docs>
-        <typeparam name="T">To be added.</typeparam>
+        <typeparam name="T">The numerical type of the measurement.</typeparam>
         <param name="name">The instrument name. cannot be <see langword="null" />.</param>
         <param name="observeValue">The callback to call to get the measurements when the <see cref="M:System.Diagnostics.Metrics.ObservableCounter`1.Observe" /> is called by <see cref="M:System.Diagnostics.Metrics.MeterListener.RecordObservableInstruments" />.</param>
         <param name="unit">Optional instrument unit of measurements.</param>
         <param name="description">Optional instrument description.</param>
-        <summary>ObservableGauge is an asynchronous Instrument which reports non-additive value(s) (e.g. the room temperature - it makes no sense to report the temperature value from multiple rooms and sum them up) when the instrument is being observed.</summary>
-        <returns>To be added.</returns>
+        <summary>Creates an ObservableGauge, which is an asynchronous instrument that reports non-additive values when the instrument is being observed. An example of a non-additive value is the room temperature - it makes no sense to report the temperature value from multiple rooms and sum them up.</summary>
+        <returns>A new observable gauge.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -413,13 +413,13 @@ Example uses for ObservableCounter: The number of page faults for each process.
         <Parameter Name="description" Type="System.String" />
       </Parameters>
       <Docs>
-        <typeparam name="T">To be added.</typeparam>
+        <typeparam name="T">The numerical type of the measurement.</typeparam>
         <param name="name">The instrument name. cannot be <see langword="null" />.</param>
         <param name="observeValue">The callback to call to get the measurements when the <see cref="M:System.Diagnostics.Metrics.ObservableCounter`1.Observe" /> is called by <see cref="M:System.Diagnostics.Metrics.MeterListener.RecordObservableInstruments" />.</param>
         <param name="unit">Optional instrument unit of measurements.</param>
         <param name="description">Optional instrument description.</param>
-        <summary>ObservableGauge is an asynchronous Instrument which reports non-additive value(s) (e.g. the room temperature - it makes no sense to report the temperature value from multiple rooms and sum them up) when the instrument is being observed.</summary>
-        <returns>To be added.</returns>
+        <summary>Creates an ObservableGauge, which is an asynchronous instrument that reports non-additive values when the instrument is being observed. An example of a non-additive value is the room temperature - it makes no sense to report the temperature value from multiple rooms and sum them up.</summary>
+        <returns>A new observable gauge.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -463,8 +463,8 @@ Example uses for ObservableCounter: The number of page faults for each process.
         <ReturnType>System.String</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>Returns the Meter name.</summary>
-        <value>To be added.</value>
+        <summary>Gets the Meter name.</summary>
+        <value>The Meter name</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -484,8 +484,8 @@ Example uses for ObservableCounter: The number of page faults for each process.
         <ReturnType>System.String</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>Returns the Meter Version.</summary>
-        <value>To be added.</value>
+        <summary>Gets the Meter version.</summary>
+        <value>The Meter version.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

xml/System.Diagnostics.Metrics/MeterListener.xml

@@ -129,8 +129,8 @@
         <ReturnType>System.Action&lt;System.Diagnostics.Metrics.Instrument,System.Diagnostics.Metrics.MeterListener&gt;</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>Callbacks to get notification when an instrument is published.</summary>
-        <value>To be added.</value>
+        <summary>Gets or sets the callback to get notified when an instrument is published.</summary>
+        <value>The callback to get notified when an instrument is published.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -150,9 +150,9 @@
         <ReturnType>System.Action&lt;System.Diagnostics.Metrics.Instrument,System.Object&gt;</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>Callbacks to get notification when stopping the measurement on some instrument.
+        <summary>Gets or sets the callback to get notified when the measurement is stopped on some instrument.
             This can happen when the Meter or the Listener is disposed or calling <see cref="M:System.Diagnostics.Metrics.MeterListener.Dispose" /> on the listener.</summary>
-        <value>To be added.</value>
+        <value>The callback to get notified when the measurement is stopped on some instrument.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -205,7 +205,7 @@
         <Parameter Name="measurementCallback" Type="System.Diagnostics.Metrics.MeasurementCallback&lt;T&gt;" />
       </Parameters>
       <Docs>
-        <typeparam name="T">To be added.</typeparam>
+        <typeparam name="T">The type of the numeric measurement.</typeparam>
         <param name="measurementCallback">The callback which can be used to get measurement recording of numeric type T.</param>
         <summary>Sets a callback for a specific numeric type to get the measurement recording notification from all instruments which enabled listening and was created with the same specified numeric type.
             If a measurement of type T is recorded and a callback of type T is registered, that callback will be used.</summary>

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

@@ -26,7 +26,7 @@
   </Base>
   <Interfaces />
   <Docs>
-    <typeparam name="T">To be added.</typeparam>
+    <typeparam name="T">The type that the observable counter represents.</typeparam>
     <summary>ObservableCounter is a metrics observable Instrument which reports monotonically increasing value(s) when the instrument is being observed.
             e.g. CPU time (for different processes, threads, user mode or kernel mode).
             Use Meter.CreateObservableCounter methods to create the observable counter object.</summary>
@@ -58,8 +58,8 @@ This class supports only the following generic parameter types: <xref:System.Byt
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>Observe() fetches the current measurements being tracked by this observable counter.</summary>
-        <returns>To be added.</returns>
+        <summary>Fetches the current measurements being tracked by this observable counter.</summary>
+        <returns>The current measurements being tracked by this observable counter.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml

@@ -23,7 +23,7 @@
   </Base>
   <Interfaces />
   <Docs>
-    <typeparam name="T">To be added.</typeparam>
+    <typeparam name="T">The type that the observable instrument represents.</typeparam>
     <summary>ObservableInstrument{T} is the base class from which all metrics observable instruments will inherit from.</summary>
     <remarks>
       <format type="text/markdown"><![CDATA[
@@ -80,8 +80,9 @@ This class supports only the following generic parameter types: <xref:System.Byt
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>A property tells if the instrument is an observable instrument. This property will return <see langword="true" /> for all metrics observable instruments.</summary>
-        <value>To be added.</value>
+        <summary>Gets a value that indicates if the instrument is an observable instrument.</summary>
+        <value>
+          <see langword="true" /> if the instrument is metrics-observable; <see langword="false"/> otherwise.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -102,8 +103,8 @@ This class supports only the following generic parameter types: <xref:System.Byt
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>Observe() fetches the current measurements being tracked by this instrument. All classes extending ObservableInstrument{T} need to implement this method.</summary>
-        <returns>To be added.</returns>
+        <summary>Fetches the current measurements being tracked by this instrument. All classes extending ObservableInstrument{T} need to implement this method.</summary>
+        <returns>The current measurements tracked by this instrument.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>