Z.IO.Logger

Simple, high performance logger. The design choice of this logger is biased towards simplicity instead of generlization:

• All log functions lives in IO.
• By default this logger is connected to stderr, use setStdLogger to customize.
• When logging each thread will build log Builders into a small Bytes with line buffer instead of leaving all Builders to the flushing thread:
• Logger won't keep heap data for too long simply because they're referenced by log's Builder.
• Each logging thread only need perform a CAS to prepend log Bytes into a list, which reduces contention.
• Each log call is atomic, Logging order is preserved under concurrent settings.

Flushing is automatic and throttled for debug, info, warn to boost performance, but a fatal log will always flush logger's buffer. This could lead to a problem that if main thread exits too early logs may missed, to add a flushing when program exits, use withStdLogger like:

import Z.IO.Logger

main :: IO ()
main = withStdLogger $ do
    ....
    debug "..."   -- So that this log won't be missed
    ...

A simple Logger type

data Logger

data LoggerConfig

Constructors

LoggerConfig

Fields

• loggerMinFlushInterval :: !Int

  Minimal flush interval, see Notes on debug

• loggerTsCache :: IO (Builder ())

  A IO action return a formatted date/time string

• loggerLineBufSize :: !Int

  Buffer size to build each log/line

• loggerShowDebug :: Bool

  Set to False to filter debug logs

• loggerShowTS :: Bool

  Set to False to disable auto data/time string prepending

newLogger :: Output o => LoggerConfig -> MVar (BufferedOutput o) -> IO Logger

Make a new logger

loggerFlush :: Logger -> IO ()

flush logger's buffer to output device

setStdLogger :: Logger -> IO ()

Change the global logger.

getStdLogger :: IO Logger

Get the global logger.

withStdLogger :: IO () -> IO ()

Flush stderr logger when program exits.

logging functions

debug :: Builder () -> IO ()

info :: Builder () -> IO ()

warn :: Builder () -> IO ()

fatal :: Builder () -> IO ()

otherLevel

Arguments

:: Builder ()

log level

-> Bool

flush immediately?

-> Builder ()

log content

-> IO ()

logging functions with specific logger

debugWith :: Logger -> Builder () -> IO ()

infoWith :: Logger -> Builder () -> IO ()

warnWith :: Logger -> Builder () -> IO ()

fatalWith :: Logger -> Builder () -> IO ()

otherLevelWith

Arguments

:: Logger

-> Builder ()

log level

-> Bool

flush immediately?

-> Builder ()

log content

-> IO ()