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

Interface IReservoirSnapshot

Provides access to a snapshot used for calculating quantile statistics.

Namespace:App.Metrics.Abstractions.ReservoirSampling
Assembly:cs.temp.dll.dll
Syntax
public interface IReservoirSnapshot

Properties

Count

Gets the number of samples that the histogram has been updated with.

Declaration
long Count { get; }
Property Value
Type Description
System.Int64

The count.

Max

Gets the maximum value of all samples

Declaration
long Max { get; }
Property Value
Type Description
System.Int64

The maximum.

MaxUserValue

Gets the maximum value which was recorded in the samples set

Declaration
string MaxUserValue { get; }
Property Value
Type Description
System.String

The maximum user value.

Mean

Gets the average of all samples since the histogram was created.

Declaration
double Mean { get; }
Property Value
Type Description
System.Double

The mean.

Median

Gets the median value of all samples

Declaration
double Median { get; }
Property Value
Type Description
System.Double

The median.

Min

Gets the minimum value of all samples.

Declaration
long Min { get; }
Property Value
Type Description
System.Int64

The minimum.

MinUserValue

Gets the minumum value which was recorded in the samples set

Declaration
string MinUserValue { get; }
Property Value
Type Description
System.String

The minimum user value.

Percentile75

Gets the 75th percentile of all samples

Declaration
double Percentile75 { get; }
Property Value
Type Description
System.Double

The percentile75.

Percentile95

Gets the 95th percentile of all samples

Declaration
double Percentile95 { get; }
Property Value
Type Description
System.Double

The percentile95.

Percentile98

Gets the 98th percentile of all samples

Declaration
double Percentile98 { get; }
Property Value
Type Description
System.Double

The percentile98.

Percentile99

Gets the 99th percentile of all samples

Declaration
double Percentile99 { get; }
Property Value
Type Description
System.Double

The percentile99.

Percentile999

Gets the 99.9th percentile of all samples

Declaration
double Percentile999 { get; }
Property Value
Type Description
System.Double

The percentile999.

Size

Gets the current size of the histogram's reservoir

Declaration
int Size { get; }
Property Value
Type Description
System.Int32

The size.

StdDev

Gets the standard deviation of all samples.

Declaration
double StdDev { get; }
Property Value
Type Description
System.Double

The standard dev.

Sum

Gets the sum of observed values.

Declaration
double Sum { get; }
Property Value
Type Description
System.Double

The sum.

Values

Gets the samples of the snapshot

Declaration
IEnumerable<long> Values { get; }
Property Value
Type Description
IEnumerable<System.Int64>

The values.

Methods

GetValue(Double)

Calculate an arbitrary quantile value for the snapshot. Values below zero or greater than one will be clamped to the range [0, 1]

Declaration
double GetValue(double quantile)
Parameters
Type Name Description
System.Double quantile

The quantile.

Returns
Type Description
System.Double

The quantile value

Back to top Copyright © 2017 Allan Hardy
Generated by DocFX