diff --git a/xml/System.Diagnostics.Metrics/Counter`1.xml b/xml/System.Diagnostics.Metrics/Counter`1.xml index 4e1c809d91f..0ae2def7c63 100644 --- a/xml/System.Diagnostics.Metrics/Counter`1.xml +++ b/xml/System.Diagnostics.Metrics/Counter`1.xml @@ -26,8 +26,8 @@ - To be added. - 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. + The type that the counter represents. + 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. - To be added. - The histogram is a metrics Instrument which can be used to report arbitrary values that are likely to be statistically meaningful. + The type that the histogram represents. + 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 16a06e8a4b0..4d36d6c385b 100644 --- a/xml/System.Diagnostics.Metrics/Instrument`1.xml +++ b/xml/System.Diagnostics.Metrics/Instrument`1.xml @@ -23,8 +23,8 @@ - To be added. - Instrument{T} is the base class for all non-observable instruments. + The type that the instrument represents. + 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..0d061940773 100644 --- a/xml/System.Diagnostics.Metrics/Measurement`1.xml +++ b/xml/System.Diagnostics.Metrics/Measurement`1.xml @@ -29,8 +29,8 @@ - To be added. - Measurement stores one observed metrics value and its associated tags. This type is used by Observable instruments' Observe() method when reporting current measurements. + The type that the measurement represents. + 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 d9628f5223b..03672e40f24 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. + 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. + 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. - 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. + Creates an ObservableCounter, which is an instrument that reports monotonically increasing values when the instrument is being observed. + A new observable counter. - 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. + Creates an ObservableCounter, which is an instrument that reports monotonically increasing values when the instrument is being observed. + A new observable counter. - 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. + Creates an ObservableCounter, which is an instrument that reports monotonically increasing values when the instrument is being observed. + A new observable counter. - 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. + 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. @@ -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. + 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. @@ -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. + 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,8 +463,8 @@ Example uses for ObservableCounter: The number of page faults for each process. System.String - Returns the Meter name. - To be added. + Gets the Meter name. + The Meter name To be added. @@ -484,8 +484,8 @@ Example uses for ObservableCounter: The number of page faults for each process. System.String - Returns the Meter Version. - To be added. + 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 067b4f19184..e4e4f41b383 100644 --- a/xml/System.Diagnostics.Metrics/MeterListener.xml +++ b/xml/System.Diagnostics.Metrics/MeterListener.xml @@ -129,8 +129,8 @@ System.Action<System.Diagnostics.Metrics.Instrument,System.Diagnostics.Metrics.MeterListener> - Callbacks to get notification when an instrument is published. - To be added. + Gets or sets the callback to get notified when an instrument is published. + The callback to get notified 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. - To be added. + The callback to get notified when the measurement is stopped 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..a79769dca92 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. @@ -58,8 +58,8 @@ This class supports only the following generic parameter types: - Observe() fetches the current measurements being tracked by this observable counter. - To be added. + 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 aac94e4129e..dd3ab313f75 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. + Gets a value that indicates if the instrument is an observable instrument. + + if the instrument is metrics-observable; otherwise. To be added. @@ -102,8 +103,8 @@ 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. + 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 cf46518350e..ddce0c9f8f3 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 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.