Meter.CreateObservableUpDownCounter Method
Definition
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.
Overloads
| CreateObservableUpDownCounter<T>(String, Func<IEnumerable<Measurement<T>>>, String, String) |
Creates an ObservableUpDownCounter object. ObservableUpDownCounter is an Instrument that reports increasing or decreasing values when the instrument is being observed. |
| CreateObservableUpDownCounter<T>(String, Func<Measurement<T>>, String, String) |
Creates an ObservableUpDownCounter object. ObservableUpDownCounter is an Instrument that reports increasing or decreasing values when the instrument is being observed. |
| CreateObservableUpDownCounter<T>(String, Func<T>, String, String) |
Creates an ObservableUpDownCounter object. ObservableUpDownCounter is an Instrument that reports increasing or decreasing values when the instrument is being observed. |
| CreateObservableUpDownCounter<T>(String, Func<IEnumerable<Measurement<T>>>, String, String, IEnumerable<KeyValuePair<String,Object>>) |
Create an ObservableUpDownCounter object. ObservableUpDownCounter is an Instrument which reports increasing or decreasing value(s) when the instrument is being observed. |
| CreateObservableUpDownCounter<T>(String, Func<Measurement<T>>, String, String, IEnumerable<KeyValuePair<String,Object>>) |
Create an ObservableUpDownCounter object. ObservableUpDownCounter is an Instrument which reports increasing or decreasing value(s) when the instrument is being observed. |
| CreateObservableUpDownCounter<T>(String, Func<T>, String, String, IEnumerable<KeyValuePair<String,Object>>) |
Create an ObservableUpDownCounter object. ObservableUpDownCounter is an Instrument which reports increasing or decreasing value(s) when the instrument is being observed. |
CreateObservableUpDownCounter<T>(String, Func<IEnumerable<Measurement<T>>>, String, String)
- Source:
- Meter.cs
- Source:
- Meter.cs
- Source:
- Meter.cs
- Source:
- Meter.cs
- Source:
- Meter.cs
Creates an ObservableUpDownCounter object. ObservableUpDownCounter is an Instrument that reports increasing or decreasing values when the instrument is being observed.
public System.Diagnostics.Metrics.ObservableUpDownCounter<T> CreateObservableUpDownCounter<T> (string name, Func<System.Collections.Generic.IEnumerable<System.Diagnostics.Metrics.Measurement<T>>> observeValues, string? unit = default, string? description = default) where T : struct;member this.CreateObservableUpDownCounter : string * Func<seq<System.Diagnostics.Metrics.Measurement<'T>>> * string * string -> System.Diagnostics.Metrics.ObservableUpDownCounter<'T (requires 'T : struct)> (requires 'T : struct)Public Function CreateObservableUpDownCounter(Of T As Structure) (name As String, observeValues As Func(Of IEnumerable(Of Measurement(Of T))), Optional unit As String = Nothing, Optional description As String = Nothing) As ObservableUpDownCounter(Of T)Type Parameters
- T
The numerical type of the measurement.
Parameters
- name
- String
The instrument name. Cannot be null.
- observeValues
- Func<IEnumerable<Measurement<T>>>
The callback to call to get the measurements when the Observe() is called by RecordObservableInstruments().
- unit
- String
Optional instrument unit of measurements.
- description
- String
Optional instrument description.
Returns
A new observable up down counter.
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 the ObservableUpDownCounter is changing, the difference between successive measurements is used.
Example uses for ObservableUpDownCounter: the process heap size or the approximate number of items in a lock-free circular buffer.
Applies to
CreateObservableUpDownCounter<T>(String, Func<Measurement<T>>, String, String)
- Source:
- Meter.cs
- Source:
- Meter.cs
- Source:
- Meter.cs
- Source:
- Meter.cs
- Source:
- Meter.cs
Creates an ObservableUpDownCounter object. ObservableUpDownCounter is an Instrument that reports increasing or decreasing values when the instrument is being observed.
public System.Diagnostics.Metrics.ObservableUpDownCounter<T> CreateObservableUpDownCounter<T> (string name, Func<System.Diagnostics.Metrics.Measurement<T>> observeValue, string? unit = default, string? description = default) where T : struct;member this.CreateObservableUpDownCounter : string * Func<System.Diagnostics.Metrics.Measurement<'T>> * string * string -> System.Diagnostics.Metrics.ObservableUpDownCounter<'T (requires 'T : struct)> (requires 'T : struct)Public Function CreateObservableUpDownCounter(Of T As Structure) (name As String, observeValue As Func(Of Measurement(Of T)), Optional unit As String = Nothing, Optional description As String = Nothing) As ObservableUpDownCounter(Of T)Type Parameters
- T
The numerical type of the measurement.
Parameters
- name
- String
The instrument name. Cannot be null.
- observeValue
- Func<Measurement<T>>
The callback to call to get the measurements when the Observe() is called by RecordObservableInstruments()
- unit
- String
Optional instrument unit of measurements.
- description
- String
Optional instrument description.
Returns
A new observable up down counter.
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 the ObservableUpDownCounter is changing, the difference between successive measurements is used.
Example uses for ObservableUpDownCounter: the process heap size or the approximate number of items in a lock-free circular buffer.
Applies to
CreateObservableUpDownCounter<T>(String, Func<T>, String, String)
- Source:
- Meter.cs
- Source:
- Meter.cs
- Source:
- Meter.cs
- Source:
- Meter.cs
- Source:
- Meter.cs
Creates an ObservableUpDownCounter object. ObservableUpDownCounter is an Instrument that reports increasing or decreasing values when the instrument is being observed.
public System.Diagnostics.Metrics.ObservableUpDownCounter<T> CreateObservableUpDownCounter<T> (string name, Func<T> observeValue, string? unit = default, string? description = default) where T : struct;member this.CreateObservableUpDownCounter : string * Func<'T (requires 'T : struct)> * string * string -> System.Diagnostics.Metrics.ObservableUpDownCounter<'T (requires 'T : struct)> (requires 'T : struct)Public Function CreateObservableUpDownCounter(Of T As Structure) (name As String, observeValue As Func(Of T), Optional unit As String = Nothing, Optional description As String = Nothing) As ObservableUpDownCounter(Of T)Type Parameters
- T
The numerical type of the measurement.
Parameters
- name
- String
The instrument name. Cannot be null.
- observeValue
- Func<T>
The callback to call to get the measurements when the Observe() is called by RecordObservableInstruments().
- unit
- String
Optional instrument unit of measurements.
- description
- String
Optional instrument description.
Returns
A new observable up down counter.
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 the ObservableUpDownCounter is changing, the difference between successive measurements is used.
Example uses for ObservableUpDownCounter: the process heap size or the approximate number of items in a lock-free circular buffer.
Applies to
CreateObservableUpDownCounter<T>(String, Func<IEnumerable<Measurement<T>>>, String, String, IEnumerable<KeyValuePair<String,Object>>)
- Source:
- Meter.cs
- Source:
- Meter.cs
- Source:
- Meter.cs
- Source:
- Meter.cs
Create an ObservableUpDownCounter object. ObservableUpDownCounter is an Instrument which reports increasing or decreasing value(s) when the instrument is being observed.
public:
generic <typename T>
where T : value class System::Diagnostics::Metrics::ObservableUpDownCounter<T> ^ CreateObservableUpDownCounter(System::String ^ name, Func<System::Collections::Generic::IEnumerable<System::Diagnostics::Metrics::Measurement<T>> ^> ^ observeValues, System::String ^ unit, System::String ^ description, System::Collections::Generic::IEnumerable<System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^>> ^ tags);public System.Diagnostics.Metrics.ObservableUpDownCounter<T> CreateObservableUpDownCounter<T> (string name, Func<System.Collections.Generic.IEnumerable<System.Diagnostics.Metrics.Measurement<T>>> observeValues, string? unit, string? description, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,object?>> tags) where T : struct;public System.Diagnostics.Metrics.ObservableUpDownCounter<T> CreateObservableUpDownCounter<T> (string name, Func<System.Collections.Generic.IEnumerable<System.Diagnostics.Metrics.Measurement<T>>> observeValues, string? unit, string? description, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,object?>>? tags) where T : struct;member this.CreateObservableUpDownCounter : string * Func<seq<System.Diagnostics.Metrics.Measurement<'T>>> * string * string * seq<System.Collections.Generic.KeyValuePair<string, obj>> -> System.Diagnostics.Metrics.ObservableUpDownCounter<'T (requires 'T : struct)> (requires 'T : struct)Public Function CreateObservableUpDownCounter(Of T As Structure) (name As String, observeValues As Func(Of IEnumerable(Of Measurement(Of T))), unit As String, description As String, tags As IEnumerable(Of KeyValuePair(Of String, Object))) As ObservableUpDownCounter(Of T)Type Parameters
- T
The numerical type of the measurement.
Parameters
- name
- String
The instrument name. Cannot be null.
- observeValues
- Func<IEnumerable<Measurement<T>>>
The callback to call to get the measurements when the Observe() is called by RecordObservableInstruments().
- unit
- String
Optional instrument unit of measurements.
- description
- String
Optional instrument description.
- tags
- IEnumerable<KeyValuePair<String,Object>>
tags to attach to the counter.
Returns
A new observable up down counter.
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 the ObservableUpDownCounter is changing, the difference between successive measurements is used.
Example uses for ObservableUpDownCounter: the process heap size or the approximate number of items in a lock-free circular buffer.
Applies to
CreateObservableUpDownCounter<T>(String, Func<Measurement<T>>, String, String, IEnumerable<KeyValuePair<String,Object>>)
- Source:
- Meter.cs
- Source:
- Meter.cs
- Source:
- Meter.cs
- Source:
- Meter.cs
Create an ObservableUpDownCounter object. ObservableUpDownCounter is an Instrument which reports increasing or decreasing value(s) when the instrument is being observed.
public:
generic <typename T>
where T : value class System::Diagnostics::Metrics::ObservableUpDownCounter<T> ^ CreateObservableUpDownCounter(System::String ^ name, Func<System::Diagnostics::Metrics::Measurement<T>> ^ observeValue, System::String ^ unit, System::String ^ description, System::Collections::Generic::IEnumerable<System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^>> ^ tags);public System.Diagnostics.Metrics.ObservableUpDownCounter<T> CreateObservableUpDownCounter<T> (string name, Func<System.Diagnostics.Metrics.Measurement<T>> observeValue, string? unit, string? description, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,object?>> tags) where T : struct;public System.Diagnostics.Metrics.ObservableUpDownCounter<T> CreateObservableUpDownCounter<T> (string name, Func<System.Diagnostics.Metrics.Measurement<T>> observeValue, string? unit, string? description, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,object?>>? tags) where T : struct;member this.CreateObservableUpDownCounter : string * Func<System.Diagnostics.Metrics.Measurement<'T>> * string * string * seq<System.Collections.Generic.KeyValuePair<string, obj>> -> System.Diagnostics.Metrics.ObservableUpDownCounter<'T (requires 'T : struct)> (requires 'T : struct)Public Function CreateObservableUpDownCounter(Of T As Structure) (name As String, observeValue As Func(Of Measurement(Of T)), unit As String, description As String, tags As IEnumerable(Of KeyValuePair(Of String, Object))) As ObservableUpDownCounter(Of T)Type Parameters
- T
The numerical type of the measurement.
Parameters
- name
- String
The instrument name. Cannot be null.
- observeValue
- Func<Measurement<T>>
The callback to call to get the measurements when the Observe() is called by RecordObservableInstruments()
- unit
- String
Optional instrument unit of measurements.
- description
- String
Optional instrument description.
- tags
- IEnumerable<KeyValuePair<String,Object>>
tags to attach to the counter.
Returns
A new observable up down counter.
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 the ObservableUpDownCounter is changing, the difference between successive measurements is used.
Example uses for ObservableUpDownCounter: the process heap size or the approximate number of items in a lock-free circular buffer.
Applies to
CreateObservableUpDownCounter<T>(String, Func<T>, String, String, IEnumerable<KeyValuePair<String,Object>>)
- Source:
- Meter.cs
- Source:
- Meter.cs
- Source:
- Meter.cs
- Source:
- Meter.cs
Create an ObservableUpDownCounter object. ObservableUpDownCounter is an Instrument which reports increasing or decreasing value(s) when the instrument is being observed.
public:
generic <typename T>
where T : value class System::Diagnostics::Metrics::ObservableUpDownCounter<T> ^ CreateObservableUpDownCounter(System::String ^ name, Func<T> ^ observeValue, System::String ^ unit, System::String ^ description, System::Collections::Generic::IEnumerable<System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^>> ^ tags);public System.Diagnostics.Metrics.ObservableUpDownCounter<T> CreateObservableUpDownCounter<T> (string name, Func<T> observeValue, string? unit, string? description, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,object?>> tags) where T : struct;public System.Diagnostics.Metrics.ObservableUpDownCounter<T> CreateObservableUpDownCounter<T> (string name, Func<T> observeValue, string? unit, string? description, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,object?>>? tags) where T : struct;member this.CreateObservableUpDownCounter : string * Func<'T (requires 'T : struct)> * string * string * seq<System.Collections.Generic.KeyValuePair<string, obj>> -> System.Diagnostics.Metrics.ObservableUpDownCounter<'T (requires 'T : struct)> (requires 'T : struct)Public Function CreateObservableUpDownCounter(Of T As Structure) (name As String, observeValue As Func(Of T), unit As String, description As String, tags As IEnumerable(Of KeyValuePair(Of String, Object))) As ObservableUpDownCounter(Of T)Type Parameters
- T
The numerical type of the measurement.
Parameters
- name
- String
The instrument name. Cannot be null.
- observeValue
- Func<T>
The callback to call to get the measurements when the Observe() is called by RecordObservableInstruments().
- unit
- String
Optional instrument unit of measurements.
- description
- String
Optional instrument description.
- tags
- IEnumerable<KeyValuePair<String,Object>>
tags to attach to the counter.
Returns
A new observable up down counter.
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 the ObservableUpDownCounter is changing, the difference between successive measurements is used.
Example uses for ObservableUpDownCounter: the process heap size or the approximate number of items in a lock-free circular buffer.
