From 48c55970692986d563297365dff20d59c635c70d Mon Sep 17 00:00:00 2001 From: Tom McDonald Date: Mon, 13 Sep 2021 18:05:44 -0700 Subject: [PATCH 01/17] System.Diagnostics.Meter API documentation --- xml/System.Diagnostics.Metrics/Counter`1.xml | 2 +- .../Histogram`1.xml | 2 +- .../Instrument`1.xml | 4 +-- .../MeasurementCallback`1.xml | 10 +++--- .../Measurement`1.xml | 2 +- xml/System.Diagnostics.Metrics/Meter.xml | 36 +++++++++---------- .../MeterListener.xml | 6 ++-- .../ObservableCounter`1.xml | 4 +-- .../ObservableInstrument`1.xml | 8 ++--- xml/ns-System.Diagnostics.Metrics.xml | 2 +- 10 files changed, 38 insertions(+), 38 deletions(-) diff --git a/xml/System.Diagnostics.Metrics/Counter`1.xml b/xml/System.Diagnostics.Metrics/Counter`1.xml index 4e1c809d91f..75783608c7e 100644 --- a/xml/System.Diagnostics.Metrics/Counter`1.xml +++ b/xml/System.Diagnostics.Metrics/Counter`1.xml @@ -26,7 +26,7 @@ - To be added. + The type that the counter represents. 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. - To be added. + The type that the histogram represents. The histogram is a metrics Instrument which can be used to report arbitrary values that are likely to be statistically meaningful. e.g. the request duration. Use method to create the Histogram object. diff --git a/xml/System.Diagnostics.Metrics/Instrument`1.xml b/xml/System.Diagnostics.Metrics/Instrument`1.xml index 16a06e8a4b0..721e380ae0d 100644 --- a/xml/System.Diagnostics.Metrics/Instrument`1.xml +++ b/xml/System.Diagnostics.Metrics/Instrument`1.xml @@ -1,4 +1,4 @@ - +The type that the counter represents. @@ -23,7 +23,7 @@ - To be added. + The type that the instrument represents. Instrument{T} is the base class for all non-observable instruments. System.Void - To be added. - To be added. - To be added. - To be added. - To be added. + The type that the measurement represents. + The that was responsible for sending the measurement. + The measurement value + A span of key-value pair tags associated with the measurement.< + The state object originally passed to method. A delegate to represent the Meterlistener callbacks used in measurements recording operation. To be added. diff --git a/xml/System.Diagnostics.Metrics/Measurement`1.xml b/xml/System.Diagnostics.Metrics/Measurement`1.xml index 156c6d33878..61b74574d6e 100644 --- a/xml/System.Diagnostics.Metrics/Measurement`1.xml +++ b/xml/System.Diagnostics.Metrics/Measurement`1.xml @@ -29,7 +29,7 @@ - To be added. + The type that the measurement represents. Measurement stores one observed metrics value and its associated tags. This type is used by Observable instruments' Observe() method when reporting current measurements. with the associated tags. To be added. diff --git a/xml/System.Diagnostics.Metrics/Meter.xml b/xml/System.Diagnostics.Metrics/Meter.xml index d9628f5223b..f4dfa9f4636 100644 --- a/xml/System.Diagnostics.Metrics/Meter.xml +++ b/xml/System.Diagnostics.Metrics/Meter.xml @@ -95,12 +95,12 @@ - To be added. + The numerical type of the measurement. The instrument name. cannot be . Optional instrument unit of measurements. Optional instrument description. Create a metrics Counter object. - To be added. + Returns a new Counter. - To be added. + The numerical type of the measurement. The instrument name. cannot be . Optional instrument unit of measurements. Optional instrument description. 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. - To be added. + Returns a new Histogram. - To be added. + The numerical type of the measurement. The instrument name. cannot be . The callback to call to get the measurements when the is called by . Optional instrument unit of measurements. Optional instrument description. ObservableCounter is an Instrument which reports monotonically increasing value(s) when the instrument is being observed. - To be added. + Returns a new ObservableCounter. - To be added. + The numerical type of the measurement. The instrument name. cannot be . The callback to call to get the measurements when the is called by Optional instrument unit of measurements. Optional instrument description. ObservableCounter is an Instrument which reports monotonically increasing value(s) when the instrument is being observed. - To be added. + Returns a new ObservableCounter. - To be added. + The numerical type of the measurement.. The instrument name. cannot be . The callback to call to get the measurements when the is called by . Optional instrument unit of measurements. Optional instrument description. ObservableCounter is an Instrument which reports monotonically increasing value(s) when the instrument is being observed. - To be added. + Returns a new ObservableCounter. - To be added. + The numerical type of the measurement. The instrument name. cannot be . The callback to call to get the measurements when the is called by . Optional instrument unit of measurements. Optional instrument description. 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. - To be added. + Returns a new ObservableGauge. To be added. @@ -373,13 +373,13 @@ Example uses for ObservableCounter: The number of page faults for each process. - To be added. + The numerical type of the measurement. The instrument name. cannot be . The callback to call to get the measurements when the is called by . Optional instrument unit of measurements. Optional instrument description. 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. - To be added. + Returns a new ObservableGauge. To be added. @@ -413,13 +413,13 @@ Example uses for ObservableCounter: The number of page faults for each process. - To be added. + The numerical type of the measurement. The instrument name. cannot be . The callback to call to get the measurements when the is called by . Optional instrument unit of measurements. Optional instrument description. 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. - To be added. + Returns a new ObservableGauge. To be added. @@ -464,7 +464,7 @@ Example uses for ObservableCounter: The number of page faults for each process. Returns the Meter name. - To be added. + The Meter name To be added. @@ -485,7 +485,7 @@ Example uses for ObservableCounter: The number of page faults for each process. Returns the Meter Version. - To be added. + The Meter version. To be added. diff --git a/xml/System.Diagnostics.Metrics/MeterListener.xml b/xml/System.Diagnostics.Metrics/MeterListener.xml index 067b4f19184..bb712653073 100644 --- a/xml/System.Diagnostics.Metrics/MeterListener.xml +++ b/xml/System.Diagnostics.Metrics/MeterListener.xml @@ -130,7 +130,7 @@ Callbacks to get notification when an instrument is published. - To be added. + Callback to get notification when an instrument is published. To be added. @@ -152,7 +152,7 @@ Callbacks to get notification when stopping the measurement on some instrument. This can happen when the Meter or the Listener is disposed or calling on the listener. - To be added. + Callback to get notification when stopping the measurement on some instrument. To be added. @@ -205,7 +205,7 @@ - To be added. + The type of the numeric measurement. The callback which can be used to get measurement recording of numeric type T. 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. diff --git a/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml b/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml index 8021fed23ab..37b04fc34be 100644 --- a/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml +++ b/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml @@ -26,7 +26,7 @@ - To be added. + The type that the observable counter represents. 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. @@ -59,7 +59,7 @@ This class supports only the following generic parameter types: Observe() fetches the current measurements being tracked by this observable counter. - To be added. + Returns the current measurements being tracked by this observable counter. To be added. diff --git a/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml b/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml index aac94e4129e..a313a59af4b 100644 --- a/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml +++ b/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml @@ -23,7 +23,7 @@ - To be added. + The type that the observable instrument represents. ObservableInstrument{T} is the base class from which all metrics observable instruments will inherit from. System.Boolean - A property tells if the instrument is an observable instrument. This property will return for all metrics observable instruments. - To be added. + A property tells if the instrument is an observable instrument. + This property will return for all metrics observable instruments. To be added. @@ -103,7 +103,7 @@ This class supports only the following generic parameter types: Observe() fetches the current measurements being tracked by this instrument. All classes extending ObservableInstrument{T} need to implement this method. - To be added. + Returns the current measurements tracked by this instrument. To be added. diff --git a/xml/ns-System.Diagnostics.Metrics.xml b/xml/ns-System.Diagnostics.Metrics.xml index cf46518350e..30da2776f8d 100644 --- a/xml/ns-System.Diagnostics.Metrics.xml +++ b/xml/ns-System.Diagnostics.Metrics.xml @@ -1,6 +1,6 @@ - To be added. + Metrics are numerical measurements reported over time, most often used to monitor the health of an application and generate alerts. For example a web service might track how many requests it receives each second, how many milliseconds it took to respond, and how many of the responses sent an error back to the user. These metrics can be reported to a monitoring system at frequent regular intervals. The System.Diagnostics.Metrics namespace can be used to add metrics to an application. The APIs work on all platforms supported by .NET and were designed to integrate well with OpenTelemetry's (https://opentelemetry.io/) growing ecosystem of tools. They also integrate with dotnet SDK tools like dotnet-counters (https://docs.microsoft.com/dotnet/core/diagnostics/dotnet-counters) and has a listener API available for developers that want to create custom tooling or adapters to other systems. To be added. From 9acec26af2afc72fb16ad17645bbf46e7661d140 Mon Sep 17 00:00:00 2001 From: Tom McDonald Date: Mon, 13 Sep 2021 18:14:51 -0700 Subject: [PATCH 02/17] Fix XML issues --- xml/System.Diagnostics.Metrics/Instrument`1.xml | 2 +- xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.Diagnostics.Metrics/Instrument`1.xml b/xml/System.Diagnostics.Metrics/Instrument`1.xml index 721e380ae0d..0f1f542ca1c 100644 --- a/xml/System.Diagnostics.Metrics/Instrument`1.xml +++ b/xml/System.Diagnostics.Metrics/Instrument`1.xml @@ -1,4 +1,4 @@ -The type that the counter represents. + diff --git a/xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml b/xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml index 019a603fffb..ad1acc8fc06 100644 --- a/xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml +++ b/xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml @@ -28,7 +28,7 @@ The type that the measurement represents. The that was responsible for sending the measurement. The measurement value - A span of key-value pair tags associated with the measurement.< + A span of key-value pair tags associated with the measurement. The state object originally passed to method. A delegate to represent the Meterlistener callbacks used in measurements recording operation. To be added. From 1bffa42be87f43f66f38b995f184980657373a51 Mon Sep 17 00:00:00 2001 From: Tom McDonald Date: Mon, 13 Sep 2021 18:23:28 -0700 Subject: [PATCH 03/17] Update xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml b/xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml index ad1acc8fc06..22ea01cdb3b 100644 --- a/xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml +++ b/xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml @@ -27,7 +27,7 @@ The type that the measurement represents. The that was responsible for sending the measurement. - The measurement value + The measurement value. A span of key-value pair tags associated with the measurement. The state object originally passed to method. A delegate to represent the Meterlistener callbacks used in measurements recording operation. From 68e0687b78df175c91a375b600e39da35224728b Mon Sep 17 00:00:00 2001 From: Tom McDonald Date: Mon, 13 Sep 2021 18:23:37 -0700 Subject: [PATCH 04/17] Update xml/System.Diagnostics.Metrics/Meter.xml Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Diagnostics.Metrics/Meter.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Diagnostics.Metrics/Meter.xml b/xml/System.Diagnostics.Metrics/Meter.xml index f4dfa9f4636..3a172c7145f 100644 --- a/xml/System.Diagnostics.Metrics/Meter.xml +++ b/xml/System.Diagnostics.Metrics/Meter.xml @@ -100,7 +100,7 @@ Optional instrument unit of measurements. Optional instrument description. Create a metrics Counter object. - Returns a new Counter. + A new counter. Date: Mon, 13 Sep 2021 18:23:43 -0700 Subject: [PATCH 05/17] Update xml/System.Diagnostics.Metrics/Meter.xml Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Diagnostics.Metrics/Meter.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Diagnostics.Metrics/Meter.xml b/xml/System.Diagnostics.Metrics/Meter.xml index 3a172c7145f..d9783334b54 100644 --- a/xml/System.Diagnostics.Metrics/Meter.xml +++ b/xml/System.Diagnostics.Metrics/Meter.xml @@ -195,7 +195,7 @@ Example uses for Histogram: the request duration and the size of the response pa Optional instrument unit of measurements. Optional instrument description. ObservableCounter is an Instrument which reports monotonically increasing value(s) when the instrument is being observed. - Returns a new ObservableCounter. + A new observable counter. Date: Mon, 13 Sep 2021 18:23:52 -0700 Subject: [PATCH 06/17] Update xml/System.Diagnostics.Metrics/Meter.xml Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Diagnostics.Metrics/Meter.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Diagnostics.Metrics/Meter.xml b/xml/System.Diagnostics.Metrics/Meter.xml index d9783334b54..a6176daee83 100644 --- a/xml/System.Diagnostics.Metrics/Meter.xml +++ b/xml/System.Diagnostics.Metrics/Meter.xml @@ -147,7 +147,7 @@ Counter is an Instrument which supports non-negative increments. Optional instrument unit of measurements. Optional instrument description. 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. - Returns a new Histogram. + A new histogram. Date: Mon, 13 Sep 2021 18:23:59 -0700 Subject: [PATCH 07/17] Update xml/System.Diagnostics.Metrics/Meter.xml Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Diagnostics.Metrics/Meter.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Diagnostics.Metrics/Meter.xml b/xml/System.Diagnostics.Metrics/Meter.xml index a6176daee83..cfeac5fc7dd 100644 --- a/xml/System.Diagnostics.Metrics/Meter.xml +++ b/xml/System.Diagnostics.Metrics/Meter.xml @@ -379,7 +379,7 @@ Example uses for ObservableCounter: The number of page faults for each process. Optional instrument unit of measurements. Optional instrument description. 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. - Returns a new ObservableGauge. + A new observable gauge. To be added. From 6932b489dcc3fcd053f15f6b0c5b9a423e952dc8 Mon Sep 17 00:00:00 2001 From: Tom McDonald Date: Mon, 13 Sep 2021 18:24:05 -0700 Subject: [PATCH 08/17] Update xml/System.Diagnostics.Metrics/ObservableCounter`1.xml Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Diagnostics.Metrics/ObservableCounter`1.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml b/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml index 37b04fc34be..ec0944b2605 100644 --- a/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml +++ b/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml @@ -59,7 +59,7 @@ This class supports only the following generic parameter types: Observe() fetches the current measurements being tracked by this observable counter. - Returns the current measurements being tracked by this observable counter. + The current measurements being tracked by this observable counter. To be added. From 40a4ec836c823daf1efdb9844ee3b8fbdd1466b8 Mon Sep 17 00:00:00 2001 From: Tom McDonald Date: Mon, 13 Sep 2021 18:24:10 -0700 Subject: [PATCH 09/17] Update xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml b/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml index a313a59af4b..d1d5d1059cc 100644 --- a/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml +++ b/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml @@ -81,7 +81,7 @@ This class supports only the following generic parameter types: A property tells if the instrument is an observable instrument. - This property will return for all metrics observable instruments. + for all metrics observable instruments; for all other types of instruments. To be added. From fa62a36ffeaa6442e650995df755b51e8fd761c3 Mon Sep 17 00:00:00 2001 From: Tom McDonald Date: Mon, 13 Sep 2021 18:24:15 -0700 Subject: [PATCH 10/17] Update xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml b/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml index d1d5d1059cc..7e550b322f8 100644 --- a/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml +++ b/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml @@ -103,7 +103,7 @@ This class supports only the following generic parameter types: Observe() fetches the current measurements being tracked by this instrument. All classes extending ObservableInstrument{T} need to implement this method. - Returns the current measurements tracked by this instrument. + The current measurements tracked by this instrument. To be added. From 010293f5c2c8c842bd61cb8c926591375efb333d Mon Sep 17 00:00:00 2001 From: Tom McDonald Date: Mon, 13 Sep 2021 18:24:25 -0700 Subject: [PATCH 11/17] Update xml/System.Diagnostics.Metrics/Meter.xml Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Diagnostics.Metrics/Meter.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Diagnostics.Metrics/Meter.xml b/xml/System.Diagnostics.Metrics/Meter.xml index cfeac5fc7dd..bdd3b909b6e 100644 --- a/xml/System.Diagnostics.Metrics/Meter.xml +++ b/xml/System.Diagnostics.Metrics/Meter.xml @@ -419,7 +419,7 @@ Example uses for ObservableCounter: The number of page faults for each process. Optional instrument unit of measurements. Optional instrument description. 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. - Returns a new ObservableGauge. + A new observable gauge. To be added. From 545950cf536666ac3d8116b3c76648108d2f95e2 Mon Sep 17 00:00:00 2001 From: Tom McDonald Date: Mon, 13 Sep 2021 18:24:31 -0700 Subject: [PATCH 12/17] Update xml/System.Diagnostics.Metrics/Meter.xml Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Diagnostics.Metrics/Meter.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Diagnostics.Metrics/Meter.xml b/xml/System.Diagnostics.Metrics/Meter.xml index bdd3b909b6e..07ba86fa6b0 100644 --- a/xml/System.Diagnostics.Metrics/Meter.xml +++ b/xml/System.Diagnostics.Metrics/Meter.xml @@ -243,7 +243,7 @@ Example uses for ObservableCounter: The number of page faults for each process. Optional instrument unit of measurements. Optional instrument description. ObservableCounter is an Instrument which reports monotonically increasing value(s) when the instrument is being observed. - Returns a new ObservableCounter. + A new observable counter. Date: Mon, 13 Sep 2021 18:24:41 -0700 Subject: [PATCH 13/17] Update xml/System.Diagnostics.Metrics/Meter.xml Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Diagnostics.Metrics/Meter.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Diagnostics.Metrics/Meter.xml b/xml/System.Diagnostics.Metrics/Meter.xml index 07ba86fa6b0..991f6f2d843 100644 --- a/xml/System.Diagnostics.Metrics/Meter.xml +++ b/xml/System.Diagnostics.Metrics/Meter.xml @@ -291,7 +291,7 @@ Example uses for ObservableCounter: The number of page faults for each process. Optional instrument unit of measurements. Optional instrument description. ObservableCounter is an Instrument which reports monotonically increasing value(s) when the instrument is being observed. - Returns a new ObservableCounter. + A new observable counter. Date: Mon, 13 Sep 2021 18:24:48 -0700 Subject: [PATCH 14/17] Update xml/System.Diagnostics.Metrics/Meter.xml Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Diagnostics.Metrics/Meter.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Diagnostics.Metrics/Meter.xml b/xml/System.Diagnostics.Metrics/Meter.xml index 991f6f2d843..1625afd8b57 100644 --- a/xml/System.Diagnostics.Metrics/Meter.xml +++ b/xml/System.Diagnostics.Metrics/Meter.xml @@ -339,7 +339,7 @@ Example uses for ObservableCounter: The number of page faults for each process. Optional instrument unit of measurements. Optional instrument description. 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. - Returns a new ObservableGauge. + A new observable gauge. To be added. From 2fc08406eca599a001bf7918f0450d9330383897 Mon Sep 17 00:00:00 2001 From: Tom McDonald Date: Mon, 13 Sep 2021 22:08:00 -0700 Subject: [PATCH 15/17] Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System.Diagnostics.Metrics/Histogram`1.xml | 2 +- .../Instrument`1.xml | 2 +- .../Measurement`1.xml | 2 +- xml/System.Diagnostics.Metrics/Meter.xml | 18 +++++++++--------- .../MeterListener.xml | 6 +++--- .../ObservableCounter`1.xml | 2 +- .../ObservableInstrument`1.xml | 7 ++++--- xml/ns-System.Diagnostics.Metrics.xml | 2 +- 8 files changed, 21 insertions(+), 20 deletions(-) diff --git a/xml/System.Diagnostics.Metrics/Histogram`1.xml b/xml/System.Diagnostics.Metrics/Histogram`1.xml index 32bdb35a294..6a0a1681e91 100644 --- a/xml/System.Diagnostics.Metrics/Histogram`1.xml +++ b/xml/System.Diagnostics.Metrics/Histogram`1.xml @@ -27,7 +27,7 @@ The type that the histogram represents. - The histogram is a metrics Instrument which can be used to report arbitrary values that are likely to be statistically meaningful. + 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 method to create the Histogram object. diff --git a/xml/System.Diagnostics.Metrics/Instrument`1.xml b/xml/System.Diagnostics.Metrics/Instrument`1.xml index 0f1f542ca1c..4d36d6c385b 100644 --- a/xml/System.Diagnostics.Metrics/Instrument`1.xml +++ b/xml/System.Diagnostics.Metrics/Instrument`1.xml @@ -24,7 +24,7 @@ The type that the instrument represents. - Instrument{T} is the base class for all non-observable instruments. + The base class for all non-observable instruments. The type that the measurement represents. - Measurement stores one observed metrics value and its associated tags. This type is used by Observable instruments' Observe() method when reporting current measurements. + 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. To be added. diff --git a/xml/System.Diagnostics.Metrics/Meter.xml b/xml/System.Diagnostics.Metrics/Meter.xml index 1625afd8b57..03672e40f24 100644 --- a/xml/System.Diagnostics.Metrics/Meter.xml +++ b/xml/System.Diagnostics.Metrics/Meter.xml @@ -146,7 +146,7 @@ Counter is an Instrument which supports non-negative increments. The instrument name. cannot be . Optional instrument unit of measurements. Optional instrument description. - 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. + 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. A new histogram. The callback to call to get the measurements when the is called by . Optional instrument unit of measurements. Optional instrument description. - ObservableCounter is an Instrument which reports monotonically increasing value(s) when the instrument is being observed. + Creates an ObservableCounter, which is an instrument that reports monotonically increasing values when the instrument is being observed. A new observable counter. The callback to call to get the measurements when the is called by Optional instrument unit of measurements. Optional instrument description. - ObservableCounter is an Instrument which reports monotonically increasing value(s) when the instrument is being observed. + Creates an ObservableCounter, which is an instrument that reports monotonically increasing values when the instrument is being observed. A new observable counter. The callback to call to get the measurements when the is called by . Optional instrument unit of measurements. Optional instrument description. - ObservableCounter is an Instrument which reports monotonically increasing value(s) when the instrument is being observed. + Creates an ObservableCounter, which is an instrument that reports monotonically increasing values when the instrument is being observed. A new observable counter. The callback to call to get the measurements when the is called by . Optional instrument unit of measurements. Optional instrument description. - 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. + 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. A new observable gauge. To be added. @@ -378,7 +378,7 @@ Example uses for ObservableCounter: The number of page faults for each process. The callback to call to get the measurements when the is called by . Optional instrument unit of measurements. Optional instrument description. - 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. + 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. A new observable gauge. To be added. @@ -418,7 +418,7 @@ Example uses for ObservableCounter: The number of page faults for each process. The callback to call to get the measurements when the is called by . Optional instrument unit of measurements. Optional instrument description. - 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. + 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. A new observable gauge. To be added. @@ -463,7 +463,7 @@ Example uses for ObservableCounter: The number of page faults for each process. System.String - Returns the Meter name. + Gets the Meter name. The Meter name To be added. @@ -484,7 +484,7 @@ Example uses for ObservableCounter: The number of page faults for each process. System.String - Returns the Meter Version. + Gets the Meter version. The Meter version. To be added. diff --git a/xml/System.Diagnostics.Metrics/MeterListener.xml b/xml/System.Diagnostics.Metrics/MeterListener.xml index bb712653073..364858675a9 100644 --- a/xml/System.Diagnostics.Metrics/MeterListener.xml +++ b/xml/System.Diagnostics.Metrics/MeterListener.xml @@ -129,7 +129,7 @@ System.Action<System.Diagnostics.Metrics.Instrument,System.Diagnostics.Metrics.MeterListener> - Callbacks to get notification when an instrument is published. + Gets or sets the callback to get notified when an instrument is published. Callback to get notification when an instrument is published. To be added. @@ -150,9 +150,9 @@ System.Action<System.Diagnostics.Metrics.Instrument,System.Object> - Callbacks to get notification when stopping the measurement on some instrument. + 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 on the listener. - Callback to get notification when stopping the measurement on some instrument. + The callback to get notified when the measurement is stopped on some instrument. To be added. diff --git a/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml b/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml index ec0944b2605..a79769dca92 100644 --- a/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml +++ b/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml @@ -58,7 +58,7 @@ This class supports only the following generic parameter types: - Observe() fetches the current measurements being tracked by this observable counter. + Fetches the current measurements being tracked by this observable counter. The current measurements being tracked by this observable counter. To be added. diff --git a/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml b/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml index 7e550b322f8..dd3ab313f75 100644 --- a/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml +++ b/xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml @@ -80,8 +80,9 @@ This class supports only the following generic parameter types: System.Boolean - A property tells if the instrument is an observable instrument. - for all metrics observable instruments; for all other types of instruments. + Gets a value that indicates if the instrument is an observable instrument. + + if the instrument is metrics-observable; otherwise. To be added. @@ -102,7 +103,7 @@ This class supports only the following generic parameter types: - Observe() fetches the current measurements being tracked by this instrument. All classes extending ObservableInstrument{T} need to implement this method. + Fetches the current measurements being tracked by this instrument. All classes extending ObservableInstrument{T} need to implement this method. The current measurements tracked by this instrument. To be added. diff --git a/xml/ns-System.Diagnostics.Metrics.xml b/xml/ns-System.Diagnostics.Metrics.xml index 30da2776f8d..ddce0c9f8f3 100644 --- a/xml/ns-System.Diagnostics.Metrics.xml +++ b/xml/ns-System.Diagnostics.Metrics.xml @@ -1,6 +1,6 @@ - Metrics are numerical measurements reported over time, most often used to monitor the health of an application and generate alerts. For example a web service might track how many requests it receives each second, how many milliseconds it took to respond, and how many of the responses sent an error back to the user. These metrics can be reported to a monitoring system at frequent regular intervals. The System.Diagnostics.Metrics namespace can be used to add metrics to an application. The APIs work on all platforms supported by .NET and were designed to integrate well with OpenTelemetry's (https://opentelemetry.io/) growing ecosystem of tools. They also integrate with dotnet SDK tools like dotnet-counters (https://docs.microsoft.com/dotnet/core/diagnostics/dotnet-counters) and has a listener API available for developers that want to create custom tooling or adapters to other systems. + Metrics are numerical measurements reported over time, most often used to monitor the health of an application and generate alerts. For example, a web service might track how many requests it receives each second, how many milliseconds it took to respond, and how many of the responses sent an error back to the user. These metrics can be reported to a monitoring system at frequent, regular intervals. The System.Diagnostics.Metrics namespace can be used to add metrics to an application. The APIs work on all platforms supported by .NET and are designed to integrate well with OpenTelemetry's growing ecosystem of tools. They also integrate with .NET SDK tools, such as dotnet-counters. A listener API is available for developers that want to create custom tooling or adapters to other systems. To be added. From 0216883986b8d8a9f5f2681c12f9eae55f98c83e Mon Sep 17 00:00:00 2001 From: Tom McDonald Date: Mon, 13 Sep 2021 22:08:35 -0700 Subject: [PATCH 16/17] Update xml/System.Diagnostics.Metrics/MeterListener.xml Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System.Diagnostics.Metrics/MeterListener.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Diagnostics.Metrics/MeterListener.xml b/xml/System.Diagnostics.Metrics/MeterListener.xml index 364858675a9..e4e4f41b383 100644 --- a/xml/System.Diagnostics.Metrics/MeterListener.xml +++ b/xml/System.Diagnostics.Metrics/MeterListener.xml @@ -130,7 +130,7 @@ Gets or sets the callback to get notified when an instrument is published. - Callback to get notification when an instrument is published. + The callback to get notified when an instrument is published. To be added. From 2b8205e62a40d0b9eebc7470dcedcbdefb1d3263 Mon Sep 17 00:00:00 2001 From: Tom McDonald Date: Mon, 13 Sep 2021 22:08:58 -0700 Subject: [PATCH 17/17] Update xml/System.Diagnostics.Metrics/Counter`1.xml Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System.Diagnostics.Metrics/Counter`1.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Diagnostics.Metrics/Counter`1.xml b/xml/System.Diagnostics.Metrics/Counter`1.xml index 75783608c7e..0ae2def7c63 100644 --- a/xml/System.Diagnostics.Metrics/Counter`1.xml +++ b/xml/System.Diagnostics.Metrics/Counter`1.xml @@ -27,7 +27,7 @@ The type that the counter represents. - 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. + 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.