Instrument Class

Definition

Namespace:

System.Diagnostics.Metrics

Assembly:

System.Diagnostics.DiagnosticSource.dll

Package:

System.Diagnostics.DiagnosticSource v9.0.0-preview.3.24172.9

Source:

Instrument.cs

Base class of all metrics instrument classes

public ref class Instrument abstract

public abstract class Instrument

type Instrument = class

Public MustInherit Class Instrument

Inheritance

Object

Instrument

Derived

System.Diagnostics.Metrics.Instrument<T>

System.Diagnostics.Metrics.ObservableInstrument<T>

Constructors

Instrument(Meter, String, String, String)	Protected constructor to initialize the common instrument properties like the meter, name, description, and unit.
Instrument(Meter, String, String, String, IEnumerable<KeyValuePair<String,Object>>)	Initializes a new instance of the Instrument class with the specified meter, name, description, and unit.

Properties

Description	Gets the instrument description.
Enabled	Gets a value that indicates if there are any listeners for this instrument.
IsObservable	Gets a value that indicates whether the instrument is an observable instrument.
Meter	Gets the Meter that created the instrument.
Name	Gets the instrument name.
Tags	Returns the tags associated with the instrument.
Unit	Gets the instrument unit of measurements.

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.
ToString()	Returns a string that represents the current object. (Inherited from Object)