LuminescentDreams.Logger

This is the main API module for the logger. You will generally want to import this directly.

Usage suggestions:

Documentation

data LogConfig

Ordinary configurations for a file-based logger.

Constructors

Stdout LogLevel Text [Text]

Buffer (IORef Text) LogLevel Text [Text]

FileLog FilePath LogLevel Text [Text]

data LogLevel

An ordinary hierarchy of logging priorities.

Constructors

LogDebug

LogInfo

LogWarning

LogError

LogEmergency

Instances

Eq LogLevel

Methods

(==) :: LogLevel -> LogLevel -> Bool

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

Ord LogLevel

Methods

compare :: LogLevel -> LogLevel -> Ordering

(<) :: LogLevel -> LogLevel -> Bool

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

(>) :: LogLevel -> LogLevel -> Bool

(>=) :: LogLevel -> LogLevel -> Bool

max :: LogLevel -> LogLevel -> LogLevel

min :: LogLevel -> LogLevel -> LogLevel

Show LogLevel

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

Buildable LogLevel

Generate standard text representations of a log level. This is useful to the Standard logger but may not be interesting to any others.

Methods

build :: LogLevel -> Builder

data Logger

The primary data structure to contain a logger of any kind.

Constructors

Logger

Fields

• _logCmd :: Text -> IO ()

  Any IO action that accepts the log message

• _logLvl :: LogLevel
• _logApp :: Text
• _logTags :: [Text]

  The minimum level at which a log message should be accepted

withLogger :: LogConfig -> (Logger -> IO a) -> IO a

Run an IO action with a log safely available. Logs will be properly closed in the case of an exception. Logging is meant to happen to a file, specified in LogConfig, so this may not be suitable if you want to log to a different resource.