Safe Haskell	Safe-Inferred
Language	Haskell2010

System.Metrics.Prometheus.Ridley.Types

Synopsis

newtype RidleyT t a = Ridley (ReaderT RidleyOptions t a)
type Ridley = RidleyT (RegistryT (KatipContextT IO))
runRidley :: RidleyOptions -> LogEnv -> Ridley a -> IO a
data RidleyCtx = RidleyCtx ThreadId (Maybe WaiMetrics)
ridleyThreadId :: Lens' RidleyCtx ThreadId
ridleyWaiMetrics :: Lens' RidleyCtx (Maybe WaiMetrics)
type Port = Int
type PrometheusOptions = AdapterOptions
data RidleyMetric
- = ProcessMemory
- | CPULoad
- | GHCConc
- | Network
- | Wai
- | DiskUsage
- | CustomMetric !Text !(Maybe Int) (forall m. MonadIO m => RidleyOptions -> RegistryT m RidleyMetricHandler)
data RidleyOptions
data RidleyMetricHandler
metric :: RidleyMetricHandler -> c
updateMetric :: RidleyMetricHandler -> c -> Bool -> IO ()
flush :: RidleyMetricHandler -> Bool
label :: RidleyMetricHandler -> Text
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 ()
ioLogger :: Ridley Logger
getRidleyOptions :: Ridley RidleyOptions
noUpdate :: c -> Bool -> IO ()

Documentation

newtype RidleyT t a Source #

Constructors

Ridley (ReaderT RidleyOptions t a)

Instances

Instances details

MonadCatch Ridley Source #
Instance details Defined in System.Metrics.Prometheus.Ridley.Types Methods catch :: Exception e => Ridley a -> (e -> Ridley a) -> Ridley a #
MonadThrow Ridley Source #
Instance details Defined in System.Metrics.Prometheus.Ridley.Types Methods throwM :: Exception e => e -> Ridley a #
Katip Ridley Source #
Instance details Defined in System.Metrics.Prometheus.Ridley.Types Methods getLogEnv :: Ridley LogEnv # localLogEnv :: (LogEnv -> LogEnv) -> Ridley a -> Ridley a #
KatipContext Ridley Source #
Instance details 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 #
MonadTrans RidleyT Source #
Instance details Defined in System.Metrics.Prometheus.Ridley.Types Methods lift :: Monad m => m a -> RidleyT m a #
Monad t => MonadReader RidleyOptions (RidleyT t) Source #
Instance details 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 #
MonadIO t => MonadIO (RidleyT t) Source #
Instance details Defined in System.Metrics.Prometheus.Ridley.Types Methods liftIO :: IO a -> RidleyT t a #
Applicative t => Applicative (RidleyT t) Source #
Instance details 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 #
Functor t => Functor (RidleyT t) Source #
Instance details Defined in System.Metrics.Prometheus.Ridley.Types Methods fmap :: (a -> b) -> RidleyT t a -> RidleyT t b # (<$) :: a -> RidleyT t b -> RidleyT t a #
Monad t => Monad (RidleyT t) Source #
Instance details 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 #

type Ridley = RidleyT (RegistryT (KatipContextT IO)) Source #

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

data RidleyCtx Source #

Constructors

RidleyCtx ThreadId (Maybe WaiMetrics)

ridleyThreadId :: Lens' RidleyCtx ThreadId Source #

ridleyWaiMetrics :: Lens' RidleyCtx (Maybe WaiMetrics) Source #

type Port = Int Source #

type PrometheusOptions = AdapterOptions Source #

data RidleyMetric Source #

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

Instances details

Show RidleyMetric Source #
Instance details Defined in System.Metrics.Prometheus.Ridley.Types Methods showsPrec :: Int -> RidleyMetric -> ShowS # show :: RidleyMetric -> String # showList :: [RidleyMetric] -> ShowS #
Eq RidleyMetric Source #
Instance details Defined in System.Metrics.Prometheus.Ridley.Types Methods (==) :: RidleyMetric -> RidleyMetric -> Bool # (/=) :: RidleyMetric -> RidleyMetric -> Bool #
Ord RidleyMetric Source #
Instance details 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 #

data RidleyOptions Source #

Instances

Instances details

Monad t => MonadReader RidleyOptions (RidleyT t) Source #
Instance details 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 Source #

metric :: RidleyMetricHandler -> c Source #

An opaque metric

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

An IO action used to update the metric

flush :: RidleyMetricHandler -> Bool Source #

Whether or not to flush this Metric

label :: RidleyMetricHandler -> Text Source #

A user-friendly label, used to report errors

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

defaultMetrics :: [RidleyMetric] Source #

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

prometheusOptions :: Lens' RidleyOptions PrometheusOptions Source #

ridleyMetrics :: Lens' RidleyOptions (Set RidleyMetric) Source #

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

katipSeverity :: Lens' RidleyOptions Severity Source #

dataRetentionPeriod :: Lens' RidleyOptions (Maybe NominalDiffTime) Source #

runHandler :: RidleyMetricHandler -> IO () Source #

ioLogger :: Ridley Logger Source #

Returns an IO logger which uses context defined in the RidleyT monad. Useful when we want to use an IO logger in the update functions for the handlers, which run in plain IO.

getRidleyOptions :: Ridley RidleyOptions Source #

noUpdate :: c -> Bool -> IO () Source #