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

Class HitRatioGauge

Inheritance
System.Object
FunctionGauge
RatioGauge
HitRatioGauge
Inherited Members
FunctionGauge.Value
FunctionGauge.GetValue(Boolean)
FunctionGauge.Reset()
FunctionGauge.SetValue(Double)
Namespace:App.Metrics.Gauge
Assembly:cs.temp.dll.dll
Syntax
public sealed class HitRatioGauge : RatioGauge

Constructors

HitRatioGauge(IMeter, IMeter)

Initializes a new instance of the HitRatioGauge class.

Declaration
public HitRatioGauge(IMeter hitMeter, IMeter totalMeter)
Parameters
Type Name Description
IMeter hitMeter

The hit meter.

IMeter totalMeter

The total meter.

Remarks

Creates a new HitRatioGauge with externally tracked Meters, and uses the OneMinuteRate from the MeterValue of the meters.

HitRatioGauge(IMeter, IMeter, Func<MeterValue, Double>)

Initializes a new instance of the HitRatioGauge class.

Declaration
public HitRatioGauge(IMeter hitMeter, IMeter totalMeter, Func<MeterValue, double> meterRateFunc)
Parameters
Type Name Description
IMeter hitMeter

The numerator meter to use for the ratio.

IMeter totalMeter

The denominator meter to use for the ratio.

System.Func<MeterValue, System.Double> meterRateFunc

The function to extract a value from the MeterValue. Will be applied to both the numerator and denominator meters.

Remarks

Creates a new HitRatioGauge with externally tracked Meters, and uses the provided meter rate function to extract the value for the ratio.

HitRatioGauge(IMeter, ITimer)

Initializes a new instance of the HitRatioGauge class.

Declaration
public HitRatioGauge(IMeter hitMeter, ITimer totalTimer)
Parameters
Type Name Description
IMeter hitMeter

The numerator meter to use for the ratio.

ITimer totalTimer

The denominator meter to use for the ratio.

Remarks

Creates a new HitRatioGauge with externally tracked Meter and Timer, and uses the OneMinuteRate from the MeterValue of the meters.

HitRatioGauge(IMeter, ITimer, Func<MeterValue, Double>)

Initializes a new instance of the HitRatioGauge class.

Declaration
public HitRatioGauge(IMeter hitMeter, ITimer totalTimer, Func<MeterValue, double> meterRateFunc)
Parameters
Type Name Description
IMeter hitMeter

The numerator meter to use for the ratio.

ITimer totalTimer

The denominator timer to use for the ratio.

System.Func<MeterValue, System.Double> meterRateFunc

The function to extract a value from the MeterValue. Will be applied to both the numerator and denominator meters.

Remarks

Creates a new HitRatioGauge with externally tracked Meter and Timer, and uses the provided meter rate function to extract the value for the ratio.

Back to top Copyright © 2017 Allan Hardy
Generated by DocFX