The API monitoring feature is used to monitor the details of API calls of an application. This feature allows you to monitor the SQL analysis, NoSQL analysis, exception analysis, error analysis, upstream and downstream services, and traces.
To go to the Interface Invocation page, perform the following steps:
- Log on to the ARMS console .
- In the left-side navigation pane, choose . In the top navigation bar, select a region.
- On the Applications page, click the name of the application that you want to view.
- In the left-side navigation pane, click Interface Invocation.
This feature can automatically detect and monitor the APIs provided in the following web frameworks and remote procedure call (RPC) frameworks:
- Tomcat 7+
- Jetty 8+
- Resin 3.0+
- Undertow 1.3+
- WebLogic 11.0+
- SpringBoot 1.3.0+
- HSF 2.0+
- Dubbo 2.5+
View the details of an API
On the Overview tab, you can view the detailed call topology of an API and the time sequence curves about the number of requests, number of errors, response time, and HTTP status codes.
View SQL and NoSQL analysis
On the SQL Analysis and NoSql Analysis tabs, you can view the SQL and NoSQL requests that are initiated within the code of the selected API in the left-side pane. On these tabs, you can find the SQL statements or NoSQL statements that cause slow responses of an API. You can also click Trace Query in the Actions column of an SQL or NoSQL statement to view the complete trace where the SQL or NoSQL execution logic resides.
View exception analysis
The Exception Analysis tab shows the Java exceptions that are thrown from the code of the selected API in the left-side pane. You can also click Trace Query in the Actions column of an exception to view the complete trace where the exception stack resides.
View error analysis
On the Error Analysis tab, you can view the errors and HTTP status codes of the application. You can also click a value in the TraceId column to view the trace information on a new page.
View the details of API calls for upstream and downstream services
On the Upstream Services and Downstream Services tabs, you can view the APIs and performance metrics of the upstream services that call the application and downstream services that are called by the application. The performance metrics include the response time, number of requests, and number of errors.
On the Upstream Traces and Downstream Traces tabs, you can perform the following operations based on your business requirements:
- Click Expand/Collapse All in the upper part of the tab to show or hide all APIs.
- Enter a keyword of the application name or the API name in the search box and click the Search icon to search for the APIs whose names contain the keyword.
- If you want to show or hide the information about the performance metrics of an API, find the API and click the collapse panel or click the upward arrow or downward arrow at the end of the row.
On the Trace Query tab, you can view the parameters of the selected API and two charts that are generated based on the parameters. The charts show the statistics on the total number of API calls and the RT of API calls.
- The Total Traces chart shows the total number of API calls and the number of slow API calls. If the RT of an API call exceeds 500 milliseconds, the API call is defined as a slow API call. The threshold can be configured in the application settings. The number of slow API calls does not include local API calls that are generated in asynchronous scenarios.
- The API response time chart shows the RT trend over time. The chart is generated based on the statistics on API calls and is affected by the sampling rate that you specify.
- The trace details table shows the detailed trace information. You can click a value in the TraceId column to view the trace information and business information. You can also click View Logs in the Actions column to view the logs of API calls.