AWS API Gateway¶
Overview¶
Amazon API Gateway is a fully managed service that makes it easy for developers to create, publish, maintain, monitor, and secure APIs at any scale.
Enable collection API Gateway logs and metrics in cloudaeye to monitor and analysis of the time-series data using state-of-the-art machine learning technologies for monitoring and anomaly detection in distributed cloud application.
Prerequisites¶
- User must setup a logs service for the same application.
- Logs service must be added to a service group.
Account Access¶
This step is optional. We strongly recommend that you allow us to retreive info about your services because it will greatly minimize the chances of making a mistake
Configuration for API Gateway Logs Collection¶
User must select AWS Services field in application creation form and select API Gateway service from AWS Service dropdown.
Provide the cloudwatch log group associated with the Api Gateway
Configuration for API Gateway Metrics Collection¶
User must select AWS Services field in application creation form and select API Gateway service from AWS Service dropdown.
Provide required dimensions and metrics to be collected.
If you have allowed us to retreive service details from your account, the dimensions will shown as a dropdown.
Detailed description of metrics and dimension can be viewed at API Gateway metrics and dimensions
Supported API Gateway Dimensions¶
API Gateway provides below dimensions on which metrics are collected.
| Dimension | Description |
|---|---|
| ApiId | API Id of the Api Gateway |
| Stage | Stage for which metrics has to be collected |
| Resource | Resource for which metrics to be collected |
| Method | Method type for which metrics has to be collected |
Supported API Gateway Metrics¶
API Gateway provides below metrics to be collected.
| Metrics | Description |
|---|---|
| Count | The total number API requests in a given period. |
| Latency | The time between when API Gateway receives a request from a client and when it returns a response to the client. The latency includes the integration latency and other API Gateway overhead. |
| IntegrationLatency | The time between when API Gateway relays a request to the backend and when it receives a response from the backend. |
| CacheMissCount | The number of requests served from the backend in a given period, when API caching is enabled. |
| CacheHitCount | The number of requests served from the API cache in a given period. |
| 5XXError | The number of server-side errors captured in a given period. |
| 4XXError | The number of client-side errors captured in a given period. |