Amazon API Gateway is an AWS service for creating, publishing, maintaining, monitoring, and securing REST, HTTP, and WebSocket APIs at any scale.
APIs can be created that access AWS, other web services, and data stored in the AWS Cloud. You can:
- Create APIs for use in your own client applications (apps).
- Make your APIs available to third-party app developers.
Use the AWS public cloud integration to discover and collect metrics against the AWS service.
External reference
Setup
To set up the AWS integration and discover the AWS service, go to AWS Integration Discovery Profile and select API Gateway.
Event support
CloudTrail event support
- Not Supported
CloudWatch alarm support
- Supported
- Configurable in OpsRamp AWS Integration Discovery Profile.
Supported metrics
| OpsRamp Metric | Metric Display Name | Unit | Aggregation Type |
|---|---|---|---|
| aws_apigateway_4XXError Number of client-side errors captured. | 4XXError | Count | Average |
| aws_apigateway_5XXError Number of server-side errors captured. | 5XXError | Count | Average |
| aws_apigateway_CacheHitCount Number of requests served from the API cache. | CacheHitCount | Count | Average |
| aws_apigateway_CacheMissCount Number of requests served from the back end when API caching is enabled. | CacheMissCount | Count | Average |
| aws_apigateway_Count Number of calls to API methods. | Count | Count | Average |
| aws_apigateway_IntegrationLatency Time between when the API gateway relays a request to the back end and when it receives a response from the back end. | IntegrationLatency | Millisecond | Average |
| aws_apigateway_Latency Time between when the API gateway receives a request from a client and when it returns a response to the client. | Latency | Millisecond | Average |