Safe Haskell	None
Language	Haskell2010

Raft.Logging

Synopsis

data LogCtx m
- = LogCtx {
  - logCtxDest :: LogDest m
  - logCtxSeverity :: Severity
  }
- | NoLogs
data LogDest m
- = LogWith (MonadIO m => Severity -> Text -> m ())
- | LogFile FilePath
- | LogStdout
data Severity
- = Debug
- | Info
- | Critical
data LogMsg = LogMsg {
- mTime :: Maybe SystemTime
- severity :: Severity
- logMsgData :: LogMsgData
}
data LogMsgData = LogMsgData {
- logMsgNodeId :: NodeId
- logMsgNodeState :: Mode
- logMsg :: Text
}
logMsgToText :: LogMsg -> Text
logMsgDataToText :: LogMsgData -> Text
class Monad m => RaftLogger v m | m -> v where
- loggerCtx :: m (NodeId, RaftNodeState v)
mkLogMsgData :: RaftLogger v m => Text -> m LogMsgData
logToDest :: MonadIO m => LogCtx m -> LogMsg -> m ()
logToStdout :: MonadIO m => Severity -> LogMsg -> m ()
logToFile :: MonadIO m => FilePath -> Severity -> LogMsg -> m ()
logWithSeverityIO :: forall m v. (RaftLogger v m, MonadIO m) => Severity -> LogCtx m -> Text -> m ()
logInfoIO :: (RaftLogger v m, MonadIO m) => LogCtx m -> Text -> m ()
logDebugIO :: (RaftLogger v m, MonadIO m) => LogCtx m -> Text -> m ()
logCriticalIO :: (RaftLogger v m, MonadIO m) => LogCtx m -> Text -> m ()
newtype RaftLoggerT v m a = RaftLoggerT {
- unRaftLoggerT :: StateT [LogMsg] m a
}
runRaftLoggerT :: Monad m => RaftLoggerT v m a -> m (a, [LogMsg])
type RaftLoggerM v = RaftLoggerT v Identity
runRaftLoggerM :: RaftLoggerM v a -> (a, [LogMsg])
logWithSeverity :: RaftLogger v m => Severity -> Text -> RaftLoggerT v m ()
logInfo :: RaftLogger v m => Text -> RaftLoggerT v m ()
logDebug :: RaftLogger v m => Text -> RaftLoggerT v m ()
logCritical :: RaftLogger v m => Text -> RaftLoggerT v m ()
logAndPanic :: RaftLogger v m => Text -> m a
logAndPanicIO :: (RaftLogger v m, MonadIO m) => LogCtx m -> Text -> m a

Documentation

data LogCtx m Source #

Representation of the logs' context

Constructors

LogCtx
Fields logCtxDest :: LogDest m logCtxSeverity :: Severity
NoLogs

data LogDest m Source #

Representation of the logs' destination

Constructors

LogWith (MonadIO m => Severity -> Text -> m ())
LogFile FilePath
LogStdout

data Severity Source #

Representation of the severity of the logs

Constructors

Debug
Info
Critical

Instances

Eq Severity Source #
Instance details Defined in Raft.Logging Methods (==) :: Severity -> Severity -> Bool # (/=) :: Severity -> Severity -> Bool #
Ord Severity Source #
Instance details Defined in Raft.Logging Methods compare :: Severity -> Severity -> Ordering # (<) :: Severity -> Severity -> Bool # (<=) :: Severity -> Severity -> Bool # (>) :: Severity -> Severity -> Bool # (>=) :: Severity -> Severity -> Bool # max :: Severity -> Severity -> Severity # min :: Severity -> Severity -> Severity #
Show Severity Source #
Instance details Defined in Raft.Logging Methods showsPrec :: Int -> Severity -> ShowS # show :: Severity -> String # showList :: [Severity] -> ShowS #

data LogMsg Source #

Constructors

LogMsg
Fields mTime :: Maybe SystemTime severity :: Severity logMsgData :: LogMsgData

Instances

Show LogMsg Source #
Instance details Defined in Raft.Logging Methods showsPrec :: Int -> LogMsg -> ShowS # show :: LogMsg -> String # showList :: [LogMsg] -> ShowS #
Monad m => MonadState [LogMsg] (RaftLoggerT v m) Source #
Instance details Defined in Raft.Logging Methods get :: RaftLoggerT v m [LogMsg] # put :: [LogMsg] -> RaftLoggerT v m () # state :: ([LogMsg] -> (a, [LogMsg])) -> RaftLoggerT v m a #

data LogMsgData Source #

Constructors

LogMsgData
Fields logMsgNodeId :: NodeId logMsgNodeState :: Mode logMsg :: Text

Instances

Show LogMsgData Source #
Instance details Defined in Raft.Logging Methods showsPrec :: Int -> LogMsgData -> ShowS # show :: LogMsgData -> String # showList :: [LogMsgData] -> ShowS #

logMsgToText :: LogMsg -> Text Source #

logMsgDataToText :: LogMsgData -> Text Source #

class Monad m => RaftLogger v m | m -> v where Source #

Methods

loggerCtx :: m (NodeId, RaftNodeState v) Source #

Instances

RaftLogger v m => RaftLogger v (RaftLoggerT v m) Source #
Instance details Defined in Raft.Logging Methods loggerCtx :: RaftLoggerT v m (NodeId, RaftNodeState v) Source #
Monad m => RaftLogger v (RaftT v m) Source #
Instance details Defined in Raft.Monad Methods loggerCtx :: RaftT v m (NodeId, RaftNodeState v) Source #
RaftLogger v (RWS (TransitionEnv sm v) [Action sm v] PersistentState) Source #
Instance details Defined in Raft.Transition Methods loggerCtx :: RWS (TransitionEnv sm v) [Action sm v] PersistentState (NodeId, RaftNodeState v) Source #

mkLogMsgData :: RaftLogger v m => Text -> m LogMsgData Source #

logToDest :: MonadIO m => LogCtx m -> LogMsg -> m () Source #

logToStdout :: MonadIO m => Severity -> LogMsg -> m () Source #

logToFile :: MonadIO m => FilePath -> Severity -> LogMsg -> m () Source #

logWithSeverityIO :: forall m v. (RaftLogger v m, MonadIO m) => Severity -> LogCtx m -> Text -> m () Source #

logInfoIO :: (RaftLogger v m, MonadIO m) => LogCtx m -> Text -> m () Source #

logDebugIO :: (RaftLogger v m, MonadIO m) => LogCtx m -> Text -> m () Source #

logCriticalIO :: (RaftLogger v m, MonadIO m) => LogCtx m -> Text -> m () Source #

newtype RaftLoggerT v m a Source #

Constructors

RaftLoggerT
Fields unRaftLoggerT :: StateT [LogMsg] m a

Instances

RaftLogger v m => RaftLogger v (RaftLoggerT v m) Source #
Instance details Defined in Raft.Logging Methods loggerCtx :: RaftLoggerT v m (NodeId, RaftNodeState v) Source #
MonadTrans (RaftLoggerT v) Source #
Instance details Defined in Raft.Logging Methods lift :: Monad m => m a -> RaftLoggerT v m a #
Monad m => MonadState [LogMsg] (RaftLoggerT v m) Source #
Instance details Defined in Raft.Logging Methods get :: RaftLoggerT v m [LogMsg] # put :: [LogMsg] -> RaftLoggerT v m () # state :: ([LogMsg] -> (a, [LogMsg])) -> RaftLoggerT v m a #
Monad m => Monad (RaftLoggerT v m) Source #
Instance details Defined in Raft.Logging Methods (>>=) :: RaftLoggerT v m a -> (a -> RaftLoggerT v m b) -> RaftLoggerT v m b # (>>) :: RaftLoggerT v m a -> RaftLoggerT v m b -> RaftLoggerT v m b # return :: a -> RaftLoggerT v m a # fail :: String -> RaftLoggerT v m a #
Functor m => Functor (RaftLoggerT v m) Source #
Instance details Defined in Raft.Logging Methods fmap :: (a -> b) -> RaftLoggerT v m a -> RaftLoggerT v m b # (<$) :: a -> RaftLoggerT v m b -> RaftLoggerT v m a #
Monad m => Applicative (RaftLoggerT v m) Source #
Instance details Defined in Raft.Logging Methods pure :: a -> RaftLoggerT v m a # (<>) :: RaftLoggerT v m (a -> b) -> RaftLoggerT v m a -> RaftLoggerT v m b # liftA2 :: (a -> b -> c) -> RaftLoggerT v m a -> RaftLoggerT v m b -> RaftLoggerT v m c # (>) :: RaftLoggerT v m a -> RaftLoggerT v m b -> RaftLoggerT v m b # (<*) :: RaftLoggerT v m a -> RaftLoggerT v m b -> RaftLoggerT v m a #

runRaftLoggerT Source #

Arguments

:: Monad m
=> RaftLoggerT v m a	The computation from which to extract the logs
-> m (a, [LogMsg])

type RaftLoggerM v = RaftLoggerT v Identity Source #

runRaftLoggerM :: RaftLoggerM v a -> (a, [LogMsg]) Source #

logWithSeverity :: RaftLogger v m => Severity -> Text -> RaftLoggerT v m () Source #

logInfo :: RaftLogger v m => Text -> RaftLoggerT v m () Source #

logDebug :: RaftLogger v m => Text -> RaftLoggerT v m () Source #

logCritical :: RaftLogger v m => Text -> RaftLoggerT v m () Source #

logAndPanic :: RaftLogger v m => Text -> m a Source #

logAndPanicIO :: (RaftLogger v m, MonadIO m) => LogCtx m -> Text -> m a Source #