|Maintainer||John Goerzen <email@example.com>|
Haskell Logging Framework, Primary Interface
Written by John Goerzen, firstname.lastname@example.org
Welcome to the error and information logging system for Haskell.
This system is patterned after Python's
http://www.python.org/doc/current/lib/module-logging.html and some of
the documentation here was based on documentation there.
To log a message, you perform operations on
Logger has a
name, and they are arranged hierarchically. Periods serve as separators.
Logger named "foo" is the parent of loggers "foo.printing",
"foo.html", and "foo.io". These names can be anything you want. They're
used to indicate the area of an application or library in which a logged
message originates. Later you will see how you can use this concept to
fine-tune logging behaviors based on specific application areas.
You can also tune logging behaviors based upon how important a message is.
Each message you log will have an importance associated with it. The different
importance levels are given by the
Priority type. I've also provided
some convenient functions that correspond to these importance levels:
emergencyM log messages with the specified importance.
Now, an importance level (or
is associated not just with a particular message but also
Logger. If the
Priority of a given log message is lower than
Priority configured in the
Logger, that message is ignored. This
way, you can globally control how verbose your logging output is.
Now, let's follow what happens under the hood when you log a message. We'll
assume for the moment that you are logging something with a high enough
Priority that it passes the test in your
Logger. In your code, you'll
logM or something like
debugM to log the message. Your
decides to accept the message. What next?
Well, we also have a notion of handlers (
LogHandlers, to be precise).
LogHandler is a thing that takes a message and sends it somewhere.
That "somewhere" may be your screen (via standard error), your system's
logging infrastructure (via syslog), a file, or other things. Each
Logger can have zero or more
LogHandlers associated with it. When your
Logger has a message to log, it passes it to every
LogHandler it knows
of to process. What's more, it is also passed to /all handlers of all
ancestors of the Logger/, regardless of whether those
normally have passed on the message.
Logger can optionally store a
Priority. If a given Logger does
not have a Priority, and you log a message to that logger, the system will
use the priority of the parent of the destination logger to find out whether
to log the message. If the parent has no priority associated with it,
the system continues walking up the tree to figure out a priority until
it hits the root logger. In this way, you can easily adjust the priority
of an entire subtree of loggers. When a new logger is created, it has no
priority by default. The exception is the root logger, which has a WARNING
priority by default.
To give you one extra little knob to turn,
LogHandlers can also have
importance levels (
Priority) associated with them in the same way
Loggers do. They act just like the
Priority value in the
Loggers -- as a filter. It's useful, for instance, to make sure that
under no circumstances will a mere
DEBUG message show up in your syslog.
There is a special logger known as the root logger that sits at the top
of the logger hierarchy. It is always present, and handlers attached
there will be called for every message. You can use
getRootLogger to get
rootLoggerName to work with it by name.
The formatting of log messages may be customized by setting a
on the desired
LogHandler. There are a number of simple formatters defined
in System.Log.Formatter, which may be used directly, or extend to create
your own formatter.
Here's an example to illustrate some of these concepts:
import System.Log.Logger import System.Log.Handler.Syslog import System.Log.Handler.Simple import System.Log.Handler (setFormatter) import System.Log.Formatter -- By default, all messages of level WARNING and above are sent to stderr. -- Everything else is ignored. -- "MyApp.Component" is an arbitrary string; you can tune -- logging behavior based on it later. main = do debugM "MyApp.Component" "This is a debug message -- never to be seen" warningM "MyApp.Component2" "Something Bad is about to happen." -- Copy everything to syslog from here on out. s <- openlog "SyslogStuff" [PID] USER DEBUG updateGlobalLogger rootLoggerName (addHandler s) errorM "MyApp.Component" "This is going to stderr and syslog." -- Now we'd like to see everything from BuggyComponent -- at DEBUG or higher go to syslog and stderr. -- Also, we'd like to still ignore things less than -- WARNING in other areas. -- -- So, we adjust the Logger for MyApp.BuggyComponent. updateGlobalLogger "MyApp.BuggyComponent" (setLevel DEBUG) -- This message will go to syslog and stderr debugM "MyApp.BuggyComponent" "This buggy component is buggy" -- This message will go to syslog and stderr too. warningM "MyApp.BuggyComponent" "Still Buggy" -- This message goes nowhere. debugM "MyApp.WorkingComponent" "Hello" -- Now we decide we'd also like to log everything from BuggyComponent at DEBUG -- or higher to a file for later diagnostics. We'd also like to customize the -- format of the log message, so we use a 'simpleLogFormatter' h <- fileHandler "debug.log" DEBUG >>= \lh -> return $ setFormatter lh (simpleLogFormatter "[$time : $loggername : $prio] $msg") updateGlobalLogger "MyApp.BuggyComponent" (addHandler h) -- This message will go to syslog and stderr, -- and to the file "debug.log" with a format like : -- [2010-05-23 16:47:28 : MyApp.BuggyComponent : DEBUG] Some useful diagnostics... debugM "MyApp.BuggyComponent" "Some useful diagnostics..."
- data Logger
- data Priority
- logM :: String -> Priority -> String -> IO ()
- debugM :: String -> String -> IO ()
- infoM :: String -> String -> IO ()
- noticeM :: String -> String -> IO ()
- warningM :: String -> String -> IO ()
- errorM :: String -> String -> IO ()
- criticalM :: String -> String -> IO ()
- alertM :: String -> String -> IO ()
- emergencyM :: String -> String -> IO ()
- traplogging :: String -> Priority -> String -> IO a -> IO a
- logL :: Logger -> Priority -> String -> IO ()
- getLogger :: String -> IO Logger
- getRootLogger :: IO Logger
- rootLoggerName :: String
- addHandler :: LogHandler a => a -> Logger -> Logger
- setHandlers :: LogHandler a => [a] -> Logger -> Logger
- getLevel :: Logger -> Maybe Priority
- setLevel :: Priority -> Logger -> Logger
- clearLevel :: Logger -> Logger
- saveGlobalLogger :: Logger -> IO ()
- updateGlobalLogger :: String -> (Logger -> Logger) -> IO ()
Re-Exported from System.Log
Priorities are used to define how important a log message is. Users can filter log messages based on priorities.
These have their roots on the traditional syslog system. The standard definitions are given below, but you are free to interpret them however you like. They are listed here in ascending importance order.
Normal runtime conditions
Take immediate action
System is unusable
Name of the logger to use
Priority of this message
The log text itself
|-> IO ()|
Log a message using the given logger at a given priority.
Log a message at
Log a message at
Traps exceptions that may occur, logging them, then passing them on.
Takes a logger name, priority, leading description text (you can set it to
"" if you don't want any), and action to run.
Logging to a particular Logger by object
Log a message, assuming the current logger's level permits it.
These functions help you work with loggers. There are some special things to be aware of.
First of all, whenever you first access a given logger by name, it
magically springs to life. It has a default
Priority of Nothing
and an empty handler list -- which means that it will inherit whatever its
Finding / Creating Loggers
Returns the logger for the given name. If no logger with that name exists, creates new loggers and any necessary parent loggers, with no connected handlers.
This is the base class for the various log handlers. They should all adhere to this class.
The name of the root logger, which is always defined and present on the system.
Also, please note that these functions will not have an effect on the
Logger hierarchy. You may use your new
but other functions won't see the changes. To make a change global,
you'll need to use
Set the 'Logger'\'s list of handlers to the list supplied. All existing handlers are removed first.
Returns the level of the logger. Items beneath this level will be ignored.
Saving Your Changes
These functions commit changes you've made to loggers to the global logger hierarchy.
Updates the global record for the given logger to take into account any changes you may have made.
Helps you make changes on the given logger. Takes a function
that makes changes and writes those changes back to the global
database. Here's an example from above ("s" is a
updateGlobalLogger "MyApp.BuggyComponent" (setLevel DEBUG . setHandlers [s])