System.Logger

Small layer on top of fast-logger which adds log-levels and timestamp support and not much more.

Settings

data Settings

defSettings :: Settings

Default settings:

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

logLevel :: Settings -> Level

setLogLevel :: Level -> Settings -> Settings

logLevelOf :: Text -> Settings -> Maybe Level

Log level of some named logger.

setLogLevelOf :: Text -> Level -> Settings -> Settings

Specify a log level for the given named logger. When a logger is cloned and given a name, the logLevel of the cloned logger will be the provided here.

output :: Settings -> Output

setOutput :: Output -> Settings -> Settings

format :: Settings -> Maybe DateFormat

The time and date format used for the timestamp part of a log line.

setFormat :: Maybe DateFormat -> Settings -> Settings

delimiter :: Settings -> ByteString

Delimiter string which separates log line parts.

readEnvironment :: Settings -> Bool

setDelimiter :: ByteString -> Settings -> Settings

setNetStrings :: Bool -> Settings -> Settings

Whether to use netstring encoding for log lines.

{-}

setReadEnvironment :: Bool -> Settings -> Settings

setRendererNetstr :: Settings -> Settings

Shortcut for calling setRenderer with renderNetstr.

setRendererDefault :: Settings -> Settings

Default rendering of log lines.

Uses the value of delimiter as a separator of fields and '=' between field names and values.

bufSize :: Settings -> Int

setBufSize :: Int -> Settings -> Settings

name :: Settings -> Maybe Text

setName :: Maybe Text -> Settings -> Settings

setRenderer :: Renderer -> Settings -> Settings

Set a custom renderer.

See setRendererDefault and setRendererNetstr for two common special cases.

renderer :: Settings -> Renderer

Output format

Type definitions

data Logger

data Level

Constructors

Trace

Debug

Info

Warn

Error

Fatal

Instances

Eq Level

Defined in System.Logger.Settings

Methods

(==) :: Level -> Level -> Bool

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

Ord Level

Defined in System.Logger.Settings

Methods

compare :: Level -> Level -> Ordering

(<) :: Level -> Level -> Bool

(<=) :: Level -> Level -> Bool

(>) :: Level -> Level -> Bool

(>=) :: Level -> Level -> Bool

max :: Level -> Level -> Level

min :: Level -> Level -> Level

Read Level

Defined in System.Logger.Settings

Methods

readsPrec :: Int -> ReadS Level

readList :: ReadS [Level]

readPrec :: ReadPrec Level

readListPrec :: ReadPrec [Level]

Show Level

Defined in System.Logger.Settings

Methods

showsPrec :: Int -> Level -> ShowS

show :: Level -> String

showList :: [Level] -> ShowS

data Output

Constructors

StdOut

StdErr

Path FilePath

Instances

Eq Output

Defined in System.Logger.Settings

Methods

(==) :: Output -> Output -> Bool

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

Ord Output

Defined in System.Logger.Settings

Methods

compare :: Output -> Output -> Ordering

(<) :: Output -> Output -> Bool

(<=) :: Output -> Output -> Bool

(>) :: Output -> Output -> Bool

(>=) :: Output -> Output -> Bool

max :: Output -> Output -> Output

min :: Output -> Output -> Output

Show Output

Defined in System.Logger.Settings

Methods

showsPrec :: Int -> Output -> ShowS

show :: Output -> String

showList :: [Output] -> ShowS

newtype DateFormat

Constructors

DateFormat

Fields

• display :: UnixTime -> ByteString

Instances

IsString DateFormat

Defined in System.Logger.Settings

Methods

fromString :: String -> DateFormat

type Renderer = ByteString -> DateFormat -> Level -> [Element] -> Builder

Take a custom separator, date format, log level of the event, and render a list of log fields or messages into a builder.

iso8601UTC :: DateFormat

ISO 8601 date-time format.

Core API

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

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 Nothing to clear).

If logLevelOf returns a custom Level for this name then the cloned logger will use it for its log messages.

settings :: Logger -> Settings

Logging

log :: MonadIO m => Logger -> Level -> (Msg -> Msg) -> m ()

Logs a message with the given level if greater or equal to the logger's threshold.

trace :: MonadIO m => Logger -> (Msg -> Msg) -> m ()

Abbreviation of log using the corresponding log level.

debug :: MonadIO m => Logger -> (Msg -> Msg) -> m ()

Abbreviation of log using the corresponding log level.

info :: MonadIO m => Logger -> (Msg -> Msg) -> m ()

Abbreviation of log using the corresponding log level.

warn :: MonadIO m => Logger -> (Msg -> Msg) -> m ()

Abbreviation of log using the corresponding log level.

err :: MonadIO m => Logger -> (Msg -> Msg) -> m ()

Abbreviation of log using the corresponding log level.

fatal :: MonadIO m => Logger -> (Msg -> Msg) -> m ()

Abbreviation of log using the corresponding log level.

module System.Logger.Message