Counter<T> Class

Reference

Definition

Namespace:: System.Diagnostics.Metrics

Assembly:: System.Diagnostics.DiagnosticSource.dll

Package:: System.Diagnostics.DiagnosticSource v8.0.1

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

Source:: Counter.cs

Source:: Counter.cs

Source:: Counter.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.

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

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

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

Public NotInheritable Class Counter(Of T)
Inherits Instrument(Of T)

Type Parameters

T

The type that the counter represents.

Inheritance: Object

Instrument

Instrument<T>
Counter<T>

Remarks

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

Properties

Advice	Gets the InstrumentAdvice<T> associated with the instrument. (Inherited from Instrument<T>)
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

Add(T)	Records the increment value of the measurement.
Add(T, KeyValuePair<String,Object>)	Records the increment value of the measurement.
Add(T, KeyValuePair<String,Object>, KeyValuePair<String,Object>)	Records the increment value of the measurement.
Add(T, KeyValuePair<String,Object>, KeyValuePair<String,Object>, KeyValuePair<String,Object>)	Records the increment value of the measurement.
Add(T, KeyValuePair<String,Object>[])	Records the increment value of the measurement.
Add(T, ReadOnlySpan<KeyValuePair<String,Object>>)	Records the increment value of the measurement.
Add(T, TagList)	Adds the increment value of the measurement.
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. (Inherited from Instrument<T>)
RecordMeasurement(T, KeyValuePair<String,Object>)	Records a measurement by notifying all MeterListener objects that are listening to this instrument. (Inherited from Instrument<T>)
RecordMeasurement(T, KeyValuePair<String,Object>, KeyValuePair<String,Object>)	Records a measurement by notifying all MeterListener objects that are listening to this instrument. (Inherited from Instrument<T>)
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. (Inherited from Instrument<T>)
RecordMeasurement(T, ReadOnlySpan<KeyValuePair<String,Object>>)	Records a measurement by notifying all MeterListener objects that are listening to this instrument. (Inherited from Instrument<T>)
RecordMeasurement(T, TagList)	Records a measurement by notifying all MeterListener objects that are listening to this instrument. (Inherited from Instrument<T>)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Share via