System.Metrics.Prometheus.Ridley.Types

Documentation

newtype RidleyT t a

Constructors

Ridley (ReaderT RidleyOptions t a)

Instances

KatipContext Ridley

Defined in System.Metrics.Prometheus.Ridley.Types

Methods

getKatipContext :: Ridley LogContexts

localKatipContext :: (LogContexts -> LogContexts) -> Ridley a -> Ridley a

getKatipNamespace :: Ridley Namespace

localKatipNamespace :: (Namespace -> Namespace) -> Ridley a -> Ridley a

Katip Ridley

Defined in System.Metrics.Prometheus.Ridley.Types

Methods

getLogEnv :: Ridley LogEnv

localLogEnv :: (LogEnv -> LogEnv) -> Ridley a -> Ridley a

MonadTrans RidleyT

Defined in System.Metrics.Prometheus.Ridley.Types

Methods

lift :: Monad m => m a -> RidleyT m a

Monad t => MonadReader RidleyOptions (RidleyT t)

Defined in System.Metrics.Prometheus.Ridley.Types

Methods

ask :: RidleyT t RidleyOptions

local :: (RidleyOptions -> RidleyOptions) -> RidleyT t a -> RidleyT t a

reader :: (RidleyOptions -> a) -> RidleyT t a

Monad t => Monad (RidleyT t)

Defined in System.Metrics.Prometheus.Ridley.Types

Methods

(>>=) :: RidleyT t a -> (a -> RidleyT t b) -> RidleyT t b

(>>) :: RidleyT t a -> RidleyT t b -> RidleyT t b

return :: a -> RidleyT t a

Functor t => Functor (RidleyT t)

Defined in System.Metrics.Prometheus.Ridley.Types

Methods

fmap :: (a -> b) -> RidleyT t a -> RidleyT t b

(<$) :: a -> RidleyT t b -> RidleyT t a

Applicative t => Applicative (RidleyT t)

Defined in System.Metrics.Prometheus.Ridley.Types

Methods

pure :: a -> RidleyT t a

(<*>) :: RidleyT t (a -> b) -> RidleyT t a -> RidleyT t b

liftA2 :: (a -> b -> c) -> RidleyT t a -> RidleyT t b -> RidleyT t c

(*>) :: RidleyT t a -> RidleyT t b -> RidleyT t b

(<*) :: RidleyT t a -> RidleyT t b -> RidleyT t a

MonadIO t => MonadIO (RidleyT t)

Defined in System.Metrics.Prometheus.Ridley.Types

Methods

liftIO :: IO a -> RidleyT t a

type Ridley = RidleyT (RegistryT (KatipContextT IO))

runRidley :: RidleyOptions -> LogEnv -> Ridley a -> IO a

data RidleyCtx

Constructors

RidleyCtx ThreadId (Maybe WaiMetrics)

ridleyThreadId :: Lens' RidleyCtx ThreadId

ridleyWaiMetrics :: Lens' RidleyCtx (Maybe WaiMetrics)

type Port = Int

type PrometheusOptions = AdapterOptions

data RidleyMetric

Constructors

ProcessMemory

CPULoad

GHCConc

Tap into the metrics exposed by GHC.Conc

Network

Wai

DiskUsage

Gets stats about Disk usage (free space, etc)

CustomMetric

Fields

• !Text

  The name of the metric

• !(Maybe Int)

  An optional timeout, in microseconds, that regulates how often the metric is actually updated. If Nothing, the metric will be updated using Ridley top-level setting, if Just the underlying IO action will be run only every n seconds, or cached otherwise.

• (forall m. MonadIO m => RidleyOptions -> RegistryT m RidleyMetricHandler)

  An action to generate the handler. ^ A user-defined metric, identified by a name.

Instances

Eq RidleyMetric

Defined in System.Metrics.Prometheus.Ridley.Types

Methods

(==) :: RidleyMetric -> RidleyMetric -> Bool

(/=) :: RidleyMetric -> RidleyMetric -> Bool

Ord RidleyMetric

Defined in System.Metrics.Prometheus.Ridley.Types

Methods

compare :: RidleyMetric -> RidleyMetric -> Ordering

(<) :: RidleyMetric -> RidleyMetric -> Bool

(<=) :: RidleyMetric -> RidleyMetric -> Bool

(>) :: RidleyMetric -> RidleyMetric -> Bool

(>=) :: RidleyMetric -> RidleyMetric -> Bool

max :: RidleyMetric -> RidleyMetric -> RidleyMetric

min :: RidleyMetric -> RidleyMetric -> RidleyMetric

Show RidleyMetric

Defined in System.Metrics.Prometheus.Ridley.Types

Methods

showsPrec :: Int -> RidleyMetric -> ShowS

show :: RidleyMetric -> String

showList :: [RidleyMetric] -> ShowS

data RidleyOptions

Instances

Monad t => MonadReader RidleyOptions (RidleyT t)

Defined in System.Metrics.Prometheus.Ridley.Types

Methods

ask :: RidleyT t RidleyOptions

local :: (RidleyOptions -> RidleyOptions) -> RidleyT t a -> RidleyT t a

reader :: (RidleyOptions -> a) -> RidleyT t a

data RidleyMetricHandler

metric :: RidleyMetricHandler -> c

An opaque metric

updateMetric :: RidleyMetricHandler -> c -> Bool -> IO ()

An IO action used to update the metric

flush :: RidleyMetricHandler -> Bool

Whether or not to flush this Metric

label :: RidleyMetricHandler -> Text

A user-friendly label, used to report errors

mkRidleyMetricHandler :: forall c. HasCallStack => Text -> c -> (c -> Bool -> IO ()) -> Bool -> RidleyMetricHandler

defaultMetrics :: [RidleyMetric]

newOptions :: [(Text, Text)] -> [RidleyMetric] -> RidleyOptions

prometheusOptions :: Lens' RidleyOptions PrometheusOptions

ridleyMetrics :: Lens' RidleyOptions (Set RidleyMetric)

katipScribes :: Lens' RidleyOptions (Namespace, [(Text, Scribe)])

katipSeverity :: Lens' RidleyOptions Severity

dataRetentionPeriod :: Lens' RidleyOptions (Maybe NominalDiffTime)

runHandler :: RidleyMetricHandler -> IO ()