Interacting with the Application Monitoring Web service
You can access the Application Monitoring Web service through, for example, the SOAP protocol. The Web service exposes a TridionMonitoringAgent interface with a GetStatus() method that returns an array of ServiceStatus elements.
ServiceStatus is an interface containing the members listed in the following table:
| Member name | Type | Description |
|---|---|---|
ServiceType | string | Uniquely identifies this type of service (for example, "Broker" or "Content Manager Search") |
ServiceInstance | string | Used only if multiple instances of the same type of service (say, multiple Content Deployers) run on the same machine to identify this specific instance. Otherwise set to null. |
ProcessId | int | The operating system ID of the process that runs this service; set to -1 if not applicable. |
Status (an enum ) | Status | The current status of the service, one of:
|
Message | string | An optional reason for the current status; set to null if not applicable or not available. |
StatusChangeTime | DateTime | The date and time at which the status last changed. |
LastReportTime | DateTime | The date and time at which the status was last checked (possibly without success); set to null if the status has never been checked. |
MonitoredThreadCount | int | The number of threads currently being monitored; set to 0 if there are currently no monitored threads, or to -1 if thread monitoring is not applicable. |
NonRespondingThreads | array of ThreadStatus | Details about threads that report problems; set to null if no threads are being polled or if no threads report problems. A
|
Example XML response to a SOAP request
The following is an example XML response to a SOAP request:
<ServiceStatus>
<ServiceType>Content Manager Publisher</ServiceType>
<ProcessId>2364</ProcessId>
<Status>NotResponding</Status>
<StatusChangeTime>2006-10-17T13:12:02Z</StatusChangeTime>
<LastReportTime>2006-10-17T14:46:02Z</LastReportTime>
<MonitoredThreadCount>15</MonitoredThreadCount>
<NonRespondingThreads>
<ThreadStatus>
<ThreadId>13</ThreadId>
<ThreadName>The name of the thread</ThreadName>
<StatusChangeTime>2006-10-17T13:12:02Z</StatusChangeTime>
<LastReportTime>2006-10-17T14:46:02Z</LastReportTime>
</ThreadStatus>
</NonRespondingThreads>
</ServiceStatus>
<ServiceStatus>
<ServiceType>Workflow Agent</ServiceType>
<ProcessId>2464</ProcessId>
<Status>NotResponding</Status>
<StatusChangeTime>2006-10-17T14:31:02Z</StatusChangeTime>
<LastReportTime>2006-10-17T14:47:02Z</LastReportTime>
<MonitoredThreadCount>2</MonitoredThreadCount>
</ServiceStatus>