Blog

Brad Wood

February 18, 2014

Spread the word


Share your thoughts

LogBox ships with a number of appenders for you to use including the File, Email, and Socket Appenders. These all have a default way that they format the data before its persisted. For instance, the FileAppender will write out each log event like so:

"Severity","Name","MM/DD/YYYY","HH:MM:SS","Category","Message"

If you need the data to be in a different format, or perhaps even change what data is included, you can do so easily without needing write your own appender. Instead, you can provide the path to a custom layout CFC in the config that will be used to format each log message. A layout component only needs to have a single method called "format()". It will receive a coldbox.system.logging.logEvent object and must return a string containing the formatted log message.

Here's an example:

screamoLayout.cfc

component {
  function format( logEvent ) {
    return UCase( logEvent.getMessage() ) & '!!!';
  }
}

 

And then register the layout along side the appender that will use it in the config:

logBox = {
  appenders = {
    myFile = {
      class='logbox.system.logging.appenders.FileAppender',
      layout='path.to.screamoLayout'
    }
  },
  root = { appenders='*' }
};

Now, all your application's log messages will be shouted at the top of your server's lungs. Perhaps you should check the severity and only do that if it's an error message :)

More info here: http://wiki.coldbox.org/wiki/LogBox.cfm#Creating_a_Custom_Layout

P.S. Remember, it is the responsibility of your custom layout to deserialize the extraInfo if necessary and escape any special characters in the message based on the type of storage it's going to be added to. For instance, the E-mail appender will render any HTML tags when sending the message so escape anything that's not meant to be part of the markup in the actual E-mail.

Add Your Comment

Recent Entries

BoxLang AI v2: Enterprise AI Development Without the Complexity

BoxLang AI v2: Enterprise AI Development Without the Complexity

One Year. 100+ Features. Unlimited Possibilities.

Just one year ago, in March 2024, we launched BoxLang AI 1.0. Today, we're thrilled to announce BoxLang AI v2—a massive leap forward that positions BoxLang as the most powerful and versatile AI framework on the JVM.

Luis Majano
Luis Majano
January 19, 2026
CommandBox: A Smarter Foundation for BoxLang and CFML Workflows

CommandBox: A Smarter Foundation for BoxLang and CFML Workflows

In day-to-day development, some tools simply do their job… and others quietly change the way you work. CommandBox falls into the second category.

It doesn’t replace your editor, framework, or existing applications. Instead, it becomes the common ground where CFML and BoxLang development meet ,giving teams a consistent, reliable way to build, run, and evolve their projects.

Victor Campos
Victor Campos
January 16, 2026
BoxLang v1.9.0 : Production-Ready Stability, Enhanced Lifecycle Management, and Rock-Solid Reliability

BoxLang v1.9.0 : Production-Ready Stability, Enhanced Lifecycle Management, and Rock-Solid Reliability

Happy New Year! The BoxLang team is excited to announce BoxLang 1.9.0, a significant stability and compatibility release focused on production-readiness thanks to our client migrations and new application deployments. This release also introduces array-based form field parsing conventions, enhanced datasource lifecycle management, improved context handling, and resolves over 50 critical bugs to ensure enterprise-grade reliability for mission-critical applications.

Luis Majano
Luis Majano
January 09, 2026