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

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">
<CFABORT>

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>

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>
</CFTIMER>

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

Summary
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
Every organization is facing their own Digital Transformation as they attempt to stay ahead of the competition, or worse, just keep up. Each new opportunity, whether embracing machine learning, IoT, or a cloud migration, seems to bring new development, deployment, and management models. The results are more diverse and federated computing models than any time in our history.
At CloudEXPO Silicon Valley, June 24-26, 2019, Digital Transformation (DX) is a major focus with expanded DevOpsSUMMIT and FinTechEXPO programs within the DXWorldEXPO agenda. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive over the long term. A total of 88% of Fortune 500 companies from a generation ago are now out of business. Only 12% still survive. Similar percentages are found throug...
At CloudEXPO Silicon Valley, June 24-26, 2019, Digital Transformation (DX) is a major focus with expanded DevOpsSUMMIT and FinTechEXPO programs within the DXWorldEXPO agenda. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive over the long term. A total of 88% of Fortune 500 companies from a generation ago are now out of business. Only 12% still survive. Similar percentages are found throug...
Dion Hinchcliffe is an internationally recognized digital expert, bestselling book author, frequent keynote speaker, analyst, futurist, and transformation expert based in Washington, DC. He is currently Chief Strategy Officer at the industry-leading digital strategy and online community solutions firm, 7Summits.
Digital Transformation is much more than a buzzword. The radical shift to digital mechanisms for almost every process is evident across all industries and verticals. This is often especially true in financial services, where the legacy environment is many times unable to keep up with the rapidly shifting demands of the consumer. The constant pressure to provide complete, omnichannel delivery of customer-facing solutions to meet both regulatory and customer demands is putting enormous pressure on...
IoT is rapidly becoming mainstream as more and more investments are made into the platforms and technology. As this movement continues to expand and gain momentum it creates a massive wall of noise that can be difficult to sift through. Unfortunately, this inevitably makes IoT less approachable for people to get started with and can hamper efforts to integrate this key technology into your own portfolio. There are so many connected products already in place today with many hundreds more on the h...
The standardization of container runtimes and images has sparked the creation of an almost overwhelming number of new open source projects that build on and otherwise work with these specifications. Of course, there's Kubernetes, which orchestrates and manages collections of containers. It was one of the first and best-known examples of projects that make containers truly useful for production use. However, more recently, the container ecosystem has truly exploded. A service mesh like Istio addr...
Digital Transformation: Preparing Cloud & IoT Security for the Age of Artificial Intelligence. As automation and artificial intelligence (AI) power solution development and delivery, many businesses need to build backend cloud capabilities. Well-poised organizations, marketing smart devices with AI and BlockChain capabilities prepare to refine compliance and regulatory capabilities in 2018. Volumes of health, financial, technical and privacy data, along with tightening compliance requirements by...
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...
Andrew Keys is Co-Founder of ConsenSys Enterprise. He comes to ConsenSys Enterprise with capital markets, technology and entrepreneurial experience. Previously, he worked for UBS investment bank in equities analysis. Later, he was responsible for the creation and distribution of life settlement products to hedge funds and investment banks. After, he co-founded a revenue cycle management company where he learned about Bitcoin and eventually Ethereal. Andrew's role at ConsenSys Enterprise is a mul...