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 1.0.0 Beta 23 Launched

BoxLang 1.0.0 Beta 23 Launched

The latest release of BoxLang, Beta 23, marks a significant step forward in our journey to create the ultimate dynamic language for the JVM. Packed with powerful new features, important bug fixes, and thoughtful optimizations, this update is designed to make your development experience smoother, faster, and more reliable, especially after now starting to take 100s of comments and bug reports from our community.

Luis Majano
Luis Majano
November 23, 2024
TestBox Latest Updates and News!

TestBox Latest Updates and News!

We’re thrilled to have launched the new TestBox website and TestBox 6.0! If you haven’t had a chance to explore yet, visit TestBox to discover updated documentation, powerful resources, and features that make testing more efficient than ever.

Maria Jose Herrera
Maria Jose Herrera
November 21, 2024
Is Your ColdFusion Application Ready for the Future?

Is Your ColdFusion Application Ready for the Future?

In a rapidly evolving digital world, maintaining performance, security, and scalability for ColdFusion applications is more challenging than ever. Whether you're using Lucee or Adobe ColdFusion, legacy systems can become a bottleneck for growth, innovation, and user satisfaction. The need to future-proof your ColdFusion applications has never been more critical.

But where do you start?


The Hidden Costs of an Outdated ColdFusion Application

As you...

Cristobal Escobar
Cristobal Escobar
November 21, 2024