Instrument.ClientClass

This module mimics the functionality of Instrument.Client but instead exposes a typeclass facilitated interface. Once you define the typeclass for your application's main monad, you can call all the mesaurement functions directly.

Documentation

data Instrument

Instances

Monad m => HasInstrument (ReaderT Instrument m)

Defined in Instrument.ClientClass

Methods

getInstrument :: ReaderT Instrument m Instrument

initInstrument

Arguments

:: ConnectInfo

Redis connection info

-> InstrumentConfig

Instrument configuration. Use "def" if you don't have specific needs

-> IO Instrument

Initialize an instrument for measurement and feeding data into the system.

The resulting opaque Instrument is meant to be threaded around in your application to be later used in conjunction with sample and time.

class HasInstrument m where

Methods

getInstrument :: m Instrument

Instances

Monad m => HasInstrument (ReaderT Instrument m)

Defined in Instrument.ClientClass

Methods

getInstrument :: ReaderT Instrument m Instrument

sampleI :: (MonadIO m, HasInstrument m) => MetricName -> HostDimensionPolicy -> Dimensions -> Double -> m ()

Record a measurement sample

timeI :: (MonadIO m, HasInstrument m) => MetricName -> HostDimensionPolicy -> Dimensions -> m a -> m a

Run a monadic action while measuring its runtime

countI :: (MonadIO m, HasInstrument m) => MetricName -> HostDimensionPolicy -> Dimensions -> Int -> m ()

incrementI :: (MonadIO m, HasInstrument m) => MetricName -> HostDimensionPolicy -> Dimensions -> m ()