ObservableUpDownCounter<T> Class

Definition

Namespace:

System.Diagnostics.Metrics

Assembly:

System.Diagnostics.DiagnosticSource.dll

Source:

ObservableUpDownCounter.cs

A metrics-observable instrument that reports increasing or decreasing values when the instrument is being observed. Use this instrument to monitor the process heap size or the approximate number of items in a lock-free circular buffer, for example. To create an ObservableUpDownCounter object, use the CreateObservableUpDownCounter methods.

C#

public sealed class ObservableUpDownCounter<T> : System.Diagnostics.Metrics.ObservableInstrument<T> where T : struct

Type Parameters

T

The type that the counter represents.

Inheritance

Object

Instrument

ObservableInstrument<T>

ObservableUpDownCounter<T>

Remarks

Note

Unlike UpDownCounter, which takes the increment/delta value, the callback function reports the absolute value of the ObservableUpDownCounter. To determine the reported rate that the ObservableUpDownCounter is changing, the difference between successive measurements is used.

This class supports only the following generic parameter types: Byte, Int16, Int32, Int64, Single, Double, and Decimal.

Properties

Description	Gets the instrument description. (Inherited from Instrument)
Enabled	Gets a value that indicates if there are any listeners for this instrument. (Inherited from Instrument)
IsObservable	Gets a value that indicates if the instrument is an observable instrument. (Inherited from ObservableInstrument<T>)
Meter	Gets the Meter that created the instrument. (Inherited from Instrument)
Name	Gets the instrument name. (Inherited from Instrument)
Tags	Returns the tags associated with the instrument. (Inherited from Instrument)
Unit	Gets the instrument unit of measurements. (Inherited from Instrument)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
Observe()	Fetches the current measurements being tracked by this instrument. All classes extending ObservableInstrument{T} need to implement this method. (Inherited from ObservableInstrument<T>)
Publish()	Activates the instrument to start recording measurements and to allow listeners to start listening to such measurements. (Inherited from Instrument)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to