[Feature Request] Add support for X-Ray on SAM Local

[hugoprudente]

Hi Team,

When trying to use the AWS SAM Local with Node.js per example it fails with the following error:

 Error: Missing AWS Lambda trace data for X-Ray. Expected _X_AMZN_TRACE_ID to be set.

This happens as the X-Ray Lambda already have the traces as per documentation: http://docs.aws.amazon.com/xray/latest/devguide/xray-services-lambda.html

So when using SAM Local this Trace Header is a missing.

[PaulMaddox]

Thanks for opening this.

I believe the steps we need to take to add this to SAM Local are:

1. Check if Tracing: Active is set in the SAM template for the function being invoked
2. If so, run the AWS X-Ray daemon as a sidecar container in invoke.go
3. Set the correct environment variables (e.g. _X_AMZN_TRACE_ID) in env.go

[svenemtell]

It would be nice to use X-Ray from lambdas run using AWS SAM Local BUT more important to me would be a way to silently discard X-Ray calls in the code.
I want to be able to use the same code in production as when testing using AWS SAM Local and for that to work now I have written something like this (which I don't want to do):

if (process.env.AWS_SAM_LOCAL) {
AWS = require('aws-sdk');
} else {
// Only run AWS X-Ray when NOT running AWS SAM Local
AWSXRay = require('aws-xray-sdk-core');
AWS = AWSXRay.captureAWS(require('aws-sdk'));
}

[rvypandey]

+1

This will be a very valuable tool for us!

[Willis0826]

Could we using sam local with X-Ray now?

[metaskills]

It appears not yet. I've been using the process.env check above as mentioned till then. Not a big issue for me either way.

[jabalsad]

The primary use-case I have for enabling x-ray integration is really just so that I don't have to have different configuration in my local dev environment vs my production environment. I'd like to be able to have my code enable x-ray, and the SAM local simulation not dying or raising errors on me. I'm less opinionated about whether the requests actually get submitted to the x-ray service upstream, and care more about just being able to emulate it locally.

{"level":"info","ts":"2020-01-30T01:52:08.225Z","msg":"Starting MyService HTTP server..."}
START RequestId: a4e6c4c6-1e57-1961-65c4-d482d910f26a Version: $LATEST
{"level":"debug","ts":"2020-01-30T01:52:08.237Z","msg":"Created new Resource: {\"id\":\"4KML2o7ZZXR\",\"field\":\"111122223333\",\"name\":\"integrationtestconfig\",\"destinationArn\":\"arn:aws:s3:::some-bucket\"}"}
2020-01-30T01:52:08Z [Error] Suppressing AWS X-Ray context missing panic: failed to begin subsegment named 'dynamodb': segment cannot be found.
END RequestId: a4e6c4c6-1e57-1961-65c4-d482d910f26a
REPORT RequestId: a4e6c4c6-1e57-1961-65c4-d482d910f26a	Init Duration: 159.52 ms	Duration: 6.39 ms	Billed Duration: 100 ms	Memory Size: 128 MB	Max Memory Used: 27 MB
Invalid API Gateway Response Keys:
[snip snip]

[destinybonavita]

Any update on this?

[jfuss]

We are not looking to support X-Ray locally at this time.

Closing.

[hugoprudente]

Not planing to have the feature and closing it instead moving it to a backlog to see how the priority should grow it's not the best way to handle the issue.

You are simply saying here that the community feedback and customers using the aws-sam-cli doesn't matter.