githubEdit

Using LogBox

Once you have created and configured the LogBox library, you can interact with it in order to get logger objects. The main methods you will use to interact with LogBox are the following, but I recommend you look at the CFC api (http://www.coldbox.org/apiarrow-up-right) in order to get a listing of all available methods.

Method
Description

LogBoxConfig getConfig()

Get the config object registered

Logger getLogger(any category)

Get a named logger object using a category string or the object you will log from

Logger getRootLogger()

Get a reference to the root logger

string getVersion()

Get the current version of LogBox

string getCurrentAppenders()

Get a list of currently registered appenders

string getCurrentLoggers()

Get a list of currently instantiated loggers

void configure( LogBoxConfig config )

Dynamically re-configure the LogBox library

LogBox registerAppender( name, class, [properties], [layout], [levelMin], [levelMax] )

Register a new appender into the running LogBox registry at runtime. Returns LogBox (fluent).

void shutdown()

Gracefully shut down LogBox — calls onShutdown() on the config, shuts down all registered appenders and the async task executor.

The two most important methods are getRootLogger() & getLogger(), which you will use to get the root or named logger objects.

triangle-exclamation

Last updated

Was this helpful?