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.

Setup

Installation

If you haven’t already, first set up the AWS CloudWatch integration. No additional steps are needed for installation.

Configuration

On the AWS CloudWatch integration page, ensure that the API Gateway service is selected for metric collection.

Metrics

Name Description
4XXError
(count)
The number of client-side errors captured.
5XXError
(count)
The number of server-side errors captured.
CacheHitCount
(count)
The number of requests served from the API cache.
CacheMissCount
(count)
The number of requests served from the back end
when API caching is enabled.
Count
(count)
The number of calls to API methods.
IntegrationLatency
(millisecond)
The time between when API Gateway relays a request to the back end
end and when it receives a response from the back end.
Latency
(millisecond)
The time between when API Gateway receives a request from a client
client and when it returns a response to the client. The latency
includes the integration latency and other API Gateway overhead.

Available Tags

Name Description
awsaccount AWS account associated with the metrics
apiname Name of the API
method Name of the method
resource Name of the resource
stage Name of the stage