You can view the events and metrics for an API in its Runtime Metrics profile and Runtime Events profile.
To view the runtime information for an API, you must have View permission on the Runtime Metrics profile and Runtime Events profile of that particular API.
The following sections describe how to view the runtime information of an API.
You view the following types of Key Performance Indicator (KPI) metrics that webMethods Mediator creates in the Runtime Metrics profile of each API.
| Metric | Description |
|---|---|
| Availability | The percentage of time that a service was available during the current interval. A value of 100 indicates that the API was always available. If invocations fail due to policy violations, this parameter could still be as high as 100. |
| Success Count | The number of successful service invocations in the current interval. |
| Total Request Count | The total number of requests (successful and unsuccessful) in the current interval. |
| Fault Count | The number of failed invocations in the current interval. |
| Average Response Time | The average amount of time it took the service to complete all invocations in the current interval. This is measured from the moment Mediator receives the request until the moment it returns the response to the caller. |
| Minimum Response Time | The minimum amount of time it took the service to complete an invocation in the current interval. |
| Maximum Response Time | The maximum amount of time it took the service to complete an invocation in the current interval. |
Notes:
pg.PgMetricsFormatter.includeFaults parameter to true.
For details, see Advanced Settings in the document
Administering webMethods Mediator.
Use the following procedure to display runtime metrics for a virtualized asset.
You must configure Mediator to communicate with CentraSite (in the Integration Server Administrator, go to ). For the procedure, see the section Configuring Communication with CentraSite in the document Administering webMethods Mediator.
To view the runtime metrics, the following prerequisites must be met:
To view the runtime metrics of an API, it is necessary that the virtual type's definition includes the Runtime Metrics profile.
If you do not see the Runtime Metrics profile of an API, it is probably because you do not have “View” permission for the profile.
To display runtime metrics for an asset
In CentraSite Business UI, display the details page for the asset whose runtime metrics you want to view. If you need procedures for this step, see the section Viewing Details for an API Proxy.
Open the Runtime Metrics profile.
Expand the Filters node.
Use the following fields to filter the metrics list you want to view:
| In this field... | Specify... |
|---|---|
| Target |
A target of the asset, or select All to view the metrics of all targets to which the virtual service is deployed. CentraSite displays None by default. |
| Date Range |
A range of dates from which to view the metrics (e.g., Last 1 hour, Last 12 hours, Last 1 day, Last 5 days, Last 10 days, Last 20 days, Custom, etc.). CentraSite displays Last 10 days by default. |
| Start Date/End Date |
If chosen Custom in the previous field, then the time period for which to view the metrics. Start Date: Click the calendar and select a starting date and time. End Date: Click the calendar and select a ending date and time. |
| Display Interval |
A running count metrics of the service displayed at regular time intervals. The interval is specified in the format 3m 2d 6h; wherein m indicates the month, d indicates the day and h indicates the hour. |
Click .
CentraSite displays a graphical view of the metrics for all performance categories as shown below:
The chart shows the Minimum Response Time, Maximum Response Time and Average Response Time of the API.
The chart shows the Success Request Counts, Total Request Counts and Fault Counts of the API.
The chart shows the availability of the API.
CentraSite can receive the following predefined runtime event types.
To view the runtime metrics, the following prerequisites must be met:
You must configure Mediator to communicate with CentraSite (in the Integration Server Administrator, go to ). For the procedure, see the section Configuring Communication with CentraSite in the document Administering webMethods Mediator.
You must configureCentraSite to receive run-time events from Mediator, as described in the section Managing Targets and Run-Time Events .
| Event Type | Description |
|---|---|
| Lifecycle | A Lifecycle event occurs each time Mediator is started or shut down. |
| Error | An Error event occurs each time an invocation of an API results in an error. |
| Policy Violation | A Policy Violation event occurs each time an invocation of an API violates a run-time policy that was set for the API. |
| Transaction | A Transaction event occurs each time an API is invoked (successfully or unsuccessfully). |
| Monitoring | Mediator publishes key performance indicator (KPI) metrics, such as the average response time, fault count, and availability of all APIs (described below). |
Notes:
Use the following procedure to display runtime events for a virtualized asset.
To view the runtime events, the following prerequisites must be met:
To view the runtime events of an API, it is necessary that the virtual type's definition includes the Runtime Events profile.
If you do not see the Runtime Events profile of an API, it is probably because you do not have “View” permission for the profile.
To display event information for an asset
In CentraSite Business UI, display the details page for the asset whose runtime events you want to view. If you need procedures for this step, see the section Viewing Details for an API Proxy.
Open the Runtime Events profile.
Use the following fields to filter the event list you want to view:
| In this field... | Specify... |
|---|---|
| Target |
A target of the asset, or select All to view the event information of all targets to which the API is deployed. CentraSite displays None by default. |
| Consumer |
A consumer of the asset, or select All to view the runtime event information of all consumers of the asset. CentraSite displays All by default. However, if you do not have at least one consumer registered in the registry, CentraSite displays None by default. |
| Event Type |
A particular event type, or select All to view all event types. For a list of the supported event types, see the above section The Runtime Events. CentraSite displays All by default. |
| Date Range |
A range of dates from which to view the events (e.g., Last 1 hour, Last 12 hours, Last 1 day, Last 5 days, Last 10 days, Last 20 days, Last 1 month, Custom, etc.). CentraSite displays Last 1 month by default. |
| Start Date/End Date |
If chosen Custom in the previous field, then the time period for which to view the metrics. Start Date: Click the calendar and select a starting date and time. End Date: Click the calendar and select a ending date and time. |
| Display Interval |
A running count events of the service displayed at regular time intervals. The interval is specified in the format 3m 2d 6h; wherein m indicates the month, d indicates the day and h indicates the hour. |
Click the button.
Expand the Graphical node to display a graphical view of the event information.
Expand the Tabular node.
CentraSite displays a tabular view of the event information in the left pane.
| Field | Description |
|---|---|
| Date/Time | The date/time that the event occurred. Click this hyperlinked value to view the Event Detail page, which will contain the event's SOAP request or response name in the Attribute column. Click the hyperlinked request or response name to display the full SOAP request or response. |
| Event Type | (Read-only.) The type of event (e.g., Monitoring, Policy Violation, Error, etc.). |
| Target | (Read only.) The target on which the event occurred. |
To access the details of an event, click on the link for the event.
The Event Details dialog in the right pane shows a detailed information about the event that you select in the left pane.
