tinylog-0.14.0: Simplistic logging using fast-logger.

Safe Haskell	None
Language	Haskell2010

System.Logger.Class

Description

The MonadLogger type-class and associated functions.

Synopsis

Documentation

data Settings #

defSettings :: Settings #

Default settings:

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

logLevel :: Settings -> Level #

setLogLevel :: Level -> Settings -> Settings #

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.

setDelimiter :: ByteString -> Settings -> Settings #

netstrings :: Settings -> Bool #

Whether to use netstring encoding for log lines.

setNetStrings :: Bool -> Settings -> Settings #

bufSize :: Settings -> Int #

setBufSize :: Int -> Settings -> Settings #

name :: Settings -> Maybe Text #

setName :: Maybe Text -> Settings -> Settings #

data Level #

Constructors

Trace
Debug
Info
Warn
Error
Fatal

Instances

Eq Level #
Methods (==) :: Level -> Level -> Bool # (/=) :: Level -> Level -> Bool #
Ord Level #
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 #
Methods readsPrec :: Int -> ReadS Level # readList :: ReadS [Level] # readPrec :: ReadPrec Level # readListPrec :: ReadPrec [Level] #
Show Level #
Methods showsPrec :: Int -> Level -> ShowS # show :: Level -> String # showList :: [Level] -> ShowS #

Constructors

StdOut
StdErr
Path FilePath

Instances

Eq Output #
Methods (==) :: Output -> Output -> Bool # (/=) :: Output -> Output -> Bool #
Ord Output #
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 #
Methods showsPrec :: Int -> Output -> ShowS # show :: Output -> String # showList :: [Output] -> ShowS #

data DateFormat #

Instances

IsString DateFormat #
Methods fromString :: String -> DateFormat #

iso8601UTC :: DateFormat #

ISO 8601 date-time format.

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 #

class Monad m => MonadLogger m where #

Minimal complete definition

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.