tinylog-0.15.0: Simplistic logging using fast-logger.

Safe Haskell	Safe-Inferred
Language	Haskell2010

System.Logger.Class

Description

The MonadLogger type-class and associated functions.

Synopsis

data Settings
type Renderer = ByteString -> DateFormat -> Level -> [Element] -> Builder
defSettings :: Settings
logLevel :: Settings -> Level
setLogLevel :: Level -> Settings -> Settings
output :: Settings -> Output
setOutput :: Output -> Settings -> Settings
format :: Settings -> Maybe DateFormat
setFormat :: Maybe DateFormat -> Settings -> Settings
delimiter :: Settings -> ByteString
setDelimiter :: ByteString -> Settings -> Settings
setNetStrings :: Bool -> Settings -> Settings
bufSize :: Settings -> Int
setBufSize :: Int -> Settings -> Settings
name :: Settings -> Maybe Text
setName :: Maybe Text -> Settings -> Settings
setRenderer :: Renderer -> Settings -> Settings
renderer :: Settings -> Renderer
data Level
- = Trace
- | Debug
- | Info
- | Warn
- | Error
- | Fatal
data Output
- = StdOut
- | StdErr
- | Path FilePath
data DateFormat
iso8601UTC :: DateFormat
data Logger
new :: MonadIO m => Settings -> m Logger
create :: MonadIO m => Output -> m Logger
level :: Logger -> Level
flush :: MonadIO m => Logger -> m ()
close :: MonadIO m => Logger -> m ()
clone :: Maybe Text -> Logger -> Logger
settings :: Logger -> Settings
class Monad m => MonadLogger m where
- log :: Level -> (Msg -> Msg) -> m ()
trace :: MonadLogger m => (Msg -> Msg) -> m ()
debug :: MonadLogger m => (Msg -> Msg) -> m ()
info :: MonadLogger m => (Msg -> Msg) -> m ()
warn :: MonadLogger m => (Msg -> Msg) -> m ()
err :: MonadLogger m => (Msg -> Msg) -> m ()
fatal :: MonadLogger m => (Msg -> Msg) -> m ()
module System.Logger.Message

Documentation

data Settings Source #

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

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

defSettings :: Settings Source #

Default settings:

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

logLevel :: Settings -> Level Source #

setLogLevel :: Level -> Settings -> Settings Source #

output :: Settings -> Output Source #

setOutput :: Output -> Settings -> Settings Source #

format :: Settings -> Maybe DateFormat Source #

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

setFormat :: Maybe DateFormat -> Settings -> Settings Source #

delimiter :: Settings -> ByteString Source #

Delimiter string which separates log line parts.

setDelimiter :: ByteString -> Settings -> Settings Source #

setNetStrings :: Bool -> Settings -> Settings Source #

Whether to use netstring encoding for log lines.

{#- DEPRECATED setNetStrings "Use setRendererNetstr or setRendererDefault instead" #-}

bufSize :: Settings -> Int Source #

setBufSize :: Int -> Settings -> Settings Source #

name :: Settings -> Maybe Text Source #

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

setRenderer :: Renderer -> Settings -> Settings Source #

Set a custom renderer.

See setRendererDefault and setRendererNetstr for two common special cases.

renderer :: Settings -> Renderer Source #

Output format

data Level Source #

Constructors

Trace
Debug
Info
Warn
Error
Fatal

Instances

Instances details

Read Level Source #
Instance details Defined in System.Logger.Settings Methods readsPrec :: Int -> ReadS Level # readList :: ReadS [Level] # readPrec :: ReadPrec Level # readListPrec :: ReadPrec [Level] #
Show Level Source #
Instance details Defined in System.Logger.Settings Methods showsPrec :: Int -> Level -> ShowS # show :: Level -> String # showList :: [Level] -> ShowS #
Eq Level Source #
Instance details Defined in System.Logger.Settings Methods (==) :: Level -> Level -> Bool # (/=) :: Level -> Level -> Bool #
Ord Level Source #
Instance details 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 #

data Output Source #

Constructors

StdOut
StdErr
Path FilePath

Instances

Instances details

Show Output Source #
Instance details Defined in System.Logger.Settings Methods showsPrec :: Int -> Output -> ShowS # show :: Output -> String # showList :: [Output] -> ShowS #
Eq Output Source #
Instance details Defined in System.Logger.Settings Methods (==) :: Output -> Output -> Bool # (/=) :: Output -> Output -> Bool #
Ord Output Source #
Instance details 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 #

data DateFormat Source #

Instances

Instances details

IsString DateFormat Source #
Instance details Defined in System.Logger.Settings Methods fromString :: String -> DateFormat #

iso8601UTC :: DateFormat Source #

ISO 8601 date-time format.

data Logger Source #

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

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

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

level :: Logger -> Level Source #

Inspect this logger's threshold.

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

Force buffered bytes to output sink.

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

Closes the logger.

clone :: Maybe Text -> Logger -> Logger Source #

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 Source #

class Monad m => MonadLogger m where Source #

Methods

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

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

Abbreviation for MonadLogger using the corresponding log level.

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

Abbreviation for MonadLogger using the corresponding log level.

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

Abbreviation for MonadLogger using the corresponding log level.

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

Abbreviation for MonadLogger using the corresponding log level.

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

Abbreviation for MonadLogger using the corresponding log level.

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

Abbreviation for MonadLogger using the corresponding log level.

module System.Logger.Message