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

Faster Debugging with CFTIMER and CFTRACE

Hidden gems

Two of the most common debugging tasks are displaying variables and identifying bottlenecks. For years I relied on CFDUMP and CFABORT to display variables and getTickCount() to calculate processing time and identify slow-running code.

Indeed these wonderful tags and functions have long been the quintessential toolkit of any ColdFusion developer.

<CFSET Email = "[email protected]">
<CFDUMP var="#Email#" label="Email Address">

In the approach above I used <CFDUMP> and <CFABORT> tags to display the value of a variable. Want to display a few variables? The screen quickly becomes a rainbow of purple, green, and gray as you look for your variables. While the wonders of CFDUMP probably deserve their own article, Adobe recently introduced a powerful new tag called CFTRACE.

Introducing CFTrace
With CFTRACE, you can easily display changing variable values either inline or in the debugging section, categorize variables, and even abort execution, all in one tag.
So the good ole CFDUMP becomes:

<CFSET Email = "[email protected]">
<CFTRACE var="Email" text="Email" inline="yes" abort="yes">

*Note that with CFTRACE the var attribute accepts a variable name without pound signs.

The Advantages of CFTrace
"So what" you say, "I've been using CFDUMP and CFABORT for years, why would I switch?"

Well, there are many reasons. Have you ever had to display a variable more than once? The task of identifying those values on the screen can become very cumbersome, especially if manipulated and changed multiple times.

Showing variable values at different points in a template is easy with CFTRACE. Simply add CFTRACE tags after every change and you'll see an organized list in the debugging info section at the bottom of the screen.

<CFSET Email = "[email protected]">
<CFTRACE var="Email" text="Original Email">
<CFSET Email = "[email protected]">
<CFTRACE var="Email" text="New Email">

Another clear advantage of CFTRACE is that it can easily be turned on and off via the ColdFusion administrator. I find it extremely useful not to constantly remove and add code during the development process just to display variables.

Simply browse the ColdFusion Administrator and go to Debugging & Logging -> Debugging Settings to turn CFTRACE on and off.

Not convinced yet? Consider the fact that CFTRACE also lets you categorize and type information as well as display the time differences between traces. CFTRACE calls are also displayed in Dreamweaver's server debug tab results window and ColdFusion logs <cftrace> calls to the {CFUSIONMX}\logs\cftrace.log.

All of the above should be enough to convince any developer to give CFTRACE a test drive. It's a hidden gem that has long been overlooked.

Measuring Processing Time with CFTIMER
Occasionally, I'll have to debug a very slow running template. In the past I had to rely on getTickCount() to find out how long it took a section of code to run.

<cfset start = GetTickCount()>
<cfloop from="1" to="100" index="i"><cfoutput>#i#</cfoutput></cfloop>
<cfset end = GetTickCount()>
<cfoutput>Loop took #end-start# ms</cfoutput>

But recently I've been using a new tag called CFTIMER. Simply wrap a section of your code with CFTIMER and, voilà, you instantly know how long it took to run that section.

<CFTIMER label="Long Loop">
<cfloop from="1" to="1000" index="i"><cfoutput>#i#</cfoutput></cfloop>

CFTIMER lets you put the information inline (as seen in the example above) in an HTML comment, in the debugging info, or even in a nice outline as seen in the example below.

<CFTIMER label="Long Loop" type="outline">
<cfloop from="1" to="100" index="i"><cfoutput>#i#</cfoutput></cfloop>

Using "outline" can become very useful when you have several nested sections you want to test.

CFTRACE and CFTIMER introduce new powerful debugging capabilities. These tags offer significant advantages over the previous methods and make it both easier and faster to debug code.

More Stories By Shlomy Gantz

Shlomy Gantz is the founder and president of BlueBrick, Inc., a technology management consulting firm based in New York. He has over a decade of application development experience, an extensive background in interaction design and project management, and has been building web-based solutions since 1996. Prior to founding BlueBrick, Shlomy was a senior consultant for Computer Horizons, leading large-scale projects for the airline industry. Prior to that he was co-founder and vice president of technology for CoreActive ACG., a New York–based consulting group and a premier Allaire partner.

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
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...
DXWorldEXPO LLC announced today that Big Data Federation to Exhibit at the 22nd International CloudEXPO, colocated with DevOpsSUMMIT and DXWorldEXPO, November 12-13, 2018 in New York City. Big Data Federation, Inc. develops and applies artificial intelligence to predict financial and economic events that matter. The company uncovers patterns and precise drivers of performance and outcomes with the aid of machine-learning algorithms, big data, and fundamental analysis. Their products are deployed...
Dynatrace is an application performance management software company with products for the information technology departments and digital business owners of medium and large businesses. Building the Future of Monitoring with Artificial Intelligence. Today we can collect lots and lots of performance data. We build beautiful dashboards and even have fancy query languages to access and transform the data. Still performance data is a secret language only a couple of people understand. The more busine...
All in Mobile is a place where we continually maximize their impact by fostering understanding, empathy, insights, creativity and joy. They believe that a truly useful and desirable mobile app doesn't need the brightest idea or the most advanced technology. A great product begins with understanding people. It's easy to think that customers will love your app, but can you justify it? They make sure your final app is something that users truly want and need. The only way to do this is by ...
CloudEXPO | DevOpsSUMMIT | DXWorldEXPO are the world's most influential, independent events where Cloud Computing was coined and where technology buyers and vendors meet to experience and discuss the big picture of Digital Transformation and all of the strategies, tactics, and tools they need to realize their goals. Sponsors of DXWorldEXPO | CloudEXPO benefit from unmatched branding, profile building and lead generation opportunities.
Digital Transformation and Disruption, Amazon Style - What You Can Learn. Chris Kocher is a co-founder of Grey Heron, a management and strategic marketing consulting firm. He has 25+ years in both strategic and hands-on operating experience helping executives and investors build revenues and shareholder value. He has consulted with over 130 companies on innovating with new business models, product strategies and monetization. Chris has held management positions at HP and Symantec in addition to ...
Cell networks have the advantage of long-range communications, reaching an estimated 90% of the world. But cell networks such as 2G, 3G and LTE consume lots of power and were designed for connecting people. They are not optimized for low- or battery-powered devices or for IoT applications with infrequently transmitted data. Cell IoT modules that support narrow-band IoT and 4G cell networks will enable cell connectivity, device management, and app enablement for low-power wide-area network IoT. B...
The hierarchical architecture that distributes "compute" within the network specially at the edge can enable new services by harnessing emerging technologies. But Edge-Compute comes at increased cost that needs to be managed and potentially augmented by creative architecture solutions as there will always a catching-up with the capacity demands. Processing power in smartphones has enhanced YoY and there is increasingly spare compute capacity that can be potentially pooled. Uber has successfully ...
SYS-CON Events announced today that CrowdReviews.com has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5–7, 2018, at the Javits Center in New York City, NY. CrowdReviews.com is a transparent online platform for determining which products and services are the best based on the opinion of the crowd. The crowd consists of Internet users that have experienced products and services first-hand and have an interest in letting other potential buye...
When talking IoT we often focus on the devices, the sensors, the hardware itself. The new smart appliances, the new smart or self-driving cars (which are amalgamations of many ‘things'). When we are looking at the world of IoT, we should take a step back, look at the big picture. What value are these devices providing. IoT is not about the devices, its about the data consumed and generated. The devices are tools, mechanisms, conduits. This paper discusses the considerations when dealing with the...