ColdFusion サーバーモニタ API

サーバーモニタ API の使用
例

サーバーモニタ API を使用すると、サーバーモニタが収集するすべてのデータをプログラムで取得することができます。ColdFusion コンポーネントの servermonitoring.cfc に、サーバーモニタのタスクを実行するために呼び出すメソッドが含まれています。たとえば、サーバーの平均応答時間を取得するには、getAverageResponseTime メソッドを使用します。

サーバーモニタ API のメソッド、メソッド引数、およびマニュアルを参照するには、CFC Explorer を使用してください。そのためには、http://localhost:8500/CFIDE/adminapi/servermonitoring.cfc にアクセスします。

サーバーモニタ API の使用

次のようにして、administrator.cfc をインスタンス化します。
```
<cfscript> 
    adminObj = createObject("component","cfide.adminapi.administrator");
```
注意：次のように、administrator.cfc のインスタンス化と loginメソッドの呼び出しを 1 行のコードで実行することもできます。
```
createObject("component","cfide.adminapi.administrator").login("admin");
```
administrator.cfc の login メソッドを呼び出す際には、次のように ColdFusion Administrator パスワードまたは RDS パスワードを渡します。
```
adminObj.login("admin");
```
次のようにして、サーバーモニタ CFC をインスタンス化します。
```
myObj = createObject("component","cfide.adminapi.servermonitoring");
```
目的の CFC メソッドを呼び出します (この例では、getAverageResponseTime を使用しています)。
```
myObj.getAverageResponseTime();
```

例

次の例では、サーバーモニタ API を使用して ColdFusion サーバーが接続しているデータソースと接続数をリストしています。

<cfscript> 
       // Login to the ColdFusion Administrator. 
       adminObj = createObject("component","cfide.adminapi.administrator"); 
       adminObj.login("admin"); 
 
       // Instantiate the Server Monitor object. 
       myObj = createObject("component","cfide.adminapi.servermonitoring"); 
 
       //  Get the dsn pool data array 
       dbpool = myObj.getDbPoolStats(); 
</cfscript> 
 
<!---  List the data sources ---> 
The ColdFusion server is connected to the following data sources:<br />  
<cfloop index="i" from="1" to="#ArrayLen(dbpool)#">  
       <cfoutput>#dbpool[i].DSN# #dbpool[i].TOTALCONNECTIONCOUNT#<br /></cfoutput> 
</cfloop>