System.Metrics.Histogram

data Histogram :: Type

A mutable distribution of values in a stream of data.

newtype Summary

Summary of the distribution of the measurements in the histogram. Contains:

• min: minimum
• max: maximum
• sum: sum
• variance: variance
• mean: mean
• stdDev: standard deviation
• count: count
• median: median
• p75: 75th percentile
• p95: 95th percentile
• p99: 99th percentile
• p999: 99.9th percentile

Constructors

• Summary { count :: Int, max :: Maybe Number, mean :: Maybe Number, median :: Maybe Number, min :: Maybe Number, p75 :: Maybe Number, p95 :: Maybe Number, p99 :: Maybe Number, p999 :: Maybe Number, stdDev :: Maybe Number, sum :: Maybe Number, variance :: Maybe Number }

Instances

• Eq Summary
• Generic Summary _
• Show Summary
• Encode Summary

newWithExponentialDecaySampling :: forall eff. Int -> Number -> Eff (ref :: REF | eff) Histogram

Creates a new histogram with exponential decay sampling with given size and alpha.

newWithUniformSampling :: forall eff. Int -> Eff (ref :: REF | eff) Histogram

Creates a new histogram with uniform sampling with the given size.

clear :: forall eff. Histogram -> Eff (ref :: REF | eff) Unit

Clears the histogram.

update :: forall eff. Histogram -> Number -> Eff (ref :: REF | eff) Unit

Updates the histogram with the given measurement.

percentiles :: forall eff. Histogram -> Array Number -> Eff (ref :: REF | eff) (Maybe (Array Number))

Returns the percentiles of the measurements in the histogram for the given percentiles array. Returns 'Nothing' if there are no measurements.

variance :: forall eff. Histogram -> Eff (ref :: REF | eff) (Maybe Number)

Returns the variance of the measurements in the histogram. Returns 'Nothing' if there are no measurements.

mean :: forall eff. Histogram -> Eff (ref :: REF | eff) (Maybe Number)

Returns the mean of the measurements in the histogram. Returns 'Nothing' if there are no measurements.

stdDev :: forall eff. Histogram -> Eff (ref :: REF | eff) (Maybe Number)

Returns the standard deviation of the measurements in the histogram. Returns 'Nothing' if there are no measurements.

min :: forall eff. Histogram -> Eff (ref :: REF | eff) (Maybe Number)

Returns the minimum of the measurements in the histogram. Returns 'Nothing' if there are no measurements.

max :: forall eff. Histogram -> Eff (ref :: REF | eff) (Maybe Number)

Returns the maximum of the measurements in the histogram. Returns 'Nothing' if there are no measurements.

sum :: forall eff. Histogram -> Eff (ref :: REF | eff) (Maybe Number)

Returns the sum of the measurements in the histogram. Returns 'Nothing' if there are no measurements.

count :: forall eff. Histogram -> Eff (ref :: REF | eff) Int

Returns the count of measurements in the histogram.

read :: forall eff. Histogram -> Eff (ref :: REF | eff) Summary

Returns the summary of the measurements in the histogram.