Amazon API Gateway
Overview
The Amazon API Gateway integration with ObserveOps (formerly known as AIOps) collects operational telemetry from AWS API Gateway APIs. It monitors request counts, latency, error rates, data transfer, and connection metrics across HTTP APIs, REST APIs, and WebSocket APIs.
These metrics help administrators track API performance, identify error spikes, monitor data transfer volumes, and maintain visibility over API availability and responsiveness.
Prerequisites
- The AWS account has API Gateway APIs deployed.
- The IAM role or user used for integration has the
AmazonAPIGatewayAdministratoror equivalent read-only policy attached. - Required AWS API endpoints are reachable from ObserveOps.
- The AWS account is added in discovery with correct credentials and region configuration.
List of Supported KPIs
HTTP API
| Metric | Description | Type |
|---|---|---|
| aws.http.api.gateway | Identifier of the HTTP API Gateway. | String |
| aws.http.api.gateway.state | Current deployment state of the HTTP API Gateway. | String |
| aws.http.api.gateway.requests | Total number of requests received by the HTTP API. | Count |
| aws.http.api.gateway.latency.ms | Average end-to-end latency of requests to the HTTP API in milliseconds. | ms |
| aws.http.api.gateway.integration.latency.ms | Average latency of the backend integration for the HTTP API in milliseconds. | ms |
| aws.http.api.gateway.4xx.errors | Total number of 4xx client-side errors returned by the HTTP API. | Count |
| aws.http.api.gateway.5xx.errors | Total number of 5xx server-side errors returned by the HTTP API. | Count |
| aws.http.api.gateway.data.processed.bytes | Total bytes of data processed by the HTTP API. | Bytes |
REST API
| Metric | Description | Type |
|---|---|---|
| aws.rest.api.gateway | Identifier of the REST API Gateway. | String |
| aws.rest.api.gateway.state | Current deployment state of the REST API Gateway. | String |
| aws.rest.api.gateway.requests | Total number of requests received by the REST API. | Count |
| aws.rest.api.gateway.latency.ms | Average end-to-end latency of requests to the REST API in milliseconds. | ms |
| aws.rest.api.gateway.integration.latency.ms | Average latency of the backend integration for the REST API in milliseconds. | ms |
| aws.rest.api.gateway.4xx.errors | Total number of 4xx client-side errors returned by the REST API. | Count |
| aws.rest.api.gateway.5xx.errors | Total number of 5xx server-side errors returned by the REST API. | Count |
| aws.rest.api.gateway.data.processed.bytes | Total bytes of data processed by the REST API. | Bytes |
| aws.rest.api.gateway.cache.hit | Number of requests served from the API Gateway cache. | Count |
| aws.rest.api.gateway.cache.miss | Number of requests that bypassed the API Gateway cache. | Count |
WebSocket API
| Metric | Description | Type |
|---|---|---|
| aws.websocket.api.gateway | Identifier of the WebSocket API Gateway. | String |
| aws.websocket.api.gateway.state | Current deployment state of the WebSocket API Gateway. | String |
| aws.websocket.api.gateway.messages.sent | Total number of messages sent from the WebSocket API to connected clients. | Count |
| aws.websocket.api.gateway.messages.received | Total number of messages received by the WebSocket API from clients. | Count |
| aws.websocket.api.gateway.connections | Total number of active WebSocket connections. | Count |
| aws.websocket.api.gateway.client.errors | Total number of client-side errors on the WebSocket API. | Count |
| aws.websocket.api.gateway.execution.errors | Total number of execution errors on the WebSocket API. | Count |
| aws.websocket.api.gateway.integration.errors | Total number of integration errors on the WebSocket API. | Count |
| aws.websocket.api.gateway.integration.latency.ms | Average latency of backend integration calls on the WebSocket API in milliseconds. | ms |
| aws.websocket.api.gateway.data.processed.bytes | Total bytes of data processed by the WebSocket API. | Bytes |