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

Class HitPercentageGauge

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

Constructors

HitPercentageGauge(IMeter, IMeter)

Initializes a new instance of the HitPercentageGauge class.

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

The hit meter.

IMeter totalMeter

The total meter.

Remarks

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

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

Initializes a new instance of the HitPercentageGauge class.

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

The numerator meter to use.

IMeter totalMeter

The denominator meter to use.

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 HitPercentageGauge with externally tracked Meters, and uses the provided meter rate function to extract the value for the percentage.

HitPercentageGauge(IMeter, ITimer)

Initializes a new instance of the HitPercentageGauge class.

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

The numerator meter to use.

ITimer totalTimer

The denominator meter to use.

Remarks

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

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

Initializes a new instance of the HitPercentageGauge class.

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

The numerator meter to use.

ITimer totalTimer

The denominator timer to use.

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 HitPercentageGauge with externally tracked Meter and Timer, and uses the provided meter rate function to extract the value for the percentage.

Back to top Copyright © 2017 Allan Hardy
Generated by DocFX