Once you’ve integrated with AWS CloudWatch, you have access to metrics from AWS API Gateway, which is is an AWS service for developing REST, HTTP, and WebSocket APIs at any size, as well as publishing, maintaining, monitoring, and protecting them.
See all AWS integrations.
To verify metrics are reporting, search for the metrics on the Metric details page in Settings.
The following table shows the API Gateway metrics ingested by Cloud Observability.
| Metric Name | Unit | Description |
|---|---|---|
| aws.api_gateway.4xx_error | count | The total number of client-side errors recorded over a specific time frame. This metric, which is the total count of the 4XX errors throughout the specified period, is represented by the Sum statistic. The 4XX error rate, or the sum of all 4XX errors divided by all requests made during the period, is represented by the Average statistic. The Count metric is represented by the denominator (below). |
| aws.api_gateway.5xx_error | count | The total number of server-side faults recorded over a specific time frame. This metric, which is the total count of the 5XX errors over the specified period, is represented by the Sum statistic. The 5XX error rate, or the sum of all 5XX errors divided by all requests made during the period, is represented by the Average statistic. The Count metric is represented by the denominator (below). |
| aws.api_gateway.cache_hit_count | count | The volume of queries handled by the API cache over time. This measurement, which is the total count of cache hits over the specified time period, is represented by the Sum statistic. The Average statistic shows the cache hit rate, which is calculated by dividing the total count of cache hits by the total number of requests made during the time. The Count metric is represented by the denominator (below). |
| aws.api_gateway.cache_miss_count | count | The volume of backend requests that are processed over time when API caching is enabled. This measure, which is the total count of cache misses over the specified time frame, is represented by the Sum statistic. The Average statistic, or the total number of cache misses divided by the total number of requests made during the period, reflects the cache miss rate. The Count metric is represented by the denominator (below). |
| aws.api_gateway.count | count | A period's total number of API queries. This metric is represented by the SampleCount statistic. |
| aws.api_gateway.integration_latency | millisecond | The interval in which API Gateway waits for the backend to respond after relaying a request to it. |
| aws.api_gateway.latency | millisecond | The interval in which an API Gateway receives a request from a client and responds to that request. The latency includes API Gateway overhead and integration lag. |
See also
Updated Dec 2, 2022