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

Class ApdexOptions

Apdex allows us to measure an apdex score which is a ratio of the number of satisfied and tolerating requests to the total requests made. Each satisfied request counts as one request, while each tolerating request counts as half a satisfied request.

Apdex tracks three response counts, counts based on samples measured by the chosen reservoir, defaults to a .

Inheritance
System.Object
MetricValueOptionsBase
MetricValueWithSamplingOption
ApdexOptions
Inherited Members
MetricValueWithSamplingOption.Reservoir
MetricValueOptionsBase.Context
MetricValueOptionsBase.MeasurementUnit
MetricValueOptionsBase.Name
MetricValueOptionsBase.Tags
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace:App.Metrics.Core.Options
Assembly:cs.temp.dll.dll
Syntax
public class ApdexOptions : MetricValueWithSamplingOption

Constructors

ApdexOptions()

Declaration
public ApdexOptions()

Properties

AllowWarmup

Gets or sets a value indicating whether to allow the app to warmup before calcaulting. If set to true allows the service to warmup before starting to calculate the apdex, the score will intitially be 1 until enough samples have been recorded.

Declaration
public bool AllowWarmup { get; set; }
Property Value
Type Description
System.Boolean

true if [allow warmup]; otherwise, false.

ApdexTSeconds

Gets or sets the apdex t seconds.

Satisfied, Tolerated and Frustrated request counts are calculated as follows using a user value of T seconds.

  • Satisfied: T or less
  • Tolerated: Greater than T or less than 4T
  • Frustrated: Greater than 4 T

Declaration
public double ApdexTSeconds { get; set; }
Property Value
Type Description
System.Double

The apdex T seconds used in calculating the score on the samples collected.

ResetOnReporting

Gets or sets a value indicating whether the counts and score should be reset when it is reported, otherwise values are cummulative. Note: If using more than one reporter, the count will be reset for the first reporter which sends the value. Defaults to false.

Declaration
public bool ResetOnReporting { get; set; }
Property Value
Type Description
System.Boolean

true if [reset on reporting]; otherwise, false.

See Also

MetricValueWithSamplingOption
Back to top Copyright © 2017 Allan Hardy
Generated by DocFX