Instrumenting your application for 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.

Instrumenting your application for Amazon X-Ray

Instrumenting your application involves sending trace data for incoming and outbound requests and other events within your application, along with metadata about each request. There are several different instrumentation options you can choose from or combine, based on your particular requirements:

  • Auto instrumentation – instrument your application with zero code changes, typically via configuration changes, adding an auto-instrumentation agent, or other mechanisms.

  • Library instrumentation – make minimal application code changes to add pre-built instrumentation targeting specific libraries or frameworks, such as the Amazon SDK, Apache HTTP clients, or SQL clients.

  • Manual instrumentation – add instrumentation code to your application at each location where you want to send trace information.

There are several SDKs, agents, and tools that can be used to instrument your application for X-Ray tracing.

Instrumenting your application with the Amazon Distro for OpenTelemetry

The Amazon Distro for OpenTelemetry (ADOT) is an Amazon distribution based on the Cloud Native Computing Foundation (CNCF) OpenTelemetry project. OpenTelemetry provides a single set of open source APIs, libraries, and agents to collect distributed traces and metrics. This toolkit is a distribution of upstream OpenTelemetry components including SDKs, auto-instrumentation agents, and collectors that are tested, optimized, secured, and supported by Amazon.

With ADOT, engineers can instrument their applications once and send correlated metrics and traces to multiple Amazon monitoring solutions including Amazon CloudWatch, Amazon X-Ray, and Amazon OpenSearch Service.

Using X-Ray with ADOT requires two components: an OpenTelemetry SDK enabled for use with X-Ray, and the Amazon Distro for OpenTelemetry Collector enabled for use with X-Ray. For more information about using the Amazon Distro for OpenTelemetry with Amazon X-Ray and other Amazon services, see the Amazon Distro for OpenTelemetry Documentation.

For more information about language support and usage, see Amazon Observability on GitHub.

ADOT includes the following:

ADOT currently includes auto-instrumentation support for Java and Python. In addition, ADOT enables auto-instrumentation of Amazon Lambda functions and their downstream requests using Java, Node.js, and Python runtimes, via ADOT Managed Lambda Layers.

ADOT SDKs for Java and Go support X-Ray centralized sampling rules. If you need support for X-Ray sampling rules in other languages, consider using an Amazon X-Ray SDK.

Instrumenting your application with Amazon X-Ray SDKs

Amazon X-Ray includes a set of language-specific SDKs for instrumenting your application to send traces to X-Ray. Each X-Ray SDK provides the following:

  • Interceptors to add to your code to trace incoming HTTP requests

  • Client handlers to instrument Amazon SDK clients that your application uses to call other Amazon services

  • An HTTP client to instrument calls to other internal and external HTTP web services

X-Ray SDKs also support instrumenting calls to SQL databases, automatic Amazon SDK client instrumentation, and other features. Instead of sending trace data directly to X-Ray, the SDK sends JSON segment documents to a daemon process listening for UDP traffic. The X-Ray daemon buffers segments in a queue and uploads them to X-Ray in batches.

The following language-specific SDKs are provided:

X-Ray currently includes auto-instrumentation support for Java.

Choosing between the Amazon Distro for OpenTelemetry and X-Ray SDKs

The SDKs included with X-Ray are part of a tightly integrated instrumentation solution offered by Amazon. The Amazon Distro for OpenTelemetry is part of a broader industry solution in which X-Ray is only one of many tracing solutions. You can implement end-to-end tracing in X-Ray using either approach, but it’s important to understand the differences in order to determine the most useful approach for you.

We recommend instrumenting your application with the Amazon Distro for OpenTelemetry if you need the following:

  • The ability to send traces to multiple different tracing backends without having to re-instrument your code

  • Support for a large number of library instrumentations for each language, maintained by the OpenTelemetry community

We recommend choosing an X-Ray SDK for instrumenting your application if you need the following:

  • A tightly integrated single-vendor solution

  • Integration with X-Ray centralized sampling rules, including the ability to configure sampling rules from the X-Ray console and automatically use them across multiple hosts, when using Node.js, Python, Ruby, or .NET