System.Metrics.Meter

data Meter :: Type

A mutable metric which measures the rate at which a set of events occur.

newtype Summary

Summary of the measurements in the meter. Contains:

• count: count
• m1: one minute rate
• m5: five minute rate
• m15: fifteen minute rate
• mean: mean rate

Constructors

• Summary { count :: Int, m1 :: Number, m15 :: Number, m5 :: Number, mean :: Number }

Instances

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

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

Create a new meter.

markN :: forall eff. Meter -> Int -> Eff (ref :: REF | eff) Unit

Marks the meter with occurrance of n events.

mark :: forall eff. Meter -> Eff (ref :: REF | eff) Unit

Marks the meter with occurrance of one event.

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

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

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

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

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

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

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

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

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

Returns the count of the events recorded by the meter.

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

Returns the summary of the measurements in the meter.