Amazon Lambda and Amazon X-Ray - Amazon X-Ray
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Amazon Lambda and Amazon X-Ray

You can use Amazon X-Ray to trace your Amazon Lambda functions. Lambda runs the X-Ray daemon and records a segment with details about invoking and running the function. For further instrumentation, you can bundle the X-Ray SDK with your function to record outgoing calls and add annotations and metadata.

If your Lambda function is called by another instrumented service, Lambda traces requests that have already been sampled without any additional configuration. The upstream service can be an instrumented web application or another Lambda function. Your service can invoke the function directly with an instrumented Amazon SDK client, or by calling an API Gateway API with an instrumented HTTP client.

Amazon X-Ray supports tracing event-driven applications using Amazon Lambda and Amazon SQS. Use the CloudWatch console to see a connected view of each request as it's queued with Amazon SQS and processed by a downstream Lambda function. Traces from upstream message producers are automatically linked to traces from downstream Lambda consumer nodes, creating an end-to-end view of the application. For more information, see tracing event-driven applications.

Note

If you have traces enabled for a downstream Lambda function, you must also have traces enabled for the root Lambda function that calls the downstream function in order for the downstream function to generate traces.

If your Lambda function runs on a schedule, or is invoked by a service that is not instrumented, you can configure Lambda to sample and record invocations with active tracing.

To configure X-Ray integration on an Amazon Lambda function

  1. Open the Amazon Lambda console.

  2. Select Functions from the left navigation bar.

  3. Choose your function.

  4. On the Configuration tab, scroll down to the Additional monitoring tools card. You can also find this card by selecting Monitoring and operations tools on the left navigation pane.

  5. Select Edit.

  6. Under Amazon X-Ray, enable Active tracing.

On runtimes with a corresponding X-Ray SDK, Lambda also runs the X-Ray daemon.

X-Ray SDKs on Lambda

  • X-Ray SDK for Go – Go 1.7 and newer runtimes

  • X-Ray SDK for Java – Java 8 runtime

  • X-Ray SDK for Node.js – Node.js 4.3 and newer runtimes

  • X-Ray SDK for Python – Python 2.7, Python 3.6, and newer runtimes

  • X-Ray SDK for .NET – .NET Core 2.0 and newer runtimes

To use the X-Ray SDK on Lambda, bundle it with your function code each time you create a new version. You can instrument your Lambda functions with the same methods that you use to instrument applications running on other services. The primary difference is that you don't use the SDK to instrument incoming requests, make sampling decisions, and create segments.

The other difference between instrumenting Lambda functions and web applications is that the segment that Lambda creates and sends to X-Ray can't be modified by your function code. You can create subsegments and record annotations and metadata on them, but you can't add annotations and metadata to the parent segment.

For more information, see Using Amazon X-Ray in the Amazon Lambda Developer Guide.