Updated on 2022-02-21 GMT+08:00

API Gateway Metrics

Introduction

This section describes the metrics that API Gateway reports to the Cloud Eye service. You can view metrics and alarms by using the Cloud Eye console.

Namespace

Shared gateway: SYS.APIG

Metrics

Table 1 Shared gateway metrics

Metric ID

Metric Name

Description

Value Range

Monitored Object and Dimension

Monitoring Interval (Minute)

avg_latency

Average Latency

Average latency of the API.

≥ 0

Unit: ms

Monitored object: an API

Dimension: api_id

1

input_throughput

Incoming Traffic

Incoming traffic of the API.

≥ 0

Unit: Byte, KB, MB, or GB

Monitored object: an API

Dimension: api_id

1

max_latency

Maximum Latency

Maximum latency of the API.

≥ 0

Unit: ms

Monitored object: an API

Dimension: api_id

1

output_throughput

Outgoing Traffic

Outgoing traffic of the API.

≥ 0

Unit: Byte, KB, MB, or GB

Monitored object: an API

Dimension: api_id

1

req_count

Requests

Number of times that the API has been called.

≥ 0

Monitored object: an API

Dimension: api_id

1

req_count_2xx

2xx Responses

Number of times that the API returns a 2xx response.

≥ 0

Monitored object: an API

Dimension: api_id

1

req_count_4xx

4xx Errors

Number of times that the API returns a 4xx error.

≥ 0

Monitored object: an API

Dimension: api_id

1

req_count_5xx

5xx Errors

Number of times that the API returns a 5xx error.

≥ 0

Monitored object: an API

Dimension: api_id

1

req_count_error

Total Errors

Total number of errors returned by the API.

≥ 0

Monitored object: an API

Dimension: api_id

1

Dimension

Table 2 Shared gateway monitoring dimension

Key

Value

api_id

API