All Products
Search
Document Center

Use API Gateway for monitoring

Last Updated: Jan 11, 2021

This topic describes how to view the information about API calls in the API Gateway console as an administrator.

Overview

API Gateway allows you to view monitoring charts about regions, groups, and APIs. The performance metrics of monitoring charts include traffic, delay, HTTP status codes, and the number of requests.

1 Region monitoring

1.1 Log on to the API Gateway console.

1.2 In the left-side navigation pane, click Overview. To view the monitoring charts of a region, click the Monitor icon for the region. You can view the monitoring data, the number of API groups, the number of APIs, and the number of dedicated instances in use in every region. You can also view the number of dedicated instances that will expire in 10 days in every region.

Overview page

1.3 The region monitoring feature provides the statistics about the API calls from only the past seven days. The APIs that run on shared instances (classic network) are excluded from the statistics. You can view monitoring charts based on the following environments where APIs are published: online, staging, and testing environments. The monitoring data is collected based on the following performance metrics:

  • The number of API requests

  • The number of API requests by instance

  • Traffic statistics (request traffic and response traffic)

  • Average delay (processing delay of API Gateway and backend processing delay)

  • Proportions of HTTP status codes

Performance metrics for region monitoring

2 Group monitoring

2.1 Log on to the API Gateway console.

2.2 In the left-side navigation pane, choose Publish APIs > API Groups. On the Groups List page, click the Monitor icon for a group to view the monitoring charts about the group.

Manage groups

2.3 The group monitoring feature provides the statistics about the API calls from only the past seven days. The APIs that run on shared instances (classic network) are excluded from the statistics. You can view monitoring charts based on the following environments where APIs are published: online, staging, and testing environments. The monitoring data is collected based on the following performance metrics:

  • The number of API requests

  • Traffic statistics (request traffic and response traffic)

  • Average delay (processing delay of API Gateway and backend processing delay)

  • Proportions of HTTP status codes

Group monitoring charts

3 API monitoring

3.1 Log on to the API Gateway console.

3.2 In the left-side navigation pane, choose Publish APIs > APIs. Click the API that you want to monitor. On the page that appears, you can view the details about the API.

APIs

3.3 In the left-side navigation pane, click Monitoring Info. On the page that appears, you can view the monitoring data from the past week for the API that is published in the online, test, or staging environment. The monitoring data is collected based on the following performance metrics:

  • The number of requests (successful requests and exceptions)

  • Traffic (uplink and downlink)

  • The response time of the backend service

  • Error distribution (client errors and server errors)

Monitoring information about APIs
Note

API Gateway provides monitoring statistics about the API calls from only the past seven days. If you need to obtain statistics from a longer period or have other requirements, you can use Log Service. For more information, see Use Log Service to view logs of API calls.

The monitoring feature of API Gateway is available for dedicated instances that are purchased after September 15, 2020. If your dedicated instance is purchased before September 15, 2020 and you need to use the feature, submit a ticket to update your instance to the new version.