Instrument<T> Class

Definition

Namespace:

System.Diagnostics.Metrics

Assembly:

System.Diagnostics.DiagnosticSource.dll

Package:

System.Diagnostics.DiagnosticSource v9.0.0-rc.2.24473.5

Source:

Instrument.common.cs

The base class for all non-observable instruments.

generic <typename T>
 where T : value classpublic ref class Instrument abstract : System::Diagnostics::Metrics::Instrument

public abstract class Instrument<T> : System.Diagnostics.Metrics.Instrument where T : struct

type Instrument<'T (requires 'T : struct)> = class
    inherit Instrument

Public MustInherit Class Instrument(Of T)
Inherits Instrument

Type Parameters

T

The type that the instrument represents.

Inheritance

Object

Instrument

Instrument<T>

Derived

System.Diagnostics.Metrics.Counter<T>

System.Diagnostics.Metrics.Gauge<T>

System.Diagnostics.Metrics.Histogram<T>

System.Diagnostics.Metrics.UpDownCounter<T>

Remarks

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

Constructors

Instrument<T>(Meter, String)	Constructs a new instance of Instrument<T>.
Instrument<T>(Meter, String, String, String)	Create the metrics instrument using the properties meter, name, description, and unit.
Instrument<T>(Meter, String, String, String, IEnumerable<KeyValuePair<String,Object>>)	Initializes a new instance of the Instrument<T> class with the specified meter, name, description, and unit.
Instrument<T>(Meter, String, String, String, IEnumerable<KeyValuePair<String,Object>>, InstrumentAdvice<T>)	Constructs a new instance of Instrument<T>.

Properties

Advice	Gets the InstrumentAdvice<T> associated with the instrument.
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 whether the instrument is an observable instrument. (Inherited from Instrument)
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)
Publish()	Activates the instrument to start recording measurements and to allow listeners to start listening to such measurements. (Inherited from Instrument)
RecordMeasurement(T)	Records a measurement by notifying all MeterListener objects that are listening to this instrument.
RecordMeasurement(T, KeyValuePair<String,Object>)	Records a measurement by notifying all MeterListener objects that are listening to this instrument.
RecordMeasurement(T, KeyValuePair<String,Object>, KeyValuePair<String,Object>)	Records a measurement by notifying all MeterListener objects that are listening to this instrument.
RecordMeasurement(T, KeyValuePair<String,Object>, KeyValuePair<String,Object>, KeyValuePair<String,Object>)	Records a measurement by notifying all MeterListener objects that are listening to this instrument.
RecordMeasurement(T, ReadOnlySpan<KeyValuePair<String,Object>>)	Records a measurement by notifying all MeterListener objects that are listening to this instrument.
RecordMeasurement(T, TagList)	Records a measurement by notifying all MeterListener objects that are listening to this instrument.
ToString()	Returns a string that represents the current object. (Inherited from Object)