railo-context.Component coldbox.system.logging.LogBox
This is LogBox, an enterprise logger. Please remember to persist this factory once it has been created.
Constructor Summary | |
---|---|
init(LogBoxConfig config, [any coldbox=''])
Constructor. |
Method Summary | |
---|---|
void
|
configure(any<LogBoxConfig> config)
Configure logbox for operation. |
private any<struct>
|
getAppendersMap(any appenders)
Get a map of appenders by list. |
any<LogBoxConfig>
|
getConfig()
Get this LogBox's configuration object. |
any
|
getCurrentAppenders()
Get the list of currently registered appenders. |
any
|
getCurrentLoggers()
Get the list of currently instantiated loggers. |
any<Logger>
|
getLogger(any category)
Get a logger object configured with a category name and appenders. |
any<Logger>
|
getRootLogger()
Get the root logger. |
private any<Util>
|
getUtil()
Create and return a util object. |
any
|
getVersion()
Get the LogBox version string. |
private any
|
locateCategoryParentLogger(any category)
Get a parent logger according to category convention inheritance. |
any
|
registerAppender(any name, any class, [any<struct> properties='[runtime expression]'], [any layout=''], [any<numeric> levelMin='0'], [any<numeric> levelMax='4'])
Register a new appender object in the appender registry. |
Methods inherited from class railo-context.Component |
---|
None |
Constructor Detail |
---|
Constructor
config
- The LogBoxConfig object to use to configure this instance of LogBoxcoldbox
- A coldbox application that this instance of logbox can be linked to.Method Detail |
---|
Configure logbox for operation. You can also re-configure LogBox programmatically. Basically we register all appenders here and all categories
config
- The LogBoxConfig object to use to configure this instance of LogBox: coldbox.system.logging.config.LogBoxConfigGet a map of appenders by list. Usually called to get a category of appenders.
appenders
- The list of appenders to getGet this LogBox's configuration object.
Get the list of currently registered appenders.
Get the list of currently instantiated loggers.
Get a logger object configured with a category name and appenders. If not configured, then it reverts to the root logger defined for this instance of LogBox
category
- The category name to use in this logger or pass in the target object will log from and we will inspect the object and use its metadata name.Get the root logger
Create and return a util object
Get the LogBox version string.
Get a parent logger according to category convention inheritance. If not found, it returns the root logger.
category
- The category name to investigate for parents.Register a new appender object in the appender registry.
name
- A unique name for the appender to register. Only unique names can be registered per instance.class
- The appender's class to register. We will create, init it and register it for you.properties
- The structure of properties to configure this appender with.layout
- The layout class to use in this appender for custom message rendering.levelMin
- The default log level for this appender, by default it is 0. Optional. ex: LogBox.logLevels.WARNlevelMax
- The default log level for this appender, by default it is 4. Optional. ex: LogBox.logLevels.WARN