Safe Haskell | None |
---|---|
Language | Haskell98 |
Quick example of how to use this module:
@import Control.Logging
main = withStdoutLogging $ do log "This is a log message!" timedLog "This is a timed log message!" $ threadDelay 100000 @
- log :: MonadLogger m => Text -> m ()
- log' :: (MonadLogger m, MonadIO m) => Text -> m ()
- logS :: MonadLogger m => Text -> Text -> m ()
- logS' :: (MonadLogger m, MonadIO m) => Text -> Text -> m ()
- warn :: MonadLogger m => Text -> m ()
- warn' :: (MonadLogger m, MonadIO m) => Text -> m ()
- warnS :: MonadLogger m => Text -> Text -> m ()
- warnS' :: (MonadLogger m, MonadIO m) => Text -> Text -> m ()
- debug :: MonadLogger m => Text -> m ()
- debug' :: (MonadLogger m, MonadIO m) => Text -> m ()
- debugS :: MonadLogger m => Text -> Text -> m ()
- debugS' :: (MonadLogger m, MonadIO m) => Text -> Text -> m ()
- errorL :: Text -> a
- errorL' :: Text -> a
- errorSL :: Text -> Text -> a
- errorSL' :: Text -> Text -> a
- traceL :: Text -> a -> a
- traceL' :: Text -> a -> a
- traceSL :: Text -> Text -> a -> a
- traceSL' :: Text -> Text -> a -> a
- traceShowL :: Show a => a -> a1 -> a1
- traceShowL' :: Show a => a -> a1 -> a1
- traceShowSL :: Show a => Text -> a -> a1 -> a1
- traceShowSL' :: Show a => Text -> a -> a1 -> a1
- timedLog :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> m a -> m a
- timedLog' :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> m a -> m a
- timedLogS :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> Text -> m a -> m a
- timedLogS' :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> Text -> m a -> m a
- timedLogEnd :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> m a -> m a
- timedLogEnd' :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> m a -> m a
- timedLogEndS :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> Text -> m a -> m a
- timedLogEndS' :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> Text -> m a -> m a
- timedDebug :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> m a -> m a
- timedDebug' :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> m a -> m a
- timedDebugS :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> Text -> m a -> m a
- timedDebugS' :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> Text -> m a -> m a
- timedDebugEnd :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> m a -> m a
- timedDebugEnd' :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> m a -> m a
- timedDebugEndS :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> Text -> m a -> m a
- timedDebugEndS' :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> Text -> m a -> m a
- withStdoutLogging :: (MonadBaseControl IO m, MonadIO m) => m a -> m a
- withStderrLogging :: (MonadBaseControl IO m, MonadIO m) => m a -> m a
- withFileLogging :: (MonadBaseControl IO m, MonadIO m) => FilePath -> m a -> m a
- flushLog :: MonadIO m => m ()
- loggingLogger :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> IO ()
- setLogLevel :: LogLevel -> IO ()
- setLogTimeFormat :: String -> IO ()
- setDebugSourceRegex :: String -> IO ()
Documentation
log :: MonadLogger m => Text -> m () Source
Synonym for logInfoN
. This module provides a
MonadLogger
instance for IO, so this function can be used directly in
IO. The only requirement is that you must surround the body of your
main
function with a call to withStdoutLogging
or
withStderrLogging
, to ensure that all logging buffers are properly
flushed on exit.
log' :: (MonadLogger m, MonadIO m) => Text -> m () Source
The apostrophe varients of the logging functions flush the log after each message.
logS :: MonadLogger m => Text -> Text -> m () Source
warn :: MonadLogger m => Text -> m () Source
warn' :: (MonadLogger m, MonadIO m) => Text -> m () Source
warnS :: MonadLogger m => Text -> Text -> m () Source
debug :: MonadLogger m => Text -> m () Source
debug' :: (MonadLogger m, MonadIO m) => Text -> m () Source
debugS :: MonadLogger m => Text -> Text -> m () Source
A logging variant of error
which uses unsafePerformIO
to output a log
message before calling error
.
traceShowL :: Show a => a -> a1 -> a1 Source
traceShowL' :: Show a => a -> a1 -> a1 Source
traceShowSL :: Show a => Text -> a -> a1 -> a1 Source
traceShowSL' :: Show a => Text -> a -> a1 -> a1 Source
timedLog :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> m a -> m a Source
Output a logging message both before an action begins, and after it ends, reporting the total length of time. If an exception occurred, it is also reported.
timedLog' :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> m a -> m a Source
timedLogS :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> Text -> m a -> m a Source
timedLogS' :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> Text -> m a -> m a Source
timedLogEnd :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> m a -> m a Source
Like timedLog
, except that it does only logs when the action has
completed or failed after it is done.
timedLogEnd' :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> m a -> m a Source
timedLogEndS :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> Text -> m a -> m a Source
timedLogEndS' :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> Text -> m a -> m a Source
timedDebug :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> m a -> m a Source
A debug variant of timedLog
.
timedDebug' :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> m a -> m a Source
timedDebugS :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> Text -> m a -> m a Source
timedDebugS' :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> Text -> m a -> m a Source
timedDebugEnd :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> m a -> m a Source
timedDebugEnd' :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> m a -> m a Source
timedDebugEndS :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> Text -> m a -> m a Source
timedDebugEndS' :: (MonadLogger m, MonadBaseControl IO m, MonadIO m) => Text -> Text -> m a -> m a Source
withStdoutLogging :: (MonadBaseControl IO m, MonadIO m) => m a -> m a Source
This function, or withStderrLogging
, must be wrapped around whatever
region of your application intends to use logging. Typically it would be
wrapped around the body of main
.
withStderrLogging :: (MonadBaseControl IO m, MonadIO m) => m a -> m a Source
withFileLogging :: (MonadBaseControl IO m, MonadIO m) => FilePath -> m a -> m a Source
flushLog :: MonadIO m => m () Source
Flush all collected logging messages. This is automatically called by
withStdoutLogging
and withStderrLogging
when those blocks are exited
by whatever means.
loggingLogger :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> IO () Source
This function is used to implement monadLoggerLog
for the IO instance.
You may reuse it if you wish, or it can be passed as an argument to
runLoggingT
-- in which case you must remember to call flushLog
before the program exits.
setLogLevel :: LogLevel -> IO () Source
Set the verbosity level. Messages at our higher than this level are
displayed. It defaults to LevelDebug
.
setLogTimeFormat :: String -> IO () Source
Set the format used for log timestamps.
setDebugSourceRegex :: String -> IO () Source
When printing LevelDebug
messages, only display those matching the
given regexp applied to the Source parameter. Calls to debug
without a
source parameter are regarded as having a source of ""
.