Project: SkyWalking (Observability and Analysis / Observability)
File: backend-aws-api-gateway-monitoring.md

Amazon API Gateway is an AWS service for creating, publishing, maintaining, monitoring, and securing REST, HTTP, and WebSocket APIs. SkyWalking leverages to transfer the CloudWatch metrics of API Gateway(HTTP and REST APIs) to and into the . AWS CloudWatch collect metrics for API Gateway(REST and HTTP APIs), refer to and stream CloudWatch metrics of API Gateway to AWS Kinesis Data Firehose AWS Kinesis Data Firehose delivery metrics to through the HTTP endpoint Enable CloudWatch metrics for API Gateway Create an Amazon Kinesis Data Firehose Delivery Stream, and set 's address as HTTP(s) Destination, refer to Create CloudWatch metric stream, and select the Firehose Delivery Stream which has been created above, set `Select namespaces` to `AWS/ApiGateway`, `Select output format` to `OpenTelemetry 0.7`. refer to SkyWalking observes CloudWatch metrics of the AWS API Gateway, which is cataloged as a `LAYER: AWSGATEWAY` `Service` in the OAP. Meanwhile, the routes would be recognized as `LAYER: AWSGATEWAY` `endpoint`s | Monitoring Panel | Unit | Metric Name | Catalog | Description | Data Source | |-|-||||--| | Request Count | count | awsgatewayservice_count | Service | The total number API requests in a given period. | and | | 4xx Count | count | awsgatewayservice_4xx | Service | The number of client-side errors captured in a given period. | and | | 5xx Count | count | awsgatewayservice_5xx | Service | The number of server-side errors captured in a given period. | and | | Request Average Latency | ms | awsgatewayservice_latency | Service | The time between when API Gateway receives a request from a client and when it returns a response to the

| and | | Request Average Integration Latency | ms | awsgatewayserviceintegrationlatency | Service | The time between when API Gateway relays a request to the backend and when it receives a response from the backend. | and | | Data Processed | KB | awsgatewayservicedataprocessed | Service | The amount of data processed | | | Cache Hit Count Rate | % | awsgatewayservicecachehit_rate | Service | The number of requests served from the API cache | | | Cache Miss Count Rate | % | awsgatewayservicecachemiss_rate | Service | The number of requests served from the backend | | | Request Count | count | awsgatewayendpoint_count | Endpoint | The total number API requests in a given period. | and | | 4xx Count | count | awsgatewayendpoint_4xx | Endpoint | The number of client-side errors captured in a given period. | and | | 5xx Count | count | awsgatewayendpoint_5xx | Endpoint | The number of server-side errors captured in a given period. | and | | Request Average Latency | ms | awsgatewayendpoint_latency | Endpoint | The time between when API Gateway receives a request from a client and when it returns a response to the client. | and | | Request Average Integration Latency | ms | awsgatewayendpointintegrationlatency | Endpoint | The time between when API Gateway relays a request to the backend and when it receives a response from the backend. | and | | Data Processed | KB | awsgatewayendpointdataprocessed | Endpoint | The amount of data processed | | | Cache Hit Count Rate | % | awsgatewayendpointcachehit_rate | Endpoint | The number of requests served from the API cache | | | Cache Miss Count Rate | % | awsgatewayendpointcachemiss_rate | Endpoint | The number of requests served from the backend | | You can customize your own metrics/expression/dashboard panel. The metrics definition and expression rules are found in `/config/otel-rules/aws-gateway/`. The AWS Cloud EKS dashboard panel configurations are found in `/config/ui-initialized-templates/aws_gateway`.