Welcome!

You will be redirected in 30 seconds or close now.

ColdFusion Authors: Yakov Fain, Jeremy Geelan, Maureen O'Gara, Nancy Y. Nee, Tad Anderson

Related Topics: ColdFusion

ColdFusion: Article

Tracking Errors: How Good Is Your Code?

Tracking Errors: How Good Is Your Code?

Nobody likes errors, but the bottom line is, they're a fact of programming life. The better you are at pinpointing them, the better your code will get. Unfortunately, ColdFusion has never provided very good functionality for tracking the errors that occur within your production applications. I mean how many of you actually look through your application.log? For those of us with busy servers and busy schedules, that becomes an impossibility...

Thus good tools are needed. ColdFusion 4 and 5 and MX include a Log Files reporting tool in the CF Administrator. For some, that still may not be enough. It would be helpful, for instance, to extract the log of errors into a database for subsequent reporting. Right off the bat, it seems Allaire/Macromedia didn't fully think things through as the application.log is not easily parsed.

The problem is, when certain types of errors occur (such as ODBC errors), quotes appear within the text of the error and that interferes with the quotes used as field delimiters for the log. Rather than give up on our goal, however, we can find an alternative solution. What if we could handle errors ourselves rather than rely solely on after-the-fact log analysis?

Enter ColdFusion's error handling. Since version 4.5, Macromedia has made available improved error handling. One of the early restrictions CF developers faced was not being able to run any ColdFusion code on an error-handling page. It was the old chicken and egg problem - what happens if an error occurs on the error-handling page? Fortunately we don't have to worry about those kinds of restrictions anymore.

There are several ways of dealing with errors by executing ColdFusion tags, such as CFTRY/CFCATCH, the CFERROR tag (using TYPE=Exception), and the site-wide error handler that can be enabled through the CF Administrator. These have been discussed in various previous CFDJ articles, such as Charlie Arehart's four-part series starting in October 2000 at www.sys-con.com/coldfusion/article.cfm?id=165.

In this article, we'll take advantage of the site-wide error handler, which will catch any errors that fall through the cracks and interrupt a page from running.

There are a couple of things to be aware of about error handling, such as with the site-wide handler. First, when using it to intercept an error, CF will not write the error to the application.log. You'll have to do that yourself if you really want to (see Listing 1).

Listing 1: Writing out to application.log
<cflog text="#error.diagnostics#" log="APPLICATION"
type="Error" thread="yes" date="yes"
time="yes" application="yes">

Since our end result was to parse the application.log and insert that into a database, we'll skip the step of writing out the log and insert each error directly into the database as it occurs.

Listing 2 contains the database tables that we'll use for our application. Note the "fixID" field at the end of the "errorLog" table. We'll set that as we correct our errors so that we know which ones have been fixed.

Listing 2: Table and index creation
CREATE TABLE errorLog (
logID int IDENTITY (1,1) NOT NULL,
application varchar(20) NULL,
errorDetail varchar(2200) NULL,
errorBase64 varchar(3000) NULL,
errorStamp datetime NOT NULL,
errorType varchar(30) NULL,
browser varchar(100) NULL,
remoteAddr varchar(15) NULL,
httpReferer varchar(255) NULL,
server varchar(30) NULL,
template varchar(255) NULL,
scriptName varchar(200) NULL,
queryString varchar(120) NULL,
fixID smallint NULL
)

PRIMARY KEY: logID
INDEXES: fixID, errorDetail, errorBase64, errorType, application, template

CREATE TABLE errorFixes (
fixID int IDENTITY (1,1) NOT NULL,
logID int NULL,
fixDetail varchar(500) NULL,
fixStamp datetime NULL
)

PRIMARY KEY: fixID
INDEXES: logID

Listing 3 contains the CF code for your site-wide error handler that will insert the error into the database. There are several error types that are common to ColdFusion and might be present in your application (see Table 1). We'll later produce a report that groups things by these types, so we'll add some code right before the insert query to determine the type of error that has occurred. Feel free to add additional code to catch specific errors that you want grouped into the "Other" category.

Listing 3: Inserting the error via SQL
<Cflock scope="application" type="readonly" timeout="10">
<Cfset variables.appName = #application.applicationName#>
</cflock>

<cfif Left(trim(error.diagnostics),4) is 'ODBC' or
Left(trim(error.diagnostics),5) is 'OLEDB' or
Left(trim(error.diagnostics),30)
is 'Error Executing Database Query'>
<cfset errorType = "Database Error">
<cfelseif Left(trim(error.diagnostics),17) is 'Request timed out'>
<cfset errorType = "Request Timeout">
<cfelseif error.diagnostics contains 'Error resolving parameter'>
<cfset errorType = "Error Resolving Parameter">
<cfelseif error.diagnostics contains 'Error resolving parameter <B>SESSION.'>
<cfset errorType = "Session Timeout">
<cfelseif Left(trim(error.diagnostics),53) is
'<P>An error occurred while evaluating the expression:'>
<cfset errorType = "Error Evaluating Expression">
<cfelseif Left(trim(error.diagnostics),30) is 'Just in time compilation error'>
<cfset errorType = "Compilation Error">
<cfelse>
<cfset errorType = "Other Error">
</cfif>

<cfquery name="InsertLogRecord" datasource="#request.datasource#">
INSERT INTO errorLog (errorStamp, errorDetail, errorBase64, errorType, template,
queryString, browser, remoteAddr, httpReferer, application, server, scriptName) VALUES
(#CreateODBCDateTime(error.DateTime)#, '#left(trim(error.diagnostics),2200)#',
'#Trim(Left(ToBase64(error.diagnostics),3000))#', '#errorType#', '#error.template#',
'#error.queryString#','#error.browser#', '#error.RemoteAddress#',
'#ERROR.HTTPReferer#', '#variables.appName#', '#cgi.server_name#', '#cgi.script_name#')
</cfquery>

Note that you could add more to this logging of information, such as writing out session identifiers (CFID, CFTOKEN, and/or JSessionID if using J2EE sessions in CFMX). Also, the locking of access to the application.applicationname variable is something that could be removed if this code is run in CFMX.

Of course, this listing is just a fragment of what you could do in the error handler. For more information on site-wide error handlers, including how to create one, how to provide notification to the user about the error, and optionally how to send e-mail notification to someone in your shop about the error, see the second part in the previously mentioned series, "Toward Better Error Handling - Part 2: Site Wide Error Handling" from December 2000, at www.sys-con.com/coldfusion/article.cfm?id=181.

You may notice that I chose to create a column called errorBase64. Let me explain, and you may need to make some adjustments based upon your database. Specifically, if your database cannot handle sub-selects (as we'll explain later and see in Listing 5), we cannot do comparisons directly within the database given the approach we'll be using. Therefore we'll need a way to encode special characters such as quotes. Most enterprise databases such as Oracle and MS SQL will have no problems with sub-selects, and MS Access supports them as well, but some databases such as mySQL do not (although support is coming soon).

Fortunately, there is an easy workaround. You can add one additional field to your database table to store the error encoded in Base64 (we've reflected this in the code listings). Those of you who store binary files directly in your databases may already be familiar with the ToBase64() function which does just that. If your database does handle sub-selects, you can ignore all references to Base64 as you won't need to do any conversions.

Now that we're collecting all of our errors, we need a way to make sense of it all.

So what's next? Well, we need a way to sort and organize our errors so that we can start to see which are our biggest problems. In our completed application, we've created a CFC called error.cfc with a number of CFFUNCTION methods that are used to search the database we've created. There are several ways you may want to sort including by template, by application, newest first, most frequent, and by type of error. Later we'll look at some different ways to sort and view your errors. For now, we'll just list the newest errors first (see Listing 4). Notice that we added the "WHERE fixID IS NULL" line to our query in order to not include errors that have already been corrected.

Listing 4: Newest errors
<cffunction name="byNewest" displayName="Newest Errors"
access="public" returnType="query" output="false">
<cfset var getErrors = "">
<cfquery name="getErrors" datasource="#request.datasource#">
SELECT logID, application, errorDetail, errorStamp FROM errorLog
WHERE fixID IS NULL
ORDER BY errorStamp DESC
</cfquery>
<cfreturn getErrors>
</cffunction>

We might then call that CFC using code such as:

<cfinvoke component="errors" method="byNewest"
returnvariable="GetErrors"></cfinvoke>
<cfoutput query="getErrors">#application# : #errorDetail# :
#errorStamp#<br></cfoutput>

The code in Listing 5 will display an individual error. You should set up a separate page to drill down to this info. The GetSimilar query will show you how many times the specific error you're viewing appears in the log. You'll need to comment out either the "with sub-selects" or "without sub-selects" portion of the code depending upon your database's capabilities. We then add one column to the end of our original query listing the "SimCount," or the number of times a matching error appears.

Listing 5: Get detail
<cffunction name="getDetail" displayName="Get Error Detail"
access="public" returnType="query" output="false">
<cfargument name="logID" type="numeric" required="true">
<cfset var getError = "">
<cfset var getSimilar = "">
<cfset var simCount = arrayNew(1)>
<cfquery name="getError" datasource="#request.datasource#">
SELECT * FROM errorLog WHERE logID = #ARGUMENTS.logID#
</cfquery>
<!--- with sub-selects --->
<cfquery name="GetSimilar" datasource="#request.datasource#">
SELECT count(*) as numSimilar FROM errorLog
WHERE errorDetail = (SELECT errorDetail FROM errorLog
WHERE logID = #ARGUMENTS.logID#)
AND logID != #ARGUMENTS.logID#
</cfquery>

<!--- without sub-selects --->
<cfquery name="GetSimilar" datasource="#request.datasource#">
SELECT count(*) as numSimilar FROM errorLog
WHERE errorBase64 = '#getError.errorBase64#'
AND logID != #ARGUMENTS.logID#
</cfquery>

<!--- create an array and add column to query --->
<cfset simCount[1] = GetSimilar.numSimilar>
<cfset QueryAddColumn(getError, "SimCount", simCount)>
<cfreturn getError>
</cffunction>

To keep our error log manageable, we need a way to mark errors as corrected once the code has been fixed. At the bottom of the screen displaying an individual error, we'll add a textarea field for entering the fix we performed. When we submit a fix, we'll mark the error as solved (see Listing 6) and also update all of the matching errors since those should now be corrected also (note the slight query changes depending on whether your database can handle sub-selects).

Listing 6: Enter problem fix
<cffunction name="enterFix" displayName="Enter Problem Fix"
access="public" returnType="void" output="false">
<cfargument name="logID" type="numeric" required="true">
<cfargument name="errorFix" type="string" required="true">
<cfset var enterFix = "">
<cfset var getMatching = "">
<cfset var getBase64 = "">
<cfset var getMatching = "">
<cfset var updateLogTable = "">
<cfquery name="enterFix" datasource="#request.datasource#">
INSERT INTO errorFixes (logID, fixDetail, fixStamp)
VALUES (#ARGUMENTS.logID#, '#ARGUMENTS.errorFix#',
#CreateODBCDateTime(Now())#)
</cfquery>

<!--- with sub-selects --->
<cfquery name="GetMatching" datasource="#request.datasource#">
SELECT logID FROM errorLog WHERE errorDetail =
(SELECT errorDetail FROM errorLog WHERE logID = #ARGUMENTS.logID#)
</cfquery>

<!--- without sub-selects --->
<cfquery name="GetBase64" datasource="#request.datasource#">
SELECT errorBase64 FROM errorLog WHERE logID = #ARGUMENTS.logID#
</cfquery>
<cfquery name="GetMatching" datasource="#request.datasource#">
SELECT logID FROM errorLog WHERE errorBase64 =
'#GetBase64.errorBase64#'
</cfquery>

<cfquery name="updateLogTable" datasource="#request.datasource#">
UPDATE errorLog SET fixID = #enterFix.id# WHERE logID IN
(#ValueList(getMatching.logID)#)
</cfquery>
</cffunction>

We now have a way to list, view, and fix the latest errors that occur. Next we'll look at various other ways of sorting and viewing our data. Previously we only listed the newest errors first - now we'll sort by application, template, top errors, and error types (see Listings 7-10). These views will allow you to see which errors are occurring the most based upon your selection criteria. The errCount alias in each query will keep track of the number of errors for that grouping and the maxStamp alias will hold the last date that an error for that grouping has occurred.

Listing 7: Errors by application
<cffunction name="byApplication" displayName="Errors By Application"
access="public" returnType="query" output="false">
<cfset var getErrors = "">
<cfquery name="getErrors" datasource="#request.datasource#">
SELECT application, count(logID) as errCount,
max(errorStamp) as maxStamp FROM errorLog
WHERE fixID IS NULL
GROUP BY application
ORDER BY errCount DESC
</cfquery>
<cfreturn getErrors>
</cffunction>

This could be called with:

<cfinvoke component="errors" method="byApplication"
returnvariable="GetErrors"></cfinvoke>
<cfoutput query="getErrors">#application# : #errCount# :
#maxStamp#<br></cfoutput>

Listing 8: Errors by template
<cffunction name="byTemplate" displayName="Errors By Template"
access="public" returnType="query" output="false">
<cfset var getErrors = "">
<cfquery name="getErrors" datasource="#request.datasource#">
SELECT template, application, count(*) as errCount,
max(errorStamp) as maxStamp FROM errorLog
WHERE fixID IS NULL
GROUP BY template, application
ORDER BY errCount DESC
</cfquery>
<cfreturn getErrors>
</cffunction>

This could be called with:

<cfinvoke component="errors" method="byTemplate"
returnvariable="GetErrors"></cfinvoke>
<cfoutput query="getErrors">#template# : #application# : #errCount# :
#maxStamp#<br></cfoutput>

Listing 9: Top errors
<cffunction name="byTopErrors" displayName="Top Errors" access="public"
returnType="query" output="false">
<cfset var getErrors = "">
<cfquery name="getErrors" datasource="#request.datasource#">
SELECT errorDetail, application, count(logID) as errCount,
max(errorStamp) as maxStamp, max(logID)as maxLogID
FROM errorLog
WHERE fixID IS NULL
GROUP BY errorDetail, application
ORDER BY errCount DESC
</cfquery>
<cfreturn getErrors>
</cffunction>

This could be called with:

<cfinvoke component="errors" method="byTopErrors"
returnvariable="GetErrors"></cfinvoke>
<cfoutput query="getErrors"> #application# : #errorDetail# : #errCount# :
#maxStamp#<br></cfoutput>

Listing 10: Errors by error type
<cffunction name="byErrorType" displayName="Errors By Error Type"
access="public" returnType="query" output="false">
<cfset var getErrors = "">
<cfquery name="getErrors" datasource="#request.datasource#">
SELECT errorType, count(*) as errCount, max(errorStamp) as maxStamp
FROM errorLog
WHERE fixID IS NULL
GROUP BY errorType
ORDER BY errCount DESC
</cfquery>
<cfreturn getErrors>
</cffunction>

This could be called with:

<cfinvoke component="errors" method="byErrorType"
returnvariable="GetErrors"></cfinvoke>
<cfoutput query="getErrors"> #errorType# : #errCount# :
#maxStamp#<br></cfoutput>

Used effectively, this tool will speed your application performance and improve your coding style. Good luck!

More Stories By Joe Danziger

Joe Danziger is a senior web applications developer with Multimax, Inc., a provider of Enterprise IT Services and Solutions supporting the critical missions of the Air Force, Army, Navy, and other Department of Defense components. He is certified as an Advanced Macromedia ColdFusion MX Developer, and also maintains the Building Blocks site (www.ajaxcf.com) dedicated to AJAX and ColdFusion, as well as DJ Central (www.djcentral.com), a Website serving DJs and the electronic dance music industry.

Comments (0)

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


IoT & Smart Cities Stories
If a machine can invent, does this mean the end of the patent system as we know it? The patent system, both in the US and Europe, allows companies to protect their inventions and helps foster innovation. However, Artificial Intelligence (AI) could be set to disrupt the patent system as we know it. This talk will examine how AI may change the patent landscape in the years to come. Furthermore, ways in which companies can best protect their AI related inventions will be examined from both a US and...
The challenges of aggregating data from consumer-oriented devices, such as wearable technologies and smart thermostats, are fairly well-understood. However, there are a new set of challenges for IoT devices that generate megabytes or gigabytes of data per second. Certainly, the infrastructure will have to change, as those volumes of data will likely overwhelm the available bandwidth for aggregating the data into a central repository. Ochandarena discusses a whole new way to think about your next...
Charles Araujo is an industry analyst, internationally recognized authority on the Digital Enterprise and author of The Quantum Age of IT: Why Everything You Know About IT is About to Change. As Principal Analyst with Intellyx, he writes, speaks and advises organizations on how to navigate through this time of disruption. He is also the founder of The Institute for Digital Transformation and a sought after keynote speaker. He has been a regular contributor to both InformationWeek and CIO Insight...
Bill Schmarzo, Tech Chair of "Big Data | Analytics" of upcoming CloudEXPO | DXWorldEXPO New York (November 12-13, 2018, New York City) today announced the outline and schedule of the track. "The track has been designed in experience/degree order," said Schmarzo. "So, that folks who attend the entire track can leave the conference with some of the skills necessary to get their work done when they get back to their offices. It actually ties back to some work that I'm doing at the University of ...
DXWorldEXPO LLC, the producer of the world's most influential technology conferences and trade shows has announced the 22nd International CloudEXPO | DXWorldEXPO "Early Bird Registration" is now open. Register for Full Conference "Gold Pass" ▸ Here (Expo Hall ▸ Here)
@DevOpsSummit at Cloud Expo, taking place November 12-13 in New York City, NY, is co-located with 22nd international CloudEXPO | first international DXWorldEXPO and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The widespread success of cloud computing is driving the DevOps revolution in enterprise IT. Now as never before, development teams must communicate and collaborate in a dynamic, 24/7/365 environment. There is no time t...
CloudEXPO New York 2018, colocated with DXWorldEXPO New York 2018 will be held November 11-13, 2018, in New York City and will bring together Cloud Computing, FinTech and Blockchain, Digital Transformation, Big Data, Internet of Things, DevOps, AI, Machine Learning and WebRTC to one location.
The best way to leverage your Cloud Expo presence as a sponsor and exhibitor is to plan your news announcements around our events. The press covering Cloud Expo and @ThingsExpo will have access to these releases and will amplify your news announcements. More than two dozen Cloud companies either set deals at our shows or have announced their mergers and acquisitions at Cloud Expo. Product announcements during our show provide your company with the most reach through our targeted audiences.
The Internet of Things will challenge the status quo of how IT and development organizations operate. Or will it? Certainly the fog layer of IoT requires special insights about data ontology, security and transactional integrity. But the developmental challenges are the same: People, Process and Platform and how we integrate our thinking to solve complicated problems. In his session at 19th Cloud Expo, Craig Sproule, CEO of Metavine, demonstrated how to move beyond today's coding paradigm and sh...
What are the new priorities for the connected business? First: businesses need to think differently about the types of connections they will need to make – these span well beyond the traditional app to app into more modern forms of integration including SaaS integrations, mobile integrations, APIs, device integration and Big Data integration. It’s important these are unified together vs. doing them all piecemeal. Second, these types of connections need to be simple to design, adapt and configure...