Control.TimeWarp.Logging

Logging functionality. This module is wrapper over hslogger, which allows to keep logger name in monadic context. Messages are colored depending on used serverity.

Documentation

data Severity

This type is intended to be used as command line option which specifies which messages to print.

Constructors

Debug

Info

Warning

Error

Instances

Eq Severity

Methods

(==) :: Severity -> Severity -> Bool

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

Read Severity

Methods

readsPrec :: Int -> ReadS Severity

readList :: ReadS [Severity]

readPrec :: ReadPrec Severity

readListPrec :: ReadPrec [Severity]

Show Severity

Methods

showsPrec :: Int -> Severity -> ShowS

show :: Severity -> String

showList :: [Severity] -> ShowS

Generic Severity

Associated Types

type Rep Severity :: * -> *

Methods

from :: Severity -> Rep Severity x

to :: Rep Severity x -> Severity

type Rep Severity

type Rep Severity = D1 (MetaData "Severity" "Control.TimeWarp.Logging" "time-warp-0.1.1.2-85teWrozvjUJjFEayg7hld" False) ((:+:) ((:+:) (C1 (MetaCons "Debug" PrefixI False) U1) (C1 (MetaCons "Info" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Warning" PrefixI False) U1) (C1 (MetaCons "Error" PrefixI False) U1)))

initLogging :: [LoggerName] -> Severity -> IO ()

Initiates specified loggers, and sets severity of root logger's handler to Debug

initLoggerByName :: Severity -> LoggerName -> IO ()

Turns logger with specified name on. All messages are printed to stdout, moreover messages with at least Error severity are printed to stderr.

newtype LoggerName

Logger name to keep in context.

Constructors

LoggerName

Fields

• loggerName :: String

Instances

Show LoggerName

Methods

showsPrec :: Int -> LoggerName -> ShowS

show :: LoggerName -> String

showList :: [LoggerName] -> ShowS

IsString LoggerName

Methods

fromString :: String -> LoggerName

Monoid LoggerName

Defined such that n1 is parent for (n1 <> n2) (see hslogger description).

Methods

mempty :: LoggerName

mappend :: LoggerName -> LoggerName -> LoggerName

mconcat :: [LoggerName] -> LoggerName

Remove boilerplate

class WithNamedLogger m where

This type class exists to remove boilerplate logging by adding the logger's name to the context in each module.

Minimal complete definition

getLoggerName, modifyLoggerName

Methods

getLoggerName :: m LoggerName

Extract logger name from context

modifyLoggerName :: (LoggerName -> LoggerName) -> m a -> m a

Change logger name in context

Instances

Monad m => WithNamedLogger (LoggerNameBox m)

Methods

getLoggerName :: LoggerNameBox m LoggerName

modifyLoggerName :: (LoggerName -> LoggerName) -> LoggerNameBox m a -> LoggerNameBox m a

WithNamedLogger (TimedT m)

Methods

getLoggerName :: TimedT m LoggerName

modifyLoggerName :: (LoggerName -> LoggerName) -> TimedT m a -> TimedT m a

WithNamedLogger (PureRpc m)

Methods

getLoggerName :: PureRpc m LoggerName

modifyLoggerName :: (LoggerName -> LoggerName) -> PureRpc m a -> PureRpc m a

(Monad m, WithNamedLogger m) => WithNamedLogger (StateT a m)

Methods

getLoggerName :: StateT a m LoggerName

modifyLoggerName :: (LoggerName -> LoggerName) -> StateT a m a -> StateT a m a

(Monad m, WithNamedLogger m) => WithNamedLogger (ExceptT e m)

Methods

getLoggerName :: ExceptT e m LoggerName

modifyLoggerName :: (LoggerName -> LoggerName) -> ExceptT e m a -> ExceptT e m a

(Monad m, WithNamedLogger m) => WithNamedLogger (ReaderT * a m)

Methods

getLoggerName :: ReaderT * a m LoggerName

modifyLoggerName :: (LoggerName -> LoggerName) -> ReaderT * a m a -> ReaderT * a m a

(Monad m, WithNamedLogger m) => WithNamedLogger (ContT * r m)

Methods

getLoggerName :: ContT * r m LoggerName

modifyLoggerName :: (LoggerName -> LoggerName) -> ContT * r m a -> ContT * r m a

setLoggerName :: WithNamedLogger m => LoggerName -> m a -> m a

Set logger name in context.

newtype LoggerNameBox m a

Default implementation of WithNamedLogger.

Constructors

LoggerNameBox

Fields

• loggerNameBoxEntry :: ReaderT LoggerName m a

Instances

MonadTrans LoggerNameBox

Methods

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

MonadState s m => MonadState s (LoggerNameBox m)

Methods

get :: LoggerNameBox m s

put :: s -> LoggerNameBox m ()

state :: (s -> (a, s)) -> LoggerNameBox m a

MonadReader r m => MonadReader r (LoggerNameBox m)

Methods

ask :: LoggerNameBox m r

local :: (r -> r) -> LoggerNameBox m a -> LoggerNameBox m a

reader :: (r -> a) -> LoggerNameBox m a

Monad m => Monad (LoggerNameBox m)

Methods

(>>=) :: LoggerNameBox m a -> (a -> LoggerNameBox m b) -> LoggerNameBox m b

(>>) :: LoggerNameBox m a -> LoggerNameBox m b -> LoggerNameBox m b

return :: a -> LoggerNameBox m a

fail :: String -> LoggerNameBox m a

Functor m => Functor (LoggerNameBox m)

Methods

fmap :: (a -> b) -> LoggerNameBox m a -> LoggerNameBox m b

(<$) :: a -> LoggerNameBox m b -> LoggerNameBox m a

Applicative m => Applicative (LoggerNameBox m)

Methods

pure :: a -> LoggerNameBox m a

(<*>) :: LoggerNameBox m (a -> b) -> LoggerNameBox m a -> LoggerNameBox m b

(*>) :: LoggerNameBox m a -> LoggerNameBox m b -> LoggerNameBox m b

(<*) :: LoggerNameBox m a -> LoggerNameBox m b -> LoggerNameBox m a

MonadThrow m => MonadThrow (LoggerNameBox m)

Methods

throwM :: Exception e => e -> LoggerNameBox m a

MonadIO m => MonadIO (LoggerNameBox m)

Methods

liftIO :: IO a -> LoggerNameBox m a

MonadCatch m => MonadCatch (LoggerNameBox m)

Methods

catch :: Exception e => LoggerNameBox m a -> (e -> LoggerNameBox m a) -> LoggerNameBox m a

MonadMask m => MonadMask (LoggerNameBox m)

Methods

mask :: ((forall a. LoggerNameBox m a -> LoggerNameBox m a) -> LoggerNameBox m b) -> LoggerNameBox m b

uninterruptibleMask :: ((forall a. LoggerNameBox m a -> LoggerNameBox m a) -> LoggerNameBox m b) -> LoggerNameBox m b

Monad m => WithNamedLogger (LoggerNameBox m)

Methods

getLoggerName :: LoggerNameBox m LoggerName

modifyLoggerName :: (LoggerName -> LoggerName) -> LoggerNameBox m a -> LoggerNameBox m a

MonadTimed m => MonadTimed (LoggerNameBox m)

Methods

virtualTime :: LoggerNameBox m Microsecond

wait :: RelativeToNow -> LoggerNameBox m ()

fork :: LoggerNameBox m () -> LoggerNameBox m (ThreadId (LoggerNameBox m))

myThreadId :: LoggerNameBox m (ThreadId (LoggerNameBox m))

throwTo :: Exception e => ThreadId (LoggerNameBox m) -> e -> LoggerNameBox m ()

timeout :: TimeUnit t => t -> LoggerNameBox m a -> LoggerNameBox m a

MonadRpc m => MonadRpc (LoggerNameBox m)

Methods

execClient :: MessagePack a => NetworkAddress -> Client a -> LoggerNameBox m a

serve :: Port -> [Method (LoggerNameBox m)] -> LoggerNameBox m ()

type ThreadId (LoggerNameBox m)

type ThreadId (LoggerNameBox m) = ThreadId m

usingLoggerName :: LoggerName -> LoggerNameBox m a -> m a

Runs a LoggerNameBox with specified initial LoggerName.

Logging functions

logDebug :: (WithNamedLogger m, MonadIO m) => Text -> m ()

Shortcut for logMessage to use according severity.

logError :: (WithNamedLogger m, MonadIO m) => Text -> m ()

Shortcut for logMessage to use according severity.

logInfo :: (WithNamedLogger m, MonadIO m) => Text -> m ()

Shortcut for logMessage to use according severity.

logWarning :: (WithNamedLogger m, MonadIO m) => Text -> m ()

Shortcut for logMessage to use according severity.

logMessage :: (WithNamedLogger m, MonadIO m) => Severity -> Text -> m ()

Logs message with specified severity using logger name in context.