Ensure that active tracing is enabled for your Amazon API Gateway API stages to sample incoming requests and send traces to AWS X-Ray. Once this feature is enabled, X-Ray service will trace and analyze user requests as these travel through your AWS API Gateway APIs to the underlying services.
This rule can help you with the following compliance standards:
This rule can help you work with the AWS Well-Architected Framework
This rule resolution is part of the Cloud Conformity Security & Compliance tool for AWS
When an API Gateway API stage has active tracing feature enabled, Amazon API Gateway service automatically samples API invocation requests based on the sampling algorithm specified by AWS X-Ray. Then X-Ray can provide you an end-to-end view of an entire HTTP request, so you can analyze latencies in your APIs and their backend services.
Note: API Gateway supports active tracing for all API Gateway endpoint types, i.e. regional, private and edge-optimized. You can enable active tracing for your APIs in all AWS regions where X-Ray service is available.
To determine if your API Gateway API stages have active tracing feature enabled, perform the following actions:
To enable X-Ray tracing (also known as active tracing) for your Amazon API Gateway API stages, perform the following: