Introduction
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.
Note
Use the OpsRamp AWS public cloud integration to discover and collect metrics against the AWS service.Setup
To set up the OpsRamp AWS integration and discover the AWS service,
go to AWS Integration Discovery Profile and select API Gateway.
Metrics
| OpsRamp Metric | Metric Display Name | Unit | Aggregation Type | Description |
|---|---|---|---|---|
| aws_apigateway_4XXError | 4XXError | Count | AVERAGE | Number of client-side errors captured. |
| aws_apigateway_5XXError | 5XXError | Count | AVERAGE | Number of server-side errors captured. |
| aws_apigateway_CacheHitCount | CacheHitCount | Count | AVERAGE | Number of requests served from the API cache. |
| aws_apigateway_CacheMissCount | CacheMissCount | Count | AVERAGE | Number of requests served from the back end when API caching is enabled. |
| aws_apigateway_Count | Count | Count | AVERAGE | Number of calls to API methods. |
| aws_apigateway_IntegrationLatency | IntegrationLatency | Millisecond | AVERAGE | Time between when the API gateway relays a request to the back end and when it receives a response from the back end. |
| aws_apigateway_Latency | Latency | Millisecond | AVERAGE | Time between when the API gateway receives a request from a client and when it returns a response to the client. |
Event support
CloudTrail event support
- Not Supported
CloudWatch alarm support
- Supported
- Configurable in OpsRamp AWS Integration Discovery Profile.