Amazon API Gateway

Amazon API Gateway is an AWS service for creating, publishing, maintaining, monitoring, and securing REST, HTTP, and WebSocket APIs at scale.

You must configure cloud connections to monitor this entity. See Set up Cisco AppDynamics Cloud Collectors to Monitor AWS.

Cisco Cloud Observability displays AWS entities on the Observe page. Metrics are displayed for specific entity instances in the list and detail views.

This document contains references to third-party documentation. Cisco AppDynamics does not own any rights and assumes no responsibility for the accuracy or completeness of such third-party documentation.

Detail View

To display the detail view for an Amazon API Gateway instance:

Navigate to the Observe page.
Under App Integrations, click AWS API Gateways.
The list view now displays.
From the list, click an instance Name to display the detail view.
The detail view displays the metrics, key performance indicators, and properties (attributes) related to the instance you selected.

Metrics and Key Performance Indicators

Cisco Cloud Observability displays the following metrics and key performance indicators (KPIs) for Amazon API Gateway.

For more information, see:

Display Name	Source Metric	Description
HTTP Errors (Count)	`4XXError`	The number of client-side errors captured in a given period. The `Sum` statistic represents this metric, namely, the total count of the 4XXError errors in the given period. The `Average` statistic represents the 4XXError error rate, namely, the total count of the 4XXError errors divided by the total number of requests during the period. The denominator corresponds to the Count metric (below).
HTTP Errors (Count)	`5XXError`	The number of server-side errors captured in a given period. The `Sum` statistic represents this metric, namely, the total count of the 5XXError errors in the given period. The `Average` statistic represents the 5XXError error rate, namely, the total count of the 5XXError errors divided by the total number of requests during the period. The denominator corresponds to the Count metric (below).
Cache Hits (Count)	`CacheHitCount`	The number of requests served from the API cache in a given period. The `Sum` statistic represents this metric, namely, the total count of the cache hits in the given period. The `Average` statistic represents the cache hit rate, namely, the total count of the cache hits divided by the total number of requests during the period. The denominator corresponds to the Count metric (below).
Cache Misses (Count)	`CacheMissCount`	The number of requests served from the backend in a given period, when API caching is enabled. The `Sum` statistic represents this metric, namely, the total count of the cache misses in the given period. The `Average` statistic represents the cache miss rate, namely, the total count of the cache misses divided by the total number of requests during the period. The denominator corresponds to the Count metric (below).
HTTP Requests (Count)	`Count`	The total number API requests in a given period. The `SampleCount` statistic represents this metric.
Latency (ms)	`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.
Integration Latency (ms)	`IntegrationLatency`	The time between when API Gateway relays a request to the backend and when it receives a response from the backend.

Display Name	Source Metric	Description
HTTP Errors (Count)	`4xx`	The number of client-side errors captured in a given period.
HTTP Errors (Count)	`5xx`	The number of server-side errors captured in a given period.
Data Processed (Bytes)	`DataProcessed`	The amount of data processed in bytes.
HTTP Requests (Count)	`Count`	The total number of API requests in a given period.
Latency (ms)	`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.
Integration Latency (ms)	`IntegrationLatency`	The time between when API Gateway relays a request to the backend and when it receives a response from the backend.

Display Name	Source Metric	Description
Connect Count	`ConnectCount`	The number of messages sent to the `$connect` route integration.
Message Count	`MessageCount`	The number of messages sent to the WebSocket API, either from or to the client.
Integration Errors (Count)	`IntegrationError`	The number of requests that return a 4XX/5XX response from the integration.
Client Errors (Count)	`ClientError`	The number of requests that have a 4XX response returned by API Gateway before the integration is invoked.
Execution Errors (Count)	`ExecutionError`	Errors that occurred when calling the integration.
Integration Latency (ms)	`IntegrationLatency`	The time difference between API Gateway sending the request to the integration and API Gateway receiving the response from the integration. Suppressed for callbacks and mock integrations.

Properties (Attributes)

Cisco Cloud Observability displays the following properties for Amazon API Gateway.

Display Name	Property Name	Description
ARN	`aws.arn`	The ARN of the API.
Default Endpoint Disabled	`aws.api.disable_execute_api_endpoint`	Specifies whether clients can invoke your API by using the default `execute-api` endpoint.
Supported Media Types	`aws.rest_api.binary_media_types`	The list of binary media types supported by the REST API.
Minimum Compression Size	`aws.rest_api.minimum_compression_size`	A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API.
API Key Source	`aws.rest_api.api_key_source`	The source of the API key for metering requests according to a usage plan.
Endpoint Configuration	`aws.rest_api.endpoint_configuration_type`	The endpoint configuration of this REST API showing the endpoint types of the API.

Display Name	Property Name	Description
ARN	`aws.arn`	The ARN of the API.
Default Endpoint Disabled	`aws.api.disable_execute_api_endpoint`	Specifies whether clients can invoke your API by using the default `execute-api` endpoint.
API Gateway Managed	`aws.http_api.api_gateway_managed`	Specifies if an API is managed by API Gateway.
API Key Selection Expression	`aws.http_api.key_selection_expression`	An API key selection expression.
Allow Credentials in CORS	`aws.http_api.cors.allow_credentials`	Specifies if credentials are included in the CORS request.
CORS Max Age	`aws.http_api.cors.max_age`	The number of seconds that the browser should cache preflight request results.
Schema Validation Enabled	`aws.http_api.disable_schema_validation`	Specifies if models are validated when creating a deployment.
Route Selection Expression	`aws.http_api.route_selection_expression`	The route selection expression for the API.

Display Name	Property Name	Description
ARN	`aws.arn`	The ARN of the API.
Default Endpoint Disabled	`aws.api.disable_execute_api_endpoint`	Specifies whether clients can invoke your API by using the default `execute-api` endpoint.
API Gateway Managed	`aws.websocket_api.api_gateway_managed`	Specifies whether an API is managed by API Gateway.
API Key Selection Expression	`aws.websocket_api.api_key_selection_expression`	An API key selection expression.
Allow Credentials in CORS	`aws.websocket_api.cors_allow_credentials`	Specifies whether credentials are included in the CORS request.
CORS Max Age	`aws.websocket_api.cors_max_age`	The number of seconds that the browser should cache preflight request results.
Schema Validation Enabled	`aws.websocket_api.disable_schema_validation`	Specifies if models are validated when creating a deployment.
Route Selection Expression	`aws.websocket_api.route_selection_expression`	The route selection expression for the API.

Display Name	Property Name	Description
ID	`aws.api_route.id`	The API route's identifier.
API Key Required	`aws.api_route.api_key_required`	A boolean flag specifying whether a valid ApiKey is required to invoke this method.
Auth Type	`aws.api_route.authorization.type`	The method's authorization type.
Auth ID	`aws.api_route.authorization.id`	The method's authorization id.
Auth Name	`aws.api_route.authorizer.name`	The method's authorizer's name
Auth URI	`aws.api_route.authorizer.uri`	The method's authorization URI.
Route Key	`aws.api_route.key`	The route key for the route.
Integration ID	`aws.api_route.integration.id`	Represents the identifier of an integration.
Integration Type	`aws.api_route.integration.type`	The integration type of an integration.
Integration URI	`aws.api_route.integration.uri`	The URI of the integrated service.
Connection ID	`aws.api_route.connection.id`	The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise
Connection Type	`aws.api_route.connection.type`	The type of the network connection to the integration endpoint.

Display Name	Property Name	Description
Arn	`aws.arn`	ARN of the API environment.
Deployment ID	`aws.api_environment.deployment.id`	The identifier of the deployment that the environment points to.
Deployment Description	`aws.api_environment.deployment.description`	The description of the deployment that the environment points to.
Client Cert	`aws.api_environment.client_certificate.id`	The identifier of a client certificate for an API environment.
Name	`aws.api_environment.name`	The name of the environment is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.
Description	`aws.api_environment.description`	The environment's description.
Cache Cluster Enabled	`aws.api_environment.cache_cluster.enabled`	Specifies whether a cache cluster is enabled for the environment.
Cache Cluster Size	`aws.api_environment.cache_cluster.size`	The environment's cache capacity in GB.
Cache Cluster Status	`aws.api_environment.cache_cluster.status`	The status of the cache cluster for the environment, if enabled.
Created At	`aws.api_environment.created_at`	The timestamp when the environment was created.
Updated At	`aws.api_environment.updated_at`	The timestamp when the environment last updated.
Detailed Metrics Enabled	`aws.api_environment.detailed_metrics_enabled`	Represents whether detailed metrics is enabled for the environment.
Burst Limit	`aws.api_environment.throttling.burst_limit`	The API target request burst rate limit.
Rate Limit	`aws.api_environment.throttling.rate_limit`	The API target request rate limit.

Retention and Purge Time-To-Live (TTL)

For all cloud and infrastructure entities, the retention TTL is 180 minutes (3 hours) and the purge TTL is 525,600 minutes (365 days).

Amazon Web Services, the AWS logo, AWS, and any other AWS Marks used in these materials are trademarks of Amazon.com, Inc. or its affiliates in the United States and/or other countries.