Blog

Luis Majano

July 13, 2009

Spread the word


Share your thoughts

As you have probably read a few days ago we released LogBox: An enterprise ColdFusion Logging Library, part of the new ColdBox 3.0.0 Platform Suite.   The library's core of logging takes place thanks to its appenders that send messages to different destinations.  As of now, the distribution has 11 appenders included, but if you want to build your own, you can very very easily.  Not only that, since we are in Beta, you can submit your appenders and we will include them in the distribution if they are cool!  So here is a little tip and trick on building appenders:

Appender

An appender is an object that LogBox uses in order to log statements to a destination repository. All appenders act as destinations that can be from databases, JMS, Twitter, files, consoles, sockets, etc. Their job is to take the logged message and store it or send it somewhere. LogBox comes bundled with the following appenders that can be found in the package coldbox.system.logging.appenders:

Appender Description
AsyncFileAppender An Asynchronous file appender
AsyncRollingFileAppender An Asynchronous file appender that can do file rotation and archiving
CFAppender Will deliver messages to the coldfusion logs
ConsoleAppender Will deliver messages to the console via system.out
DBAppender Will deliver messages to a database table. It can even auto create the table for you.
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 scope you desire
SocketAppender Will connect to any server socket and deliver messages
TwitterAppender Can either send direct messages to a twitter user or update a status of a twitter user.

 

You can define 1 or all of these appenders in LogBox at any point in time. You can even register as many instances of any appender by just naming them differently. 

 

In order to create your own appenders, you will have to create a cfc that extends coldbox.system.logging.AbstractAppender and implement the following methods:

  • init() : Your constructor
  • logMessage() : The method that is called when a message is received
  • onRegistration() : An interceptor that fires when the appender gets created and initialized. It can be used for preparing the appender for operation.
  • onUnRegistration() : An interceptor that fires when the appender is removed from a logger.

 

So how easy is it, well take a look at this simple console appender.

 

// Init supertype super.init(argumentCollection=arguments); instance.out = createObject("java","java.lang.System").out; return this; var loge = arguments.logEvent; var entry = ""; if( hasCustomLayout() ){ entry = getCustomLayout().format(loge); } else{ entry = "#severityToString(loge.getseverity())# #loge.getCategory()# #loge.getmessage()# ExtraInfo: #loge.getextraInfoAsString()#"; } // Log message instance.out.println(entry);

Add Your Comment

(2)

Jul 14, 2009 00:18:08 UTC

by Will B.

Does this use an interface? Heh. - WB

Jul 14, 2009 10:59:30 UTC

by Luis Majano

Heh!! Acutally it is an abstract class as functionality needed to be passed down and also, needed to be cf7 compatible (YUCK!!) Adobe, please discountinue support for cf7

Recent Entries

Elevate Your ColdBox Experience and Skills

Elevate Your ColdBox Experience and Skills

We're thrilled to announce a significant overhaul of our ColdBox training experience to ensure it's nothing short of extraordinary! We've listened closely to your feedback and made significant improvements geared towards transforming you into a ColdBox superhero. Learn What's New!

Maria Jose Herrera
Maria Jose Herrera
February 20, 2024
Ortus Redis Extension v3.3.0 Released!

Ortus Redis Extension v3.3.0 Released!

We are very excited to bring you another release for our Redis Lucee Extension. The most significant feature in this release is the addition of the `` and `redisLock{}` tag, which allows you perform a lock across all instances in a cluster.

Ortus Redis Extension v3.3.0 gives you greater control over concurrent modifications in a distributed environment, utilizing your distributed cache to prevent overlaps!

Jon Clausen
Jon Clausen
February 16, 2024
Introducing: 102 ColdBox HMVC Tips and Tricks

Introducing: 102 ColdBox HMVC Tips and Tricks

In this comprehensive guide, you'll discover a treasure trove of insights tailored to help you build sustainable ColdFusion applications using ColdBox HMVC. But that's not all – we've also included invaluable tips and tricks for companion libraries like CommandBox, WireBox, LogBox, CacheBox, and TestBox. Whether you are a beginner or a seasoned pro, you'll find something to elevate your skills and streamline your development process.

Maria Jose Herrera
Maria Jose Herrera
February 15, 2024