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.
Resource Information:
- Type of Resource: Generic monitorable resource
- Discovery type: AWS SDK discovery type
- Discovery profile selection: Resource can be discovered by “API Gateway” in the profiler
- ResourceTag: API_GATEWAY
- Resource Unique Identification: APIId (api.id())
- Dependencies: API Gateway may integrate with Lambda functions, EC2 instances, and other backend services
Use the AWS public cloud integration to discover and collect metrics against the AWS service.
Note
Only REST API Gateways can be discovered through the OpsRamp AWS integration.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 | AWS Metric | Metric Display Name | Unit | Aggregation Type | Description |
|---|---|---|---|---|---|
| aws_apigateway_4XXError | 4XXError | 4XXError | Count | AVERAGE | The number of client-side errors captured |
| aws_apigateway_5XXError | 5XXError | 5XXError | Count | AVERAGE | The number of server-side errors captured. |
| aws_apigateway_CacheHitCount | CacheHitCount | CacheHitCount | Count | AVERAGE | The number of requests served from the API cache. |
| aws_apigateway_CacheMissCount | CacheMissCount | CacheMissCount | Count | AVERAGE | The number of requests served from the back end when API caching is enabled. |
| aws_apigateway_Count | Count | Count | Count | AVERAGE | The number of calls to API methods. |
| aws_apigateway_IntegrationLatency | IntegrationLatency | IntegrationLatency | Millisecond | AVERAGE | The time between when API Gateway relays a request to the back end and when it receives a response from the back end. |
| aws_apigateway_Latency | Latency | Latency | Millisecond | AVERAGE | The time between when API Gateway receives a request from a client and when it returns a response to the client. |