Help Center/ API Gateway/ User Guide/ Monitoring/ API Gateway Metrics
Updated on 2022-09-26 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

Dedicated gateway: SYS.APIC

Metrics

Table 1 Dedicated gateway metrics

ID

Name

Description

Value Range

Monitored Object

Monitoring Period (Minute)

requests

Requests

Number of times that all APIs in a dedicated gateway have been called.

≥0

Dedicated gateway

1

error_4xx

4xx Errors

Number of times that all APIs in the dedicated gateway return a 4xx error.

≥0

Dedicated gateway

1

error_5xx

5xx Errors

Number of times that all APIs in the dedicated gateway return a 5xx error.

≥0

Dedicated gateway

1

throttled_calls

Throttled API Calls

Number of times that all APIs in the dedicated gateway have been throttled.

≥0

Dedicated gateway

1

avg_latency

Average Latency

Average latency of all APIs in the gateway.

≥0

Unit: ms

Dedicated gateway

1

max_latency

Maximum Latency

Maximum latency of all APIs in the gateway.

≥0

Unit: ms

Dedicated gateway

1

req_count

Requests

Number of times that an API has been called.

≥ 0

API

1

req_count_2xx

2xx Responses

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

≥ 0

API

1

req_count_4xx

4xx Errors

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

≥ 0

API

1

req_count_5xx

5xx Errors

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

≥ 0

API

1

req_count_error

Total Errors

Total number of errors returned by the API.

≥ 0

API

1

avg_latency

Average Latency

Average latency of the API.

≥ 0

Unit: ms

API

1

max_latency

Maximum Latency

Maximum latency of the API.

≥ 0

Unit: ms

API

1

input_throughput

Incoming Traffic

Incoming traffic of the API.

≥ 0

Unit: Byte, KB, MB, or GB

API

1

output_throughput

Outgoing Traffic

Outgoing traffic of the API.

≥ 0

Unit: Byte, KB, MB, or GB

API

1

Dimension

Table 2 Dedicated gateway monitoring dimensions

Key

Value

instance_id

Dedicated gateway

api_id

API