Appender
An appender is an object that LogBox uses to log statements to a destination repository. All appenders act as destinations that can include: databases, JMS, files, consoles, sockets, etc. The appender has the responsibility of taking the logged message and persisting the message or sending the message to an external service. LogBox comes bundled with the following appenders that can be found in the package
coldbox.system.logging.appenders:Appender | Description |
CFAppender | Will deliver messages to the coldfusion logs. |
ConsoleAppender | Will deliver messages to the server's console via system.out |
DBAppender | Will deliver messages to a database table. It can auto create the table for you. |
DummyAppender | An endless void of nothingness |
EmailAppender | Will deliver messages to any email address. |
FileAppender | Will deliver messages a file. |
RollingFileAppender | A file appender that can do file rotation and archiving. |
ScopeAppender | Will deliver messages to any ColdFusion variable scope. |
SocketAppender | Will connect to any server socket and deliver messages. |
TracerAppender | Will deliver messages to the ColdFusion tag cftrace. |
Asynchronous Appenders
You may wish your logs to be asynchronous. You can do so by passing an
async property in your configuration. ( This happens at the logger level and is available to all appenders out of the box, even ones that you create yourself!// Any appender can be asynchronous!
dbDebugger = {
class="logbox.system.logging.appenders.DBAppender",
properties={
dsn="blog",
table="logs",
autocreate=true,
textDBType="NCLOB",
async=true
}
}
You can configure LogBox to use one or all of these appenders at any point in time. You can even register as many instances of any appender by defining a unique name for each. Here are examples of how one can configure appenders programmatically or via the simple configuration CFC:
Programmatic Approach
// Adding appenders
props = {
filePath=expandPath( "/logbox/testing/cases/logging/tmp" ),
autoExpand=false,
fileMaxArchives=1,
fileMaxSize=3000,
async=true
};
config.appender(
name="MyAsyncFile",
class="logbox.system.logging.appenders.RollingFileAppender",
properties=props
);
// Socket
props = { host="localhost", port="444", timeout="3", persistConnection=false };
config.appender(
name="SocketAppender",
class="logbox.system.logging.appenders.SocketAppender",
properties=props
);
Configuration CFC approach
function configure(){
logBox = {
// Register Appenders
appenders = {
MyAsyncFile = {
class="logbox.system.logging.appenders.RollingFileAppender",
properties={
filePath=expandPath( "/logbox/testing/cases/logging/tmp" ),
autoExpand=false,
fileMaxArchives=1,
fileMaxSize=3000,
async=true
}
},
SocketAppender = {
class="logbox.system.logging.appenders.SocketAppender",
properties={
host="localhost",
port="444",
timeout="3",
persistConnection=false
}
}
}
};
}
Another feature of a LogBox appender is that you can
extend them or create new ones simply by leveraging the LogBox API. To customize LogBox appenders for your own unique needs you would simply extend the core appender class: coldbox.system.logging.AbstractAppender and implementing the init() and logMessage() methods. Extending LogBox will be reviewed in greater detail over the next few sections.Last modified 4mo ago