Using the cfstat utility

The cfstat command-line utility provides real-time performance metrics for ColdFusion MX. Using a socket connection to obtain metric data, the cfstat utility displays the information that ColdFusion MX writes to the System Monitor without actually using the System Monitor application. The following table lists the metrics that cfstat returns:

Metric abbreviation	Metric name	Description
Pg/Sec	Page hits per second	The number of ColdFusion pages processed per second. You can reduce this by moving static content to HTML pages.
DB/Sec	Database accesses per second	The number of database accesses per second made by ColdFusion MX. Any difference in complexity and resource load between calls is ignored.
CP/Sec	Cache pops per second	The number of ColdFusion template cache pops per second. A cache pop occurs when ColdFusion MX ejects a cached template from the template cache to make room for a new template.
Req Q'ed	Number of queued requests	The number of requests that are currently waiting for ColdFusion MX to process them. Lower values, which you can achieve with efficient CFML, are better.
Req Run'g	Number of running requests	The number of requests that ColdFusion MX is currently actively processing.
Req TO'ed	Number of timed out requests	The total number of ColdFusion requests that have timed out. Lower values, which you can achieve by aggressive caching, removing unnecessary dynamic operations and third-party events, are better.
AvgQ Time	Average queue time	A running average of the time, in milliseconds, that requests spend waiting for ColdFusion MX to process them. Lower values, which you can achieve with efficient CFML and enhanced caching, are better.
AvgReq Time	Average request time	A running average of the time, in milliseconds, that ColdFusion MX spends to process a request (including queued time). Lower values, which you can achieve with efficient CFML, are better.
AvgDB Time	Average database transaction time	A running average of the time that ColdFusion MX spends on database-related processing of ColdFusion requests.
Bytes In/Sec	Bytes incoming per second	The number of bytes that ColdFusion MX read in the last second (not an average).
Bytes Out/Sec	Bytes outgoing per second	The number of bytes that ColdFusion MX wrote in the last second (not an average).

Before you use the cfstat utility, ensure that you selected the Enable Performance Monitoring check box in the ColdFusion MX Administrator (on the Debugging & Logging > Debugging Settings page). If you select this check box, you must restart ColdFusion MX for this change to take effect.

Your cfusionmx\bin directory contains the cfstat utility. From that directory, type cfstat and use the following available switches:

Switch	Description/Comment
-n	Suppress column headers (useful for saving output to a file).
-s	Display output in a single line (delay display of the first line so cfstat can display meaningful values in the per-second counters).
#	Where # is an integer, delay display output by # seconds. If you do not specify an integer, cfstat returns one line.
-h	Web server hostname (localhost is the default).
-p	Web server listening port number (80 is the default).

Comments are no longer accepted for ColdFusion MX 6.1. ColdFusion 8 is the current version.

Comments

twillerror said on Jan 12, 2004 at 2:35 PM :

Is it possible to expand CFSTAT to give more information about the currently running command. Obviously this will require the metrics service to be expand. I would think that it would be easy to have the start process of each page write the name of the template, and more importantly the query string*. Then cfstat could simple dump the list of running pages and debugging would be far easier without having to do stack traces which are hard to create, and cause a server failure.

*The slow page logger in CF is currently useless for us because we use a fusebox design, That means every page looks like index.cfm, without the query string.

No screen name said on Jan 29, 2004 at 10:08 PM :

agree on fusebox... been searching for a year on a way to log slow
pages.......

mraazi said on Jun 1, 2004 at 11:34 PM :

Regarding cfstat utility, can you put an example of all possible usages of cfstat so that one can easily find the exact syntax of the command. Actually, I am trying to use getstat to write output to a file on the webserver coldfusion is using.

Regards,

- Khaliq

carehart said on Dec 30, 2004 at 2:03 PM :

In my use of CFMX 6.1, I'm finding that the "cache pops" metric listed above is no longer available (it is in CF5, though). Was this perhaps removed in MX?

playboyslb37 said on Jan 13, 2006 at 12:44 PM :

to use the cfstat utility form coldfusion:

<cfset statCaptureDelay = 3>
<cfexecute name="C:\CFusionMX\runtime\jre\bin\java" arguments="-cp C:\CFusionMXib\cfusion.jar coldfusion.tools.CfstatMain -s #statCaptureDelay#" timeout="#statCaptureDelay+1#" variable="stat"></cfexecute>
<cfdump var="#stat#">

ultracrisp said on Mar 10, 2006 at 2:44 PM :

In MX7, anyways, I needed to wrap your statCaptureDelay+1 value for timeout in "int()". Also you may need to add more than 1... I am using +10 in the below example.

<cfset statCaptureDelay = 3>
<cfexecute name="C:\CFusionMX\runtime\jre\bin\java" arguments="-cp C:\CFusionMXib\cfusion.jar coldfusion.tools.CfstatMain -s #statCaptureDelay#" timeout="#int(statCaptureDelay+10)#" variable="stat"></cfexecute>
<cfdump var="#stat#">

robsandeh said on Apr 28, 2006 at 3:31 PM :

Check out http://www.seefusion.com/. It gives you much more data.


Contents > Configuring and Administering ColdFusion MX > Basic ColdFusion MX Administration > Debugging & Logging section > Debugging Settings page Using the cfstat utility