System.Wlog.Wrapper

Logging functionality. This module is wrapper over hslogger, which allows to keep logger name in monadic context.

Documentation

data Severity

Severity is level of log message importance. It uniquely determines which messages to print.

Constructors

Debug

Debug messages

Info

Information

Notice

Important (more than average) information

Warning

General warnings

Error

General errors/severe errors

Instances

Bounded Severity

Methods

minBound :: Severity

maxBound :: Severity

Enum Severity

Methods

succ :: Severity -> Severity

pred :: Severity -> Severity

toEnum :: Int -> Severity

fromEnum :: Severity -> Int

enumFrom :: Severity -> [Severity]

enumFromThen :: Severity -> Severity -> [Severity]

enumFromTo :: Severity -> Severity -> [Severity]

enumFromThenTo :: Severity -> Severity -> Severity -> [Severity]

Eq Severity

Methods

(==) :: Severity -> Severity -> Bool

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

Ord Severity

Methods

compare :: Severity -> Severity -> Ordering

(<) :: Severity -> Severity -> Bool

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

(>) :: Severity -> Severity -> Bool

(>=) :: Severity -> Severity -> Bool

max :: Severity -> Severity -> Severity

min :: Severity -> Severity -> Severity

Read Severity

Methods

readsPrec :: Int -> ReadS Severity

readList :: ReadS [Severity]

readPrec :: ReadPrec Severity

readListPrec :: ReadPrec [Severity]

Show Severity

Methods

showsPrec :: Int -> Severity -> ShowS

show :: Severity -> String

showList :: [Severity] -> ShowS

Generic Severity

Associated Types

type Rep Severity :: * -> *

Methods

from :: Severity -> Rep Severity x

to :: Rep Severity x -> Severity

ToJSON Severity

Methods

toJSON :: Severity -> Value

toEncoding :: Severity -> Encoding

toJSONList :: [Severity] -> Value

toEncodingList :: [Severity] -> Encoding

FromJSON Severity

Methods

parseJSON :: Value -> Parser Severity

parseJSONList :: Value -> Parser [Severity]

SafeCopy Severity

Methods

version :: Version Severity

kind :: Kind Severity

getCopy :: Contained (Get Severity)

putCopy :: Severity -> Contained Put

internalConsistency :: Consistency Severity

objectProfile :: Profile Severity

errorTypeName :: Proxy Severity -> String

type Rep Severity

type Rep Severity = D1 (MetaData "Severity" "System.Wlog.Severity" "log-warper-1.0.2-9fv2a0dRBEp5aS8ANnebai" False) ((:+:) ((:+:) (C1 (MetaCons "Debug" PrefixI False) U1) (C1 (MetaCons "Info" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Notice" PrefixI False) U1) ((:+:) (C1 (MetaCons "Warning" PrefixI False) U1) (C1 (MetaCons "Error" PrefixI False) U1))))

initTerminalLogging :: MonadIO m => Bool -> Maybe Severity -> m ()

This function initializes global logging system for terminal output. At high level, it sets severity which will be used by all loggers by default, sets default formatters and sets custom severity for given loggers (if any).

NOTE: you probably don't want to use this function. Consider setupLogging.

On a lower level it does the following: 1. Removes default handler from root logger, sets two handlers such that: 1.1. All messages are printed to stdout. 1.2. Moreover messages with at least Error severity are printed to stderr. 2. Sets given Severity to root logger, so that it will be used by descendant loggers by default. 3. Applies setSeverity to given loggers. It can be done later using setSeverity directly.

releaseAllHandlers :: MonadIO m => m ()

Lifted alias to removeAllHandlers.

setSeverity :: MonadIO m => LoggerName -> Severity -> m ()

Set severity for given logger. By default parent's severity is used.

setSeverityMaybe :: MonadIO m => LoggerName -> Maybe Severity -> m ()

Set or clear severity.