Debugging Output Settings page
Use the Debugging Settings and Debugging IPs pages to configure ColdFusion to provide debugging information for every application page that a browser request. Specify debugging preferences by using the pages as follows:
- On the Debugging Settings page, select debugging output options. If debugging is enabled, the output appears in block format after normal page output.
- On the Debugging IPs page, restrict access to debugging output. If a debugging option is enabled, debugging output is visible to all users by default.
The Debug Output Settings page provides the following debugging options:
|
Option |
Description |
|---|---|
|
Enable Robust Exception Information |
Displays detailed information in the exceptions page, including the template's physical path and URI, the line number and snippet, the SQL statement used (if any), the data source name (if any), and the Java stack trace. |
|
Enable Request Debugging Output |
Enables the ColdFusion debugging service. |
|
Select Debugging Output Format |
Controls debugging format. Select either of the following formats:
|
|
Report Execution Times |
Reports execution times that exceed a specified time limit. |
|
General Debug Information |
Show general information about the ColdFusion MX version, template, time stamp, user locale, user agent, user IP, and host name. |
|
Database Activity |
Shows the database activity for the SQL Query events and Stored Procedure events in the debugging output. |
|
Exception Information |
Shows all ColdFusion exceptions raised for the request in the debugging output. |
|
Tracing Information |
Shows trace event information in the debugging output. Tracing lets you track program flow and efficiency using the cftrace tag. |
|
Timer Information |
Shows output from the cftimer tag. |
|
Flash Form Compile Errors And Messages |
(Development use only) Displays ActionScript errors in the browser when Flash forms are compiling, and affects the display time of the page. |
|
Variables |
Displays information about parameters, URL parameters, cookies, sessions, and CGI variables in the debugging output. |
|
Enable Performance Monitoring (Server configuration only) |
Enables the standard NT Performance Monitor application to display information about a running server. TIP: Restart ColdFusion after you change this setting. |
|
Enable CFSTAT (Server configuration only) |
Shows performance information on platforms that do not support the NT Performance Monitor. For more information, see Using the cfstat utility. TIP: Restart ColdFusion after you change this setting. |
The cfstat command-line utility provides real-time performance metrics for ColdFusion. Using a socket connection to obtain metric data, the cfstat utility displays the information that ColdFusion writes to the System Monitor without actually using the System Monitor application. The following table lists the metrics that the cfstat utility 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 that ColdFusion makes. Any difference in complexity and resource load between calls is ignored. |
|
Req Q'ed |
Number of queued requests |
The number of requests that are currently waiting for ColdFusion 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 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 wait for ColdFusion 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 it takes ColdFusion 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 spends on database-related processing of ColdFusion requests. |
|
Bytes In/Sec |
Bytes incoming per second |
The number of bytes that ColdFusion read in the last second (not an average). |
|
Bytes Out/Sec |
Bytes outgoing per second |
The number of bytes that ColdFusion wrote in the last second (not an average). |
Before you use the cfstat utility, ensure that you selected the Enable Performance Monitoring option in the ColdFusion Administrator (on the Debugging & Logging > Debugging Settings page). If you select this option, you must restart ColdFusion for this change to take effect.
The cf_root/bin directory contains the cfstat utility. From that directory, type cfstat and use the following switches:
|
Switch |
Description |
Comment |
|---|---|---|
|
-n |
Suppress column headers. |
Useful for saving output to a file. |
|
-s |
Display output in a single line. |
Display a single line and delay display of the first line so the cfstat utility can display meaningful values in the per-second counters. |
|
# |
Where # is an integer, display output every # seconds. |
If you do not specify an integer, the cfstat utility returns one line. Specify this switch with or without the -s switch. |
This example runs the cfstat utility and displays a new line every 20 seconds:
cfstat 20
Debugging IP Addresses page
You use the Debugging IP Addresses page to restrict debugging output to one or more IP addresses. You can add and remove IP addresses.