Whatever message this page gives is out now! Go check it out!

GetMetricData

Last update:
May 18, 2026

Description

Gets server performance metrics.

Returns

ColdFusion structure that contains metric data, depending on the mode value.

Category

Function syntax

GetMetricData(mode)

History

  • ColdFusion (2025 release): Removed the cachepops parameter.
  • ColdFusion MX: Deprecated the cachepops parameter.

Parameters

Parameter
Option
Description
mode
perf_monitor
Returns internal data, in a structure.To receive data, enable PerfMonitor in ColdFusion Administrator before executing the function. On Windows, this data is otherwise displayed in the Windows PerfMonitor.
simple_load
Returns an integer value that is computed from the state of the server's internal queues. Indicates the overall server load.
prev_req_time
Returns the time, in milliseconds, that it took the server to process the previous request.
avg_req_time
Returns the average time, in milliseconds, that it takes the server to process a request.Changing the setting to 0 prevents the server from calculating the average and removes overhead associated with gathering data.The default value is 120 seconds.

Usage

If mode = "perf_monitor", the function returns a structure with these data fields:
Field
Description
InstanceName
The name of the ColdFusion server. The default value is cfserver.
PageHits
Number of HTTP requests received since ColdFusion was started.
ReqQueued
Number of HTTP requests in the staging queue, waiting for processing.
DBHits
Number of database requests since the server was started.
ReqRunning
Number of HTTP requests currently running. In the ColdFusion Administrator, you can set the maximum number of requests that run concurrently.
ErrorCount
Number of HTTP requests that failed while in the staging queue or during processing.
BytesIn
Number of bytes in HTTP requests to ColdFusion.
BytesOut
Number of bytes in HTTP responses from ColdFusion.
AvgQueueTime
For the last two HTTP requests (current and previous), the average length of time the request waited in the staging queue.
AvgReqTime
For the last two HTTP requests (current and previous), the average length of time the server required to process the request
AvgDBTime
For the last two HTTP requests (current and previous), the average length of time the server took to process CFQueries in the request.
cachepops
This parameter is removed.

Example

<!--- This example gets and displays metric data from Windows NT PerfMonitor ---> 
 <cfset pmData = GetMetricData( "PERF_MONITOR" ) > 
 <cfoutput> 
 Current PerfMonitor data is: <p> 
 InstanceName: #pmData.InstanceName# <p> 
 PageHits: #pmData.PageHits# <p> 
 ReqQueued: #pmData.ReqQueued# <p> 
 DBHits: #pmData.DBHits# <p> 
 ReqRunning: #pmData.ReqRunning# <p> 
 ErrorCount: #pmData.ErrorCount# <p> 
 BytesIn: #pmData.BytesIn# <p> 
 BytesOut: #pmData.BytesOut# <p> 
 AvgQueueTime: #pmData.AvgQueueTime# <p> 
 AvgReqTime: #pmData.AvgReqTime# <p> 
 AvgDBTime: #pmData.AvgDBTime# <p> 
 </cfoutput>

Share this page

Was this page helpful?
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Thank you for your feedback. Your response will help improve this page.

On this page