System.Logger.Class

The MonadLogger type-class and associated functions.

Documentation

data Settings

defSettings :: Settings

Default settings:

• logLevel = Debug
• output = StdOut
• format = iso8601UTC
• delimiter = ", "
• netstrings = False
• bufSize = defaultBufSize
• name = ""

logLevel :: Settings -> Level

setLogLevel :: Level -> Settings -> Settings

output :: Settings -> Output

setOutput :: Output -> Settings -> Settings

format :: Settings -> DateFormat

setFormat :: DateFormat -> Settings -> Settings

delimiter :: Settings -> ByteString

setDelimiter :: ByteString -> Settings -> Settings

netstrings :: Settings -> Bool

setNetStrings :: Bool -> Settings -> Settings

bufSize :: Settings -> Int

setBufSize :: Int -> Settings -> Settings

name :: Settings -> Text

setName :: Text -> Settings -> Settings

data Level

Constructors

Trace

Debug

Info

Warn

Error

Fatal

Instances

Eq Level

Ord Level

Read Level

Show Level

data Output

Constructors

StdOut

StdErr

Path FilePath

Instances

Eq Output

Ord Output

Show Output

data DateFormat

Instances

Eq DateFormat

Ord DateFormat

Show DateFormat

IsString DateFormat

iso8601UTC :: DateFormat

ISO 8601 date-time format.

data Logger

new :: MonadIO m => Settings -> m Logger

Create a new Logger with the given Settings. Please note that the logLevel can be dynamically adjusted by setting the environment variable LOG_LEVEL accordingly. Likewise the buffer size can be dynamically set via LOG_BUFFER and netstrings encoding can be enabled with LOG_NETSTR=True

create :: MonadIO m => Output -> m Logger

Invokes new with default settings and the given output as log sink.

level :: Logger -> Level

Inspect this logger's threshold.

flush :: MonadIO m => Logger -> m ()

Force buffered bytes to output sink.

close :: MonadIO m => Logger -> m ()

Closes the logger.

clone :: Maybe Text -> Logger -> Logger

Clone the given logger and optionally give it a name (use (Just "") to clear).

settings :: Logger -> Settings

class Monad m => MonadLogger m where

Methods

log :: Level -> (Msg -> Msg) -> m ()

trace :: MonadLogger m => (Msg -> Msg) -> m ()

Abbreviation for log using the corresponding log level.

debug :: MonadLogger m => (Msg -> Msg) -> m ()

Abbreviation for log using the corresponding log level.

info :: MonadLogger m => (Msg -> Msg) -> m ()

Abbreviation for log using the corresponding log level.

warn :: MonadLogger m => (Msg -> Msg) -> m ()

Abbreviation for log using the corresponding log level.

err :: MonadLogger m => (Msg -> Msg) -> m ()

Abbreviation for log using the corresponding log level.

fatal :: MonadLogger m => (Msg -> Msg) -> m ()

Abbreviation for log using the corresponding log level.