System.Wlog.CanLog

Type class that add ability to log messages. Supports pure and IO logging.

Documentation

class Monad m => CanLog m where

Instances of this class should explain how they add messages to their log.

Methods

dispatchMessage :: LoggerName -> Severity -> Text -> m ()

dispatchMessage :: (MonadTrans t, t n ~ m, CanLog n) => LoggerName -> Severity -> Text -> t n ()

Instances

CanLog IO

Methods

dispatchMessage :: LoggerName -> Severity -> Text -> IO ()

CanLog m => CanLog (LoggerNameBox m)

Methods

dispatchMessage :: LoggerName -> Severity -> Text -> LoggerNameBox m ()

Monad m => CanLog (NamedPureLogger m)

Methods

dispatchMessage :: LoggerName -> Severity -> Text -> NamedPureLogger m ()

Monad m => CanLog (PureLogger m)

Methods

dispatchMessage :: LoggerName -> Severity -> Text -> PureLogger m ()

CanLog m => CanLog (StateT s m)

Methods

dispatchMessage :: LoggerName -> Severity -> Text -> StateT s m ()

CanLog m => CanLog (StateT s m)

Methods

dispatchMessage :: LoggerName -> Severity -> Text -> StateT s m ()

CanLog m => CanLog (ExceptT s m)

Methods

dispatchMessage :: LoggerName -> Severity -> Text -> ExceptT s m ()

CanLog m => CanLog (ReaderT * r m)

Methods

dispatchMessage :: LoggerName -> Severity -> Text -> ReaderT * r m ()

(CanLog m, Monoid w) => CanLog (RWST r w s m)

Methods

dispatchMessage :: LoggerName -> Severity -> Text -> RWST r w s m ()

(CanLog m, Monoid w) => CanLog (RWST r w s m)

Methods

dispatchMessage :: LoggerName -> Severity -> Text -> RWST r w s m ()

type WithLogger m = (CanLog m, HasLoggerName m)

Type alias for constraints CanLog and HasLoggerName. We need two different type classes to support more flexible interface but in practice we usually use them both.

memoryLogs :: MVar (Maybe (LogMemoryQueue, Maybe Int))

readMemoryLogs :: MonadIO m => m [Text]

Retrieves memory logs in reversed order (newest are head).

Pure logging manipulation

newtype PureLogger m a

Pure implementation of CanLog type class. Instead of writing log messages into console it appends log messages into WriterT log. It uses DList for better performance, because messages can be added only at the end of log. But it uses unsafePerformIO so use with caution within IO.

TODO: Should we use some Data.Tree-like structure to observe message only by chosen logger names?

Constructors

PureLogger

Fields

• runPureLogger :: WriterT (DList LogEvent) m a

Instances

MFunctor PureLogger

Methods

hoist :: Monad m => (forall a. m a -> n a) -> PureLogger m b -> PureLogger n b

MonadTrans PureLogger

Methods

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

MonadState s m => MonadState s (PureLogger m)

Methods

get :: PureLogger m s

put :: s -> PureLogger m ()

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

MonadReader r m => MonadReader r (PureLogger m)

Methods

ask :: PureLogger m r

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

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

MonadError e m => MonadError e (PureLogger m)

Methods

throwError :: e -> PureLogger m a

catchError :: PureLogger m a -> (e -> PureLogger m a) -> PureLogger m a

MonadBase b m => MonadBase b (PureLogger m)

Methods

liftBase :: b α -> PureLogger m α

Monad m => Monad (PureLogger m)

Methods

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

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

return :: a -> PureLogger m a

fail :: String -> PureLogger m a

Functor m => Functor (PureLogger m)

Methods

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

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

Applicative m => Applicative (PureLogger m)

Methods

pure :: a -> PureLogger m a

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

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

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

MonadThrow m => MonadThrow (PureLogger m)

Methods

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

(HasLoggerName m, Monad m) => HasLoggerName (PureLogger m)

Methods

getLoggerName :: PureLogger m LoggerName

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

Monad m => CanLog (PureLogger m)

Methods

dispatchMessage :: LoggerName -> Severity -> Text -> PureLogger m ()

Monad m => MonadWriter (DList LogEvent) (PureLogger m)

Methods

writer :: (a, DList LogEvent) -> PureLogger m a

tell :: DList LogEvent -> PureLogger m ()

listen :: PureLogger m a -> PureLogger m (a, DList LogEvent)

pass :: PureLogger m (a, DList LogEvent -> DList LogEvent) -> PureLogger m a

data LogEvent

Holds all required information for dispatchLoggerName function.

Constructors

LogEvent

Fields

• leLoggerName :: !LoggerName
• leSeverity :: !Severity
• leMessage :: !Text

Instances

Show LogEvent

Methods

showsPrec :: Int -> LogEvent -> ShowS

show :: LogEvent -> String

showList :: [LogEvent] -> ShowS

SafeCopy LogEvent

Methods

version :: Version LogEvent

kind :: Kind LogEvent

getCopy :: Contained (Get LogEvent)

putCopy :: LogEvent -> Contained Put

internalConsistency :: Consistency LogEvent

objectProfile :: Profile LogEvent

errorTypeName :: Proxy LogEvent -> String

Monad m => MonadWriter (DList LogEvent) (NamedPureLogger m)

Methods

writer :: (a, DList LogEvent) -> NamedPureLogger m a

tell :: DList LogEvent -> NamedPureLogger m ()

listen :: NamedPureLogger m a -> NamedPureLogger m (a, DList LogEvent)

pass :: NamedPureLogger m (a, DList LogEvent -> DList LogEvent) -> NamedPureLogger m a

Monad m => MonadWriter (DList LogEvent) (PureLogger m)

Methods

writer :: (a, DList LogEvent) -> PureLogger m a

tell :: DList LogEvent -> PureLogger m ()

listen :: PureLogger m a -> PureLogger m (a, DList LogEvent)

pass :: PureLogger m (a, DList LogEvent -> DList LogEvent) -> PureLogger m a

dispatchEvents :: CanLog m => [LogEvent] -> m ()

Logs all LogEvent's from given list. This function supposed to be used after runPureLog.

runPureLog :: Monad m => PureLogger m a -> m (a, [LogEvent])

Return log of pure logging action as list of LogEvent.

launchPureLog :: (CanLog n, Monad m) => (forall f. Functor f => m (f a) -> n (f b)) -> PureLogger m a -> n b

Performs actual logging once given action completes.

newtype NamedPureLogger m a

Constructors

NamedPureLogger

Fields

• runNamedPureLogger :: PureLogger (LoggerNameBox m) a

Instances

MFunctor NamedPureLogger

Methods

hoist :: Monad m => (forall a. m a -> n a) -> NamedPureLogger m b -> NamedPureLogger n b

MonadTrans NamedPureLogger

Methods

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

MonadState s m => MonadState s (NamedPureLogger m)

Methods

get :: NamedPureLogger m s

put :: s -> NamedPureLogger m ()

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

MonadReader r m => MonadReader r (NamedPureLogger m)

Methods

ask :: NamedPureLogger m r

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

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

MonadError e m => MonadError e (NamedPureLogger m)

Methods

throwError :: e -> NamedPureLogger m a

catchError :: NamedPureLogger m a -> (e -> NamedPureLogger m a) -> NamedPureLogger m a

MonadBase b m => MonadBase b (NamedPureLogger m)

Methods

liftBase :: b α -> NamedPureLogger m α

Monad m => Monad (NamedPureLogger m)

Methods

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

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

return :: a -> NamedPureLogger m a

fail :: String -> NamedPureLogger m a

Functor m => Functor (NamedPureLogger m)

Methods

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

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

Applicative m => Applicative (NamedPureLogger m)

Methods

pure :: a -> NamedPureLogger m a

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

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

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

MonadThrow m => MonadThrow (NamedPureLogger m)

Methods

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

Monad m => HasLoggerName (NamedPureLogger m)

Methods

getLoggerName :: NamedPureLogger m LoggerName

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

Monad m => CanLog (NamedPureLogger m)

Methods

dispatchMessage :: LoggerName -> Severity -> Text -> NamedPureLogger m ()

Monad m => MonadWriter (DList LogEvent) (NamedPureLogger m)

Methods

writer :: (a, DList LogEvent) -> NamedPureLogger m a

tell :: DList LogEvent -> NamedPureLogger m ()

listen :: NamedPureLogger m a -> NamedPureLogger m (a, DList LogEvent)

pass :: NamedPureLogger m (a, DList LogEvent -> DList LogEvent) -> NamedPureLogger m a

runNamedPureLog :: (Monad m, HasLoggerName m) => NamedPureLogger m a -> m (a, [LogEvent])

Return log of pure logging action as list of LogEvent, using logger name provided by context.

launchNamedPureLog :: (WithLogger n, Monad m) => (forall f. Functor f => m (f a) -> n (f b)) -> NamedPureLogger m a -> n b

Similar as launchPureLog, but provides logger name from current context.

Logging functions

logDebug :: WithLogger m => Text -> m ()

Shortcut for logMessage to use according severity.

logError :: WithLogger m => Text -> m ()

Shortcut for logMessage to use according severity.

logInfo :: WithLogger m => Text -> m ()

Shortcut for logMessage to use according severity.

logNotice :: WithLogger m => Text -> m ()

Shortcut for logMessage to use according severity.

logWarning :: WithLogger m => Text -> m ()

Shortcut for logMessage to use according severity.

logMessage :: WithLogger m => Severity -> Text -> m ()

Logs message with specified severity using logger name in context.