
133
CONFIGURING AND ADMINISTERING COLDFUSION 10
Using the ColdFusion Server Monitor
L
ast
u
p
dated
7/9/2
01
2
•
The threshold for either an unresponsive server or a slow server is exceeded
When you click Trigger Snapshot, the Server Monitor collects the information for the snapshot and saves it in a file
named snapshot_usrgen_
timestamp
.txt in the
cf_root
/logs/snapshots folder. When the Server Monitor creates a
snapshot, it saves the information in a file named snapshot_sysgen_timestamp.txt in the
cf_root
/logs/snapshots folder.
Specifying Server Monitor Settings
To specify the settings to use to generate reports, click Settings.
You can specify the following:
•
How often to refresh Server Monitor reports
•
How often to refresh Server Monitor graphs
•
How often to calculate average response times
•
Whether to show the entire template path
To specify what file paths to exclude and include in monitoring and whether to monitor the ColdFusion
Administrator, click Settings, and then click the Filter Settings tab.
To specify what file paths to exclude from profiling, click Settings, and then click the Profiling Filter tab.
By default, the Server Monitor collects information about all ColdFusion templates in the
webroot
directory and its
subdirectories and in any directories specified on the Mappings page of the ColdFusion Administrator. However, you
might not want to monitor all requests on the server. You specify a path to exclude so that the Server Monitor does not
collect information about files in that directory or in any of its subdirectories. This capability is especially useful in
restricting monitoring on production servers. Use the Include Paths option to monitor any subdirectories of an
excluded directory.
To specify an alias for a template path, click Settings, and then click the Aliasing tab.
ColdFusion Server Monitor API
Use the Server Monitor API to programmatically retrieve all the data that the Server Monitor collects. The
servermonitoring.cfc ColdFusion component contains methods that you call to perform Server Monitor tasks. For
example, use the getAverageResponseTime method to get the average response time for the server.
To view the methods, method arguments, and documentation for the Server Monitor API, use the CFC Explorer. To
do so, go to http://localhost:8500/CFIDE/adminapi/servermonitoring.cfc.
Use the Server Monitor API
1
Instantiate administrator.cfc:
<cfscript>
adminObj = createObject("component","cfide.adminapi.administrator");
Note:
You can instantiate administrator.cfc and call the
login
method in a single line of code, as the following
example shows:
createObject("component","cfide.adminapi.administrator").login("admin");