EasyLogger.Logger

Documentation

data LogDestination

Logging destination. See also setLoggingDestination.

Constructors

LogStdErr

LogStdOut

LogFile FilePath

data LogLevel

Log Level. Levels are sorted. All < Debug < Info < Warning < Error. None disables all logging. Default: All

Constructors

LogNone

LogAll

LogDebug

LogInfo

LogWarning

LogError

Instances

Bounded LogLevel

Defined in EasyLogger.Logger

Methods

minBound :: LogLevel

maxBound :: LogLevel

Enum LogLevel

Defined in EasyLogger.Logger

Methods

succ :: LogLevel -> LogLevel

pred :: LogLevel -> LogLevel

toEnum :: Int -> LogLevel

fromEnum :: LogLevel -> Int

enumFrom :: LogLevel -> [LogLevel]

enumFromThen :: LogLevel -> LogLevel -> [LogLevel]

enumFromTo :: LogLevel -> LogLevel -> [LogLevel]

enumFromThenTo :: LogLevel -> LogLevel -> LogLevel -> [LogLevel]

Eq LogLevel

Defined in EasyLogger.Logger

Methods

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

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

Ord LogLevel

Defined in EasyLogger.Logger

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

Read LogLevel

Defined in EasyLogger.Logger

Methods

readsPrec :: Int -> ReadS LogLevel

readList :: ReadS [LogLevel]

readPrec :: ReadPrec LogLevel

readListPrec :: ReadPrec [LogLevel]

Show LogLevel

Defined in EasyLogger.Logger

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

initLogger :: Q Exp

Initialise the logger. MUST only be called in the executable code (not the exposed library code)! Ignores the other packages logs, if the same packages is used for logging.

initLoggerAllPackages :: Q Exp

Initialise the logger. MUST only be called in the executable code (not the exposed library code)! Takes a Bool that decides wether to log messages from other packages that use the same library and did not initalize the Logger (which should be the case for all of them!).

setLoggingDestination :: String -> LogDestination -> LogFromAllPackages -> IO ()

Set the destination for all consequitive for logging. You should only set this once, at the beginning of the program! The default is LogStdOut.

setMinLogLevel :: LogLevel -> IO ()

Set the least logging level. Levels lower will not be logged. Log Level Order: Debug < Info < Warning < Error. None disables all logging. Note that the output to stderr using e.g. logPrintError will not be affected!

setPrintLocationToConsole :: Bool -> IO ()

Set the least logging level. Levels lower will not be logged. Log Level Order: Debug < Info < Warning < Error. None disables all logging. Note that the output to stderr using e.g. logPrintError will not be affected!

logAll :: Q Exp

Generates a function that takes a Text and logs a LevelAll message. Usage:

$(logAll) ("This is a debug log message" :: T.Text)

logPrintAll :: Q Exp

Same as logAll, but also prints the message on stdout.

logDebug :: Q Exp

Generates a function that takes a Text and logs a LevelDebug message. Usage:

$(logDebug) "This is a debug log message"

logPrintDebug :: Q Exp

Same as logDebug, but also prints the message on stdout.

logInfo :: Q Exp

Generates a function that takes a Text and logs a LevelInfo message. Usage:

$(logInfo) "This is a info log message"

logPrintInfo :: Q Exp

Same as logInfo, but also prints the message on stdout.

logWarning :: Q Exp

Generates a function that takes a Text and logs a LevelWarning message. Usage:

$(logWarning) "This is a warning log message"

logPrintWarning :: Q Exp

Same as logWarning, but also prints the message on stdout.

logError :: Q Exp

Generates a function that takes a Text and logs a LevelError message. Usage:

$(logError) "This is a error log message"

logPrintError :: Q Exp

Same as logError, but also prints the message on stderr.

pureLogAll :: Q Exp

Same as logAll, but for pure code. Uses unsafePerformIO.

$(pureLogAll) "This is a debug log message" (3 * 3)

pureLogPrintAll :: Q Exp

Same as pureLogAll, but also prints the message on stdout.

$(pureLogPrintAll) "This is a debug log message" (3 * 3)

pureLogDebug :: Q Exp

Same as logDebug, but for pure code. Uses unsafePerformIO

$(pureLogDebug) "This is a debug log message" defaultValue

pureLogPrintDebug :: Q Exp

Same as pureLogDebug, but also prints the message on stdout.

$(purePrintLogDebug) "This is a debug log message" defaultValue

pureLogInfo :: Q Exp

Same as logInfo, but for pure code. Uses unsafePerformIO.

$(pureLogInfo) "This is a warning log message" (funcX 10)

pureLogPrintInfo :: Q Exp

Same as pureLogInfo, but also prints the message on stdout.

$(pureLogPrintInfo) "This is a warning log message" (funcX 10)

pureLogWarning :: Q Exp

Same as logWarning, but for pure code. Uses unsafePerformIO.

$(pureLogWarning) "This is a warning log message" "myresult"

pureLogPrintWarning :: Q Exp

Same as pureLogWarning, but also prints the warning.

$(pureLogPrintWarning) "This is a error log message" (4 + 4)

pureLogError :: Q Exp

Same as logError, but for pure code. Uses unsafePerformIO.

$(pureLogError) "This is a error log message" (4 + 4)

pureLogPrintError :: Q Exp

Same as pureLogError, but also prints the message on stderr.

$(pureLogPrintError) "This is a error log message" (4 + 4)

logAllText :: Q Exp

Same as logAll, but with concrete type Text as message.

$(logAll) "This is a debug log message"

logPrintAllText :: Q Exp

Same as logAll, but also prints the message on stdout. Only for Text.

logDebugText :: Q Exp

Same as logDebug but with Text as fixed message type.

logPrintDebugText :: Q Exp

Same as logDebug, but also prints the message on stdout. Only for Text.

logInfoText :: Q Exp

Same as logInfo but with Text as fixed message type.

logPrintInfoText :: Q Exp

Same as logInfo, but also prints the message on stdout.

logWarningText :: Q Exp

Same as logWarning but with Text as fixed message type.

logPrintWarningText :: Q Exp

Same as logWarning, but also prints the message on stdout.

logErrorText :: Q Exp

Same as logError but with Text as fixed message type.

logPrintErrorText :: Q Exp

Same as logError, but also prints the message on stderr.

pureLogAllText :: Q Exp

Same as pureLogAll, but with concrete type Text as message.

pureLogPrintAllText :: Q Exp

Same as pureLogPrintAll, but with concrete type Text as log message.

pureLogDebugText :: Q Exp

Same as pureLogDebug, but with concrete type Text as message.

pureLogPrintDebugText :: Q Exp

Same as pureLogPrintDebug, but with concrete type Text as log message.

pureLogInfoText :: Q Exp

Same as pureLogInfo, but with concrete type Text as message.

pureLogPrintInfoText :: Q Exp

Same as pureLogPrintInfo, but with concrete type Text as log message.

pureLogWarningText :: Q Exp

Same as pureLogWarning, but with concrete type Text as message.

pureLogPrintWarningText :: Q Exp

Same as pureLogPrintWarning, but with concrete type Text as log message.

pureLogErrorText :: Q Exp

Same as pureLogError, but with concrete type Text as message.

pureLogPrintErrorText :: Q Exp

Same as pureLogPrintError, but with concrete type Text as log message.

finalizeAllLoggers :: IO ()

Should be used to ensure all logs are completely written before the program exists. Cleans all the file descriptors. You (and also no other library) MUST NOT log after this command as all loggers are deinitalized. However, you might initialize the loggers again and before restarting to log.

finalizeLogger :: Q Exp

Can be used to destroy your own logger (from your package) only. You MUST NOT log after this command.

flushLoggers :: IO ()

Flush all loggers of all packages.