|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.logging.LogBox
public class 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 WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init(LogBoxConfig config, [any coldbox=''])
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 |
---|
public void configure(any<LogBoxConfig> config)
config
- The LogBoxConfig object to use to configure this instance of LogBox: coldbox.system.logging.config.LogBoxConfigprivate any<struct> getAppendersMap(any appenders)
appenders
- The list of appenders to getpublic any<LogBoxConfig> getConfig()
public any getCurrentAppenders()
public any getCurrentLoggers()
public any<Logger> getLogger(any category)
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.public any<Logger> getRootLogger()
private any<Util> getUtil()
public any getVersion()
private any locateCategoryParentLogger(any category)
category
- The category name to investigate for parents.public any registerAppender(any name, any class, [any<struct> properties='[runtime expression]'], [any layout=''], [any<numeric> levelMin='0'], [any<numeric> levelMax='4'])
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 5. Optional. ex: LogBox.logLevels.WARN
|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |