Safe Haskell	Safe-Inferred
Language	Haskell2010

System.Logger

Contents

Settings
Type definitions
Core API
- Logging

Description

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

Synopsis

data Settings
defSettings :: Settings
logLevel :: Settings -> Level
setLogLevel :: Level -> Settings -> Settings
logLevelOf :: Text -> Settings -> Maybe Level
setLogLevelOf :: Text -> Level -> Settings -> Settings
output :: Settings -> Output
setOutput :: Output -> Settings -> Settings
format :: Settings -> Maybe DateFormat
setFormat :: Maybe DateFormat -> Settings -> Settings
delimiter :: Settings -> ByteString
readEnvironment :: Settings -> Bool
setDelimiter :: ByteString -> Settings -> Settings
setNetStrings :: Bool -> Settings -> Settings
setReadEnvironment :: Bool -> Settings -> Settings
setRendererNetstr :: Settings -> Settings
setRendererDefault :: 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 Logger
data Level
- = Trace
- | Debug
- | Info
- | Warn
- | Error
- | Fatal
data Output
- = StdOut
- | StdErr
- | Path FilePath
newtype DateFormat = DateFormat {
- display :: UnixTime -> ByteString
}
type Renderer = ByteString -> DateFormat -> Level -> [Element] -> Builder
iso8601UTC :: DateFormat
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
log :: MonadIO m => Logger -> Level -> (Msg -> Msg) -> m ()
trace :: MonadIO m => Logger -> (Msg -> Msg) -> m ()
debug :: MonadIO m => Logger -> (Msg -> Msg) -> m ()
info :: MonadIO m => Logger -> (Msg -> Msg) -> m ()
warn :: MonadIO m => Logger -> (Msg -> Msg) -> m ()
err :: MonadIO m => Logger -> (Msg -> Msg) -> m ()
fatal :: MonadIO m => Logger -> (Msg -> Msg) -> m ()
module System.Logger.Message

Settings

data Settings Source #

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 #

logLevelOf :: Text -> Settings -> Maybe Level Source #

Log level of some named logger.

setLogLevelOf :: Text -> Level -> Settings -> Settings Source #

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 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.

readEnvironment :: Settings -> Bool Source #

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" #-}

setReadEnvironment :: Bool -> Settings -> Settings Source #

setRendererNetstr :: Settings -> Settings Source #

Shortcut for calling setRenderer with renderNetstr.

setRendererDefault :: Settings -> Settings Source #

Default rendering of log lines.

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

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

Type definitions

data Logger Source #

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 #