Data.Metrics.Types

The main accessors for common stateful metric implementation data.

Documentation

type Minutes = Int

Histogram moving averages are tracked (by default) on minute scale.

class Count m a | a -> m where

Get the current count for the given metric.

Methods

count :: a -> m Int

retrieve a count

Instances

PrimMonad m => Count m (Timer m)

PrimMonad m => Count m (Meter m)

PrimMonad m => Count m (Histogram m)

PrimMonad m => Count m (Counter m)

class Rate m a | a -> m where

Provides statistics from a histogram that tracks the standard moving average rates.

Methods

oneMinuteRate :: a -> m Double

Get the average rate of occurrence for some sort of event for the past minute.

fiveMinuteRate :: a -> m Double

Get the average rate of occurrence for some sort of event for the past five minutes.

fifteenMinuteRate :: a -> m Double

Get the average rate of occurrence for some sort of event for the past fifteen minutes.

meanRate :: a -> m Double

Get the mean rate of occurrence for some sort of event for the entirety of the time that a has existed.

Instances

PrimMonad m => Rate m (Timer m)

PrimMonad m => Rate m (Meter m)

class Value m a v | a -> m v where

Gets the current value from a simple metric (i.e. a Counter or a Gauge)

Methods

value :: a -> m v

Instances

PrimMonad m => Value m (Gauge m) Double

PrimMonad m => Value m (Counter m) Int

class Set m a v | a -> m v where

Update a metric by performing wholesale replacement of a value.

Methods

set :: a -> v -> m ()

Replace the current value of a simple metric (i.e. a Counter or a Gauge)

Instances

PrimMonad m => Set m (Counter m) Int

PrimMonad m => Set m (Gauge m) (m Double)

class Clear m a | a -> m where

Provides a way to reset metrics. This might be useful in a development environment or to periodically get a clean state for long-running processes.

Methods

clear :: a -> m ()

Reset the metric to an empty state. In practice, this should be equivalent to creating a new metric of the same type in-place.

Instances

PrimMonad m => Clear m (Timer m)

PrimMonad m => Clear m (Histogram m)

PrimMonad m => Clear m (Counter m)

class Statistics m a | a -> m where

Provides the main interface for retrieving statistics tabulated by a histogram.

Methods

maxVal :: a -> m Double

Gets the highest value encountered thus far.

minVal :: a -> m Double

Gets the lowest value encountered thus far.

mean :: a -> m Double

Gets the current average value. This may have slightly different meanings depending on the type of MovingAverage used.

stddev :: a -> m Double

Gets the standard deviation of all values encountered this var.

variance :: a -> m Double

Gets the variance of all values encountered this var.

Instances

(Functor m, PrimMonad m) => Statistics m (Timer m)

PrimMonad m => Statistics m (Histogram m)

class Update m a v | a -> m v where

Update statistics tracked by a metric with a new sample.

Methods

update :: a -> v -> m ()

Feed a metric another value.

Instances

PrimMonad m => Update m (Timer m) Double

PrimMonad m => Update m (Histogram m) Double

class TakeSnapshot m a | a -> m where

Take a snapshot (a sorted vector) of samples used for calculating quantile data.

Methods

snapshot :: a -> m Snapshot

Get a sample of the values currently in a histogram or type that contains a histogram.

Instances

PrimMonad m => TakeSnapshot m (Timer m)

PrimMonad m => TakeSnapshot m (Histogram m)