App Metrics Fork me on GitHub
Show / Hide Table of Contents

Interface IProvideHistogramMetrics

Namespace:App.Metrics.Histogram.Abstractions
Assembly:cs.temp.dll.dll
Syntax
public interface IProvideHistogramMetrics

Methods

Instance(HistogramOptions)

Instantiates an instance of a IHistogram

Declaration
IHistogram Instance(HistogramOptions options)
Parameters
Type Name Description
HistogramOptions options

The details of the histogram that is being measured

Returns
Type Description
IHistogram

A new instance of an IHistogram or the existing registered instance of the histogram

Instance(HistogramOptions, MetricTags)

Instantiates an instance of a IHistogram

Declaration
IHistogram Instance(HistogramOptions options, MetricTags tags)
Parameters
Type Name Description
HistogramOptions options

The details of the histogram 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
IHistogram

A new instance of an IHistogram or the existing registered instance of the histogram

Instance<T>(HistogramOptions, MetricTags, Func<T>)

Instantiates an instance of a IHistogram

Declaration
IHistogram Instance<T>(HistogramOptions options, MetricTags tags, Func<T> builder)where T : IHistogramMetric
Parameters
Type Name Description
HistogramOptions options

The details of the IHistogram 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.Func<T> builder

The function used to build the histogram metric.

Returns
Type Description
IHistogram

A new instance of an IHistogram or the existing registered instance of the histogram

Type Parameters
Name Description
T

The type of IHistogram to instantiate

Instance<T>(HistogramOptions, Func<T>)

Instantiates an instance of a IHistogram

Declaration
IHistogram Instance<T>(HistogramOptions options, Func<T> builder)where T : IHistogramMetric
Parameters
Type Name Description
HistogramOptions options

The details of the IHistogram that is being measured

System.Func<T> builder

The function used to build the histogram metric.

Returns
Type Description
IHistogram

A new instance of an IHistogram or the existing registered instance of the histogram

Type Parameters
Name Description
T

The type of IHistogram to instantiate

Back to top Copyright © 2017 Allan Hardy
Generated by DocFX