Interface IMeasureTimerMetrics

Provides access to the API allowing Timer Metrics to be measured/recorded.

Namespace:App.Metrics.Timer.Abstractions

Assembly:cs.temp.dll.dll

Syntax

public interface IMeasureTimerMetrics

Methods

Time(TimerOptions)

Records a which measures the time taken to process an action using a timer metric. Records a histogram of the duration of a type of event and a meter of the rate of it's occurance

Declaration

TimerContext Time(TimerOptions options)

Parameters

Type	Name	Description
TimerOptions	options	The details of the timer that is being measured

Returns

Type	Description
TimerContext	A disposable context, when disposed records the time token to process the using block

Time(TimerOptions, MetricTags)

Records a which measures the time taken to process an action using a timer metric. Records a histogram of the duration of a type of event and a meter of the rate of it's occurance

Declaration

TimerContext Time(TimerOptions options, MetricTags tags)

Parameters

Type	Name	Description
TimerOptions	options	The details of the timer that is being measured
MetricTags	tags	The runtime tags to set in addition to those defined on the options, this will create a separate metric per unique

Returns

Type	Description
TimerContext	A disposable context, when disposed records the time token to process the using block

Time(TimerOptions, MetricTags, Action)

Records a which measures the time taken to process an action using a timer metric. Records a histogram of the duration of a type of event and a meter of the rate of it's occurance

Declaration

void Time(TimerOptions options, MetricTags tags, Action action)

Parameters

Type	Name	Description
TimerOptions	options	The details of the timer that is being measured
MetricTags	tags	The runtime tags to set in addition to those defined on the options, this will create a separate metric per unique
System.Action	action	The action to measure.

Time(TimerOptions, MetricTags, Action, String)

Records a which measures the time taken to process an action using a timer metric. Records a histogram of the duration of a type of event and a meter of the rate of it's occurance

Declaration

void Time(TimerOptions options, MetricTags tags, Action action, string userValue)

Parameters

Type	Name	Description
TimerOptions	options	The details of the timer that is being measured
MetricTags	tags	The runtime tags to set in addition to those defined on the options, this will create a separate metric per unique
System.Action	action	The action to measure.
System.String	userValue	The user value to track where a Min, Max and Last duration is recorded.

Time(TimerOptions, MetricTags, String)

Records a which measures the time taken to process an action using a timer metric. Records a histogram of the duration of a type of event and a meter of the rate of it's occurance

Declaration

TimerContext Time(TimerOptions options, MetricTags tags, string userValue)

Parameters

Type	Name	Description
TimerOptions	options	The details of the timer that is being measured
MetricTags	tags	The runtime tags to set in addition to those defined on the options, this will create a separate metric per unique
System.String	userValue	The user value to track where a Min, Max and Last duration is recorded.

Returns

Type	Description
TimerContext	A disposable context, when disposed records the time token to process the using block

Time(TimerOptions, Action)

Records a which measures the time taken to process an action using a timer metric. Records a histogram of the duration of a type of event and a meter of the rate of it's occurance

Declaration

void Time(TimerOptions options, Action action)

Parameters

Type	Name	Description
TimerOptions	options	The details of the timer that is being measured
System.Action	action	The action to measure.

Time(TimerOptions, Action, String)

Records a which measures the time taken to process an action using a timer metric. Records a histogram of the duration of a type of event and a meter of the rate of it's occurance

Declaration

void Time(TimerOptions options, Action action, string userValue)

Parameters

Type	Name	Description
TimerOptions	options	The details of the timer that is being measured
System.Action	action	The action to measure.
System.String	userValue	The user value to track where a Min, Max and Last duration is recorded.

Time(TimerOptions, String)

Records a which measures the time taken to process an action using a timer metric. Records a histogram of the duration of a type of event and a meter of the rate of it's occurance

Declaration

TimerContext Time(TimerOptions options, string userValue)

Parameters

Type	Name	Description
TimerOptions	options	The details of the timer that is being measured
System.String	userValue	The user value to track where a Min, Max and Last duration is recorded.

Returns

Type	Description
TimerContext	A disposable context, when disposed records the time token to process the using block