AWS Integration - API Gateway

Mackerel supports obtaining and monitoring Amazon API Gateway metrics in AWS Integration. When integrating with AWS Integration, billable targets are determined using the conversion 1 API = 1 Micro Host.

Please refer to the following page for AWS Integration configuration methods and a list of supported AWS services.
AWS Integration

Obtaining metrics

The metrics obtainable with AWS Integration's API Gateway support are as follows. For Metric explanations, refer to the AWS help pages.

REST

The maximum number of metrics obtainable is 11.

Graph name Metric Metric name in Mackerel Unit Statistics
Requests Count apigateway.requests.count integer Sum
Errors 4XXError
5XXError
apigateway.errors.4xx_error
apigateway.errors.5xx_error
integer Sum
Cache CacheHitCount
CacheMissCount
apigateway.cache.cache_hit_count
apigateway.cache.cache_miss_count
integer Sum
Latency Latency
IntegrationLatency
apigateway.latency.#.minimum
apigateway.latency.#.average
apigateway.latency.#.maximum
float Minimum
Average
Maximum
  • Either "Latency" or "IntegrationLatency" goes in for the # of "Metric name in Mackerel".

WebSocket

The maximum number of metrics obtainable is 8.

Graph name Metric Metric name in Mackerel Unit Statistics
WebSocket Connect ConnectCount apigateway.websocket_connect.count integer Sum
WebSocket Message MessageCount apigateway.websocket_message.count integer Sum
WebSocket Errors IntegrationError
ClientError
ExecutionError
apigateway.websocket_errors.integration
apigateway.websocket_errors.client
apigateway.websocket_errors.execution
integer Sum
WebSocket Latency IntegrationLatency apigateway.websocket_latency.minimum
apigateway.websocket_latency.average
apigateway.websocket_latency.maximum
float Minimum
Average
Maximum

HTTP

The maximum number of metrics obtainable is 10.

Graph name Metric Metric name in Mackerel Unit Statistics
Requests Count apigateway.requests.count integer Sum
Data Processed DataProcessed apigateway.data_processed bytes Sum
Errors 4xx
5xx
apigateway.http_errors.4xx_error
apigateway.http_errors.5xx_error
integer Sum
Latency Latency
IntegrationLatency
apigateway.latency.#.minimum
apigateway.latency.#.average
apigateway.latency.#.maximum
float Minimum
Average
Maximum
  • Either "Latency" or "IntegrationLatency" goes in for the # of "Metric name in Mackerel".

Notes

If the REST API contains any non-ASCII characters in the API name, the non-ASCII characters will be replaced with a "-" (hyphen) in CloudWatch.
If the replaced name matches that of another REST API, retrieved metrics will get mixed up.

This is a specification of AWS.