X-Ray tracing disabled for a Serverless Framework REST API

Enable X-Ray tracing when a REST API needs distributed call analysis.

Description

provider.tracing.apiGateway controls X-Ray tracing for REST APIs created by Serverless Framework. Disabling tracing prevents collection of sampled request paths and latency from that API.

Potential impact

Locating errors or performance problems across service calls can become harder.

Remediation

Set provider.tracing.apiGateway: true and configure the required Lambda and backend instrumentation. Sampled traces do not replace access logs for every request.

Examples

If an external REST API is imported through provider.apiGateway.restApiId, configure tracing on that API’s stage separately instead.

Before

yaml
provider:
  name: aws
  tracing:
    apiGateway: false

After

yaml
provider:
  name: aws
  tracing:
    apiGateway: true

References