Yandex API Gateway metrics
Written by
Updated at August 9, 2024
This section describes API Gateway metrics delivered to Monitoring.
The metric name is written to the name label.
All API Gateway metrics have common labels:
| Label | Value |
|---|---|
| gateway | API gateway ID |
| path | Request path |
| service | Service label, always serverless-apigateway |
API metrics
Common labels for all API gateway metrics:
| Label | Value |
|---|---|
| release | API gateway version |
| operation | Request method, e.g., GET, POST |
| Metric name Type, unit |
Description Labels |
|---|---|
api_gateway.errors_count_per_secondDGAUGE, requests/s |
Number of invalid requests per second.code label: Response code, e.g., 200, 404, 502. |
api_gateway.requests_count_per_secondDGAUGE, requests/s |
Number of requests per second.code label: Response code, e.g., 200, 404, 502. |
api_gateway.requests_latency_millisecondsDGAUGE, milliseconds |
Histogram of response latency distribution (time between the API gateway receiving the first request byte and sending the last response byte).bin label: Latency histogram buckets in milliseconds. |
api_gateway.requests_latency_milliseconds_countDGAUGE, requests |
Total number of requests for which latency was measured. |
api_gateway.requests_latency_milliseconds_sumDGAUGE, milliseconds |
Overall latency |
WebSocket metrics
| Metric name Type, unit |
Description Labels |
|---|---|
api_gateway.websocket_connections_countDGAUGE, number |
Number of active WebSocket connections |
api_gateway.websocket_disconnections_count_per_secondDGAUGE, number/s |
Number of broken WebSocket connections per second.code label: Response code, e.g., 200, 404, 502. |
api_gateway.websocket_messages_bytes_per_secondDGAUGE, bytes/s |
Amount of data sent through WebSocket connections in bytes per second. Labels:
|
api_gateway.websocket_messages_count_per_secondDGAUGE, number/s |
Number of messages sent through WebSocket connections per second. Labels:
|