ColdFusion 8: Server Monitor API
In an earlier post I talked a bit about how the Admin API has been updated in ColdFusion 8. For folks who don't know what this is - it is a way to get into the internals of ColdFusion directly from CFML. It requires the ColdFusion Admin password, which may be a negative for some, but if you have access to it, you can do quite a bit. As an example, I could build an installer for BlogCFC that would prompt the user for the CF Admin password and then handle creating the datasource for you. So it's cool. We know that. But how cool is it in ColdFusion 8?
Well you know that server monitor that ships with the product? If you haven't seen it, you need to spend some time with it. I spent 5 minutes running it with BlogCFC and saw immediate, serious performance issues I was able to correct. 5 minutes to improve my application in a dramatic way is worth the cost of ColdFusion 8 right there. But did you know that 100% of what you see in the Flex application is available to you via code?
Added to the Admin API is a new CFC, the Server Monitoring CFC. This CFC gives you access to everything you see in the Flex app, and maybe a bit more. Now it is important to note that each method has different requirements for server monitoring. Some require that memory tracking is turned on. Some require nothing. Some return data but will return more data if memory tracking is on. You should read the docs carefully to see what each method requires.
What follows is a short list of some of what is available...
Get Active Session Count
This lets you get the total number of active sessions for the server - or you can supply a ColdFusion Application name and get the number just for that application.
Get Average Response Time
This is a great metric. It tells you - on average - how quickly your templates are responding.
Get Heartbeat
This returns a structure of general information. This includes a variety of items like server up time, average request time, current requests, etc.
Get Memory Utilization Summary
As you can guess - this returns information about your memory usage. It tells you how much data your Application, Server, and Session scope data is using.
Get Hit Count Stats
Now this one is truly cool. Along with telling you how many normal template hits you have - it can tell you the number of web service hits - the number of Flash Remoting hits - even the number of direct HTTP hits to your CFCs.
Get Logged In User Count
Returns the number of users logged in via CFLOGINUSER.
Get All Application Scope Memory Used
This returns all your applications and the amount of RAM they are using. Have a machine that is running a bit slow? Run this and it will tell you if one application in particular is being a bad boy. You can follow it up with getApplicationScopeMemoryUsed which returns specific data about one particular application.
Cool stuff, eh? It is important to note that using these features will have an impact on your server performance. I had a demo online, but I could really tell the impact of the monitoring so I turned it off. But if you want to see the code I used (with a different Admin password of course, I trust some of you guys... ;), look here:
<cfinvoke component="cfide.adminapi.administrator" method="login" adminPassword="mypasswordcanbeatupyourpassword">
<cfinvoke component="cfide.adminapi.servermonitoring" method="getActiveSessionCount" returnVariable="result">
Total session count = <cfdump var="#result#">
<p>
<cfinvoke component="cfide.adminapi.servermonitoring" method="getActiveSessionCount" returnVariable="result" cfapplicationname="lighthousepro">
For app lighthousepro = <cfdump var="#result#">
<p>
<cfinvoke component="cfide.adminapi.servermonitoring" method="getAverageResponseTime" returnVariable="result">
<cfoutput>Average response time is #result#</cfoutput>
<p>
<cfinvoke component="cfide.adminapi.servermonitoring" method="getHeartbeat" returnVariable="result">
<cfdump var="#result#" label="Heart Beat">
<p>
<cfinvoke component="cfide.adminapi.servermonitoring" method="getMemoryUtilizationSummary" returnVariable="result">
<cfdump var="#result#" label="Memory Utilization">
<p>
<cfinvoke component="cfide.adminapi.servermonitoring" method="getHitCountStats" returnVariable="result">
<cfdump var="#result#" label="Hit Count Stats">
<p>
<cfinvoke component="cfide.adminapi.servermonitoring" method="getLoggedInUserCount" returnVariable="result">
Logged in users = <cfdump var="#result#">
<p>
Comments
Since CF 8 Enterprise supports monitoring multiple machines, you would think that the ability to do that via the API might be included as well, but as Ray mentions, so far, it looks like you can only monitor the server where the CFC lives.
A little more digging (or comment from the CF team) might be in order here.
http://carehart.org/blog/client/index.cfm/2007/6/1...
Jay
In other words - the CFC currently seems to show everything you get in the Server Monitor. Great.
But where is the API for the Multiserver Monitor?
So in theory, we don't need another API at all, we just point to the other box.
Again - if I'm reading you right.
<cfinvoke component="cfide.adminapi.servermonitoring" method="getActiveSessionCount" returnVariable="result"
name="myApp1">
Total session count = <cfdump var="#result#">
Isnt this undocumented?
Isnt this cfc encrypted?
How would I do this?
Can I point to your blog.cfc and see this working?
How do I make Server Monitor display data for, say, two weeks, without having to keep my browser open? Is it even possible? :(
But then I read the part where you said that with monitoring switched on you noticed it slowed the site down. Doh. Perhaps there's a way to only monitor just 1 statistic instead of having everything being monitored?
Do you know if the API lets you access stats from a cluster or does it limit you to just one server's stats at a time? e.g. average response time for the cluster, the number of sessions over the entire cluster, etc.