System.Metrics.Timer

newtype Timer

A timer is a histogram of the duration of a type of event and a meter of the rate of its occurrence.

newtype Summary

Summary of the measurements in the meter. Contains:

• duration: the summary of the underlying event duration histogram.
• rate: the summary of the underlying event rate meter.

Constructors

• Summary { duration :: Summary, rate :: Summary }

Instances

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

new :: forall eff. Eff (ref :: REF | eff) Timer

Creates a new timer.

update :: forall eff a. Duration a => Timer -> a -> Eff (ref :: REF | eff) Unit

Updates the timer with the duration of a new event.

time :: forall eff a. Timer -> Aff (now :: NOW, ref :: REF | eff) a -> Aff (now :: NOW, ref :: REF | eff) a

Runs and times the given function, updates the given timer with the run duration, and returns the return value of the function.

fifteenMinuteRate :: forall eff. Timer -> Eff (ref :: REF | eff) Number

Returns the fifteen minute moving average rate of the events recorded by the timer.

fiveMinuteRate :: forall eff. Timer -> Eff (ref :: REF | eff) Number

Returns the five minute moving average rate of the events recorded by the timer.

oneMinuteRate :: forall eff. Timer -> Eff (ref :: REF | eff) Number

Returns the one minute moving average rate of the events recorded by the timer.

meanRate :: forall eff. Timer -> Eff (ref :: REF | eff) Number

Returns the mean rate of the events recorded by the timer.

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

Clears the timer.

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

Returns the percentiles of the measurements in the timer for the given percentiles array.

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

Returns the mean of the measurements in the timer.

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

Returns the standard deviation of the measurements in the timer.

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

Returns the minimum of the measurements in the timer.

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

Returns the maximum of the measurements in the timer.

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

Returns the sum of the measurements in the timer.

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

Returns the count of the measurements in the timer.

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

Returns the summary of the measurements in the timer.