Serverless framework - Enabling X-Ray in serverless.yml

Question

Is there a way to enable X-Ray from the serverless.yml for Lambda functions? I've added the X-Ray permissions in the file:

  iamRoleStatements:
    - Effect: "Allow"
      Resource: "*"
      Action:
        - "xray:*"

But Advanced Tracing still needs to be manually enabled in the AWS console.

score 12 · Answer 1 · answered May 14 '19 at 11:31

12

See the serverless documentation:

service: myService

provider:
  name: aws
  runtime: nodejs8.10
  tracing:
    lambda: true

# serverless.yml

provider:
  name: aws
  tracing:
    apiGateway: true

answered May 14 '19 at 11:31

Ulad Kasach

Does the apiGateway option only work if the API gateway is created by the serverless framework? I am trying this and the lambda option works ok, but the API gateway option doesnt work, I build my api gateway with terraform. My stage is created by serverless, so I figured it would work. – berimbolo Nov 26 '20 at 16:19

score 3 · Accepted Answer · answered Oct 24 '17 at 22:40

3

It's in development. If you're unwilling to wait until the official functionality is released, you can install the plugin until it's ready.

answered Oct 24 '17 at 22:40

Trent Bartlem

1

this plugin hasn't been updated for a year and still in beta mode. Does serverless framework support AWS XRay tracing now or this plugin is the only option? – mandar.gokhale Oct 09 '18 at 19:02
1

it's already released, check serverless AWS document here https://serverless.com/framework/docs/providers/aws/guide/serverless.yml/ – ilumin May 06 '19 at 14:37

score 0 · Answer 3 · answered Jun 05 '23 at 14:27

It is also worth noting that currently X-Ray support is dependent on which type of Aws API is selected. If you chose REST (which by your syntax you did ) X-Ray is supported BUT if someone chooses HTTP it is NOT supported. For reference see https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vs-rest.html#http-api-vs-rest.differences.monitoring

3 Answers3