Monitor APIs

Analytics

API Gateway provides monitoring capabilities to monitor API Gateway and API usage by collecting and analyzing data about the availability and performance of an API. This helps in identifying problems that impact users. In addition to monitoring the performance of APIs, you may also want to get an insight into how developers are using the published APIs. This data provides a better understanding of any improvements that might be required to enhance the API usage or performance.

The analytics dashboard in the API Gateway UI displays a variety of charts to provide an overview of API Gateway performance and its API usage. The data for these dashboards come from the API Gateway destination store. The dashboard has various filters that you can apply depending on what you want to monitor. API Gateway also provides the capability to create a custom dashboard.

The dashboard view depends on the events and metrics generated in API Gateway and their types. An event is a kind of notification or alert generated by the API Gateway Metrics and Event Notification module. Various types of event are generated based on the behavior of the transactions in the system. Events generated by API Gateway are real time events made persistent in the store and sent to configured destinations.

These are the types of events generated in API Gateway:

Note: Internalization is not supported in API Gateway dashboards.

For details on Run time events and Metrics data model, see Run time events and Metrics data model.

API Gateway Dashboard

The dashboard displays the API Gateway-wide analytics based on the metrics monitored. Click icon > Analytics to access API Gateway-wide analytics.

To filter the API Gateway-wide-specific analytics, select the time interval using the options:

API-specific Dashboard

You can view the API-specific dashboard by navigating to the API details page and clicking the Analytics icon for the specific API. The dashboard displays the following analytics based on the metrics monitored.

To filter the API-specific analytics, select the time interval using the options:

When you log in and view the analytics, the last used time interval is saved for each dashboard. When you view the dashboard again, the last used time interval for that dashboard is applied. The last used time interval is valid for the current session only.

For the specified time interval you can also filter based on an API. The API drop-down list displays all the APIs. On selecting an API, the data displayed is for the selected API.

You can click on the specific event in the list under Legend to view the specific event in any of the widgets. You can view additional details for an event by hovering the cursor over a particular color in the graphical representations.

Metric Description
Events over time Displays the trending of events generated by the selected API over time.
API invocations Displays the number of time the API was invoked during the specified time.
API invocations -Status wise Displays the number of successful API invocations and failed API invocations during the specified time.
API invocations - Status wise API invocations is the sum of successful API invocations and failed API invocations
API invocation pattern Displays API invocation over period of time during the specified time interval in the form of a line graph.
Gateway vs Provider time Displays the comparison between gatewayTime performance and providerTime performance.
Native service performance Displays information on how fast the native service responds to the request received in the specified time based on the data in the transactional event.
Response code trend Displays the trend based on the response codes received from various events for the API during the specified time.
API trend by response Displays the trending of the selected API based on the response time from the performance metrics for that API.
Success vs Failure Displays the trending of API based on its success rate as compared to its failure rate in the performance metrics for the specified time.
Runtime events Displays the run time event details for the selected API. Displays information on the event type, date when the event was created, the agent on which the event was generated, description of the alert generated, the source of event, and the application that generated the event.
Service result cache Displays a bar graph showing the number of responses served from cache and the number of responses fetched from the native service at the operation level for the selected API during the specified time.
The Service result cache metric graphical representation is not supported for GraphQL API.
Method level invocations Displays the method level invocations per operation for the API during the specified time.
You can hover the cursor over the stacked bar chart to view the various methods invoked per operation or resource and also the operations or resources for the selected API during the specified time.
The Service result cache metric graphical representation is not supported for GraphQL API.