Monitoring Metrics¶
Introduction¶
This section describes the metrics that APIG reports to the Cloud Eye service. You can view metrics and alarms by using the Cloud Eye console.
Namespace¶
SYS.APIC
Metrics¶
Metric ID | Metric Name | Description | Value Range | Monitored Object and Dimension | Monitoring Period (Minute) |
|---|---|---|---|---|---|
requests | Requests | Number of times that all APIs in a dedicated gateway have been called. | >= 0 | Monitored object: dedicated API gateway Dimension: instance_id | 1 |
error_4xx | 4xx Errors | Number of times that all APIs in the dedicated gateway return a 4xx error. | >= 0 | Monitored object: dedicated API gateway Dimension: instance_id | 1 |
error_5xx | 5xx Errors | Number of times that all APIs in the dedicated gateway return a 5xx error. | >= 0 | Monitored object: dedicated API gateway Dimension: instance_id | 1 |
throttled_calls | Throttled API Calls | Number of times that all APIs in the dedicated gateway have been throttled. | >= 0 | Monitored object: dedicated API gateway Dimension: instance_id | 1 |
avg_latency | Average Latency | Average latency of all APIs in the gateway. | >= 0 Unit: ms | Monitored object: dedicated API gateway Dimension: instance_id | 1 |
max_latency | Maximum Latency | Maximum latency of all APIs in the gateway. | >= 0 Unit: ms | Monitored object: dedicated API gateway Dimension: instance_id | 1 |
req_count | Requests | Number of times that an API has been called. | >= 0 | Monitored object: API Dimension: api_id | 1 |
req_count_2xx | 2xx Responses | Number of times that the API returns a 2xx response. | >= 0 | Monitored object: API Dimension: api_id | 1 |
req_count_4xx | 4xx Errors | Number of times that the API returns a 4xx error. | >= 0 | Monitored object: API Dimension: api_id | 1 |
req_count_5xx | 5xx Errors | Number of times that the API returns a 5xx error. | >= 0 | Monitored object: API Dimension: api_id | 1 |
req_count_error | Total Errors | Total number of errors returned by the API. | >= 0 | Monitored object: API Dimension: api_id | 1 |
avg_latency | Average Latency | Average latency of the API. | >= 0 Unit: ms | Monitored object: API Dimension: api_id | 1 |
max_latency | Maximum Latency | Maximum latency of the API. | >= 0 Unit: ms | Monitored object: API Dimension: api_id | 1 |
input_throughput | Incoming Traffic | Incoming traffic of the API. | >= 0 Unit: Byte, KB, MB, or GB | Monitored object: API Dimension: api_id | 1 |
output_throughput | Outgoing Traffic | Outgoing traffic of the API. | >= 0 Unit: Byte, KB, MB, or GB | Monitored object: API Dimension: api_id | 1 |
node_system_load | Node System Load | Load details of a gateway node on the data plane. 1 means low water level, 2 means medium water level, and 3 means high water level. | 1, 2, 3 Unit: count | Monitored object: gateway node Dimension: node_ip | 1 |
node_cpu_usage | Node CPU Usage | CPU usage details of a gateway node on the data plane. | >= 0 Unit: % | Monitored object: gateway node Dimension: node_ip | 1 |
node_memory_usage | Node Memory Usage | Memory usage details of a gateway node on the data plane. | >= 0 Unit: % | Monitored object: gateway node Dimension: node_ip | 1 |
Dimension¶
Key | Value |
|---|---|
instance_id | Dedicated gateway |
instance_id,node_ip | Dedicated gateway node |
instance_id,api_id | API |