Displaying Performance Metrics for Assets (APIs)

Pre-requisites:

The following general guidelines apply when displaying the Key Performance Indicator (KPI) metrics:

Ensure that webMethods Mediator is configured to collect and report runtime metrics.

You must configure Mediator to communicate with CentraSite (in the Integration Server Administrator, go to Solutions > Mediator > Administration > CentraSite Communication). For procedures, see Administering webMethods Mediator.

Ensure that CentraSite is configured to receive runtime metrics from Mediator.

Ensure that you have at least an instance-level View permission on the Runtime Metrics profile of the asset.

Ensure that the type's definition (for example, Virtual Service) includes the Runtime Metrics profile to view runtime metric information for its asset instance.

Gateways capture runtime metrics for assets. If you are using the Mediator gateway, Mediator's data collector captures KPI metrics for each asset and publishes them to CentraSite at regular intervals. If you are using a runtime monitoring component such as Insight, the monitoring component captures the KPI metrics of all rogue assets and publishes them to CentraSite at regular intervals.

Note:
If you receive a Javascript error when trying to display the Performance profile, please install the latest versions of the Adobe Flash Player/Shockwave Player plug-ins on your Microsoft Internet Explorer.

To display the runtime performance of an asset (API)

1. In CentraSite Business UI, access the Advanced Search panel in one of the following ways:

Click the Browse link that is located in the upper-left corner of the menu bar.

Click the Search icon that is located next to the Scope list. The default search scope is Assets.

A list of defined assets in CentraSite is displayed in the Search Results page.

2. In the Additional Search Criteria list, select Asset Types.

3. To search for the assets of type, Virtual Service, click Choose.

4. In the Choose Asset Types dialog box, select the Assets option button, and follow these steps:

a. Click the chevron next to Assets option button.

b. In the list of asset types, select Virtual Service.

c. Click OK.

A list of defined Virtual Service assets is displayed in the Search Results page.

5. Click the Virtual Service whose runtime metrics you want to examine.

This opens the Virtual Service details page.

6. Select the Runtime Metrics profile.

7. Expand the Filters node.

8. Specify the exact set of attributes you want to use to filter the metrics list.

In this field...	Do the following...
Gateway	Select a particular gateway to which the virtual service is published, or select All to view the metrics of all gateways to which the virtual service is published. CentraSite displays None by default.
Date Range	Specify a range of dates to view the metrics for the virtual service. For example, Last 1 hour, Last 12 hours, Last 1 day, Last 5 days, Last 10 days, Last 20 days, Custom. CentraSite displays Last 10 days by default.
Start Date/End Date	If you have selected the Custom option in the previous field, specify the time period to view the metrics list. 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	Specify the running count metrics of the virtual service at the displayed 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.

9. Click Refine.

CentraSite displays a graphical view of the run-time metrics for all performance categories as shown below:

Multi-line Chart. The chart shows the Minimum Response Time, Maximum Response Time, and Average Response Time of the API.

Pie Chart. The chart shows the Success Request Counts, Total Request Counts, and Fault Counts of the API.

Gauge Chart. The chart shows the availability of the API.