# AWS X-Ray Developer Guide

> Use AWS X-Ray to monitor the components and services that make up your cloud applications. AWS X-Ray provides a detailed trace map and latency information for each connection that your application makes to AWS services and external web APIs.

- [What is AWS X-Ray?](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.md)
- [Getting started](https://docs.aws.amazon.com/xray/latest/devguide/xray-gettingstarted.md)
- [Concepts](https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.md)
- [Instrumenting your application](https://docs.aws.amazon.com/xray/latest/devguide/xray-instrumenting-your-app.md)
- [Transaction Search](https://docs.aws.amazon.com/xray/latest/devguide/xray-transactionsearch.md)
- [OpenTelemetry Protocol (OTLP) Endpoint](https://docs.aws.amazon.com/xray/latest/devguide/xray-opentelemetry.md)
- [X-Ray SDK and Daemon Support timeline](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-daemon-timeline.md)
- [Creating X-Ray resources with CloudFormation](https://docs.aws.amazon.com/xray/latest/devguide/creating-resources-with-cloudformation.md)
- [Tagging](https://docs.aws.amazon.com/xray/latest/devguide/xray-tagging.md)
- [Troubleshooting](https://docs.aws.amazon.com/xray/latest/devguide/xray-troubleshooting.md)
- [Document History](https://docs.aws.amazon.com/xray/latest/devguide/document-history.md)

## [Choosing an interface](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface.md)

- [Use an SDK](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-sdk.md)

### [Use a console](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-console.md)

Use a console if you want a graphical user interface (GUI) that requires minimal coding.

- [Trace map](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-servicemap.md): View the X-Ray trace map to identify services where errors are occurring, connections with high latency, or traces for requests that were unsuccessful.
- [Traces](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-traces.md): Learn how to view X-Ray traces and trace details in the X-Ray console.
- [Filter expressions](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.md): Use filter expressions to find traces that have performance issues or that relate to specific requests.
- [Cross-account tracing](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-crossaccount.md): Configure and view cross-account tracing in AWS X-Ray.
- [Tracing event-driven applications](https://docs.aws.amazon.com/xray/latest/devguide/xray-tracelinking.md): AWS X-Ray supports tracing event-driven applications using Amazon SQS and AWS Lambda.
- [Histograms](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-histograms.md): Use the trace map in the X-Ray console to view histograms showing an edge for a metric, and zoom in to see individual traces for a specific time period.
- [Insights](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-insights.md): Use AWS X-Ray to identify emergent issues in your applications as they happen.
- [Analytics](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-analytics.md): Use the AWS X-Ray Analytics console to understand and debug request-serving applications.
- [Groups](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-groups.md): Configure and manage groups in AWS X-Ray.
- [Sampling](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-sampling.md): Configure AWS X-Ray to manage sampling rules.
- [Adaptive sampling](https://docs.aws.amazon.com/xray/latest/devguide/xray-adaptive-sampling.md): Configure AWS X-Ray to manage adaptive sampling rules.
- [Console deep linking](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-deeplinks.md): Create deep links to filtered trace maps and trace lists in the AWS X-Ray console.

### [Use the X-Ray API](https://docs.aws.amazon.com/xray/latest/devguide/xray-api.md)

If the X-Ray SDK doesn’t support your programming language, you can use either the X-Ray APIs directly or the AWS Command Line Interface (AWS CLI) to call X-Ray API commands.

- [Tutorial](https://docs.aws.amazon.com/xray/latest/devguide/xray-api-tutorial.md): The AWS CLI lets your access the X-Ray service directly and use the same APIs that the X-Ray console uses to retrieve the service graph and raw traces data.
- [Sending data](https://docs.aws.amazon.com/xray/latest/devguide/xray-api-sendingdata.md): Upload trace data with the AWS X-Ray API.
- [Getting data](https://docs.aws.amazon.com/xray/latest/devguide/xray-api-gettingdata.md): Retrieve service graphs and traces with the AWS X-Ray API.
- [Configuration](https://docs.aws.amazon.com/xray/latest/devguide/xray-api-configuration.md): Configure sampling and encryption settings with the AWS X-Ray API.
- [Sampling](https://docs.aws.amazon.com/xray/latest/devguide/xray-api-sampling.md): Use sampling rules with the AWS X-Ray API.
- [Segment documents](https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.md): Generate segment documents to send tracing information directly to X-Ray without using an SDK.


## [Security](https://docs.aws.amazon.com/xray/latest/devguide/security.md)

- [Data protection](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-encryption.md): Configure X-Ray to use a AWS KMS key for encryption.

### [Identity and access management](https://docs.aws.amazon.com/xray/latest/devguide/security-iam.md)

How to authenticate requests and manage access your X-Ray resources.

- [How AWS X-Ray works with IAM](https://docs.aws.amazon.com/xray/latest/devguide/security_iam_service-with-iam.md): Before you use IAM to manage access to X-Ray, you should understand what IAM features are available to use with X-Ray.
- [Identity-based policy examples](https://docs.aws.amazon.com/xray/latest/devguide/security_iam_id-based-policy-examples.md): By default, users and roles don't have permission to create or modify X-Ray resources.
- [Troubleshooting](https://docs.aws.amazon.com/xray/latest/devguide/security_iam_troubleshoot.md): Use the following information to help you diagnose and fix common issues that you might encounter when working with X-Ray and IAM.
- [Logging and monitoring](https://docs.aws.amazon.com/xray/latest/devguide/security-logging-monitoring.md): Learn about logging and monitoring in AWS X-Ray.
- [Compliance validation](https://docs.aws.amazon.com/xray/latest/devguide/compliance-validation.md): Learn what AWS services are in scope of a specific compliance program.
- [Resilience](https://docs.aws.amazon.com/xray/latest/devguide/disaster-recovery-resiliency.md): Learn how AWS architecture supports data redundancy, and learn about specific AWS X-Ray features for data resiliency.
- [Infrastructure security](https://docs.aws.amazon.com/xray/latest/devguide/infrastructure-security.md): Learn how AWS X-Ray isolates service traffic.
- [VPC endpoints](https://docs.aws.amazon.com/xray/latest/devguide/xray-security-vpc-endpoint.md): Explains how to use AWS X-Ray with VPC endpoints.
- [Cross-service confused deputy prevention](https://docs.aws.amazon.com/xray/latest/devguide/cross-service-confused-deputy-prevention.md): The confused deputy problem is a security issue where an entity that doesn't have permission to perform an action can coerce a more-privileged entity to perform the action.


## [Sample application](https://docs.aws.amazon.com/xray/latest/devguide/xray-scorekeep.md)

- [Scorekeep tutorial](https://docs.aws.amazon.com/xray/latest/devguide/scorekeep-tutorial.md): Learn how to use AWS X-Ray by launching a sample Java application.
- [AWS SDK clients](https://docs.aws.amazon.com/xray/latest/devguide/scorekeep-sdkclients.md)
- [Custom subsegments](https://docs.aws.amazon.com/xray/latest/devguide/scorekeep-subsegments.md)
- [Annotations and metadata](https://docs.aws.amazon.com/xray/latest/devguide/scorekeep-annotations.md)
- [HTTP clients](https://docs.aws.amazon.com/xray/latest/devguide/scorekeep-httpclient.md)
- [SQL clients](https://docs.aws.amazon.com/xray/latest/devguide/scorekeep-postgresql.md)
- [AWS Lambda functions](https://docs.aws.amazon.com/xray/latest/devguide/scorekeep-lambda.md)
- [Instrumenting startup code](https://docs.aws.amazon.com/xray/latest/devguide/scorekeep-startup.md)
- [Instrumenting scripts](https://docs.aws.amazon.com/xray/latest/devguide/scorekeep-scripts.md)
- [Instrumenting web clients](https://docs.aws.amazon.com/xray/latest/devguide/scorekeep-client.md)
- [Worker threads](https://docs.aws.amazon.com/xray/latest/devguide/scorekeep-workerthreads.md)


## [X-Ray daemon](https://docs.aws.amazon.com/xray/latest/devguide/xray-daemon.md)

- [Configuration](https://docs.aws.amazon.com/xray/latest/devguide/xray-daemon-configuration.md): Use command line options or a configuration file to configure the X-Ray daemon.
- [Run the daemon locally](https://docs.aws.amazon.com/xray/latest/devguide/xray-daemon-local.md): Run the X-Ray daemon locally on Linux, MacOS, Windows, or in a Docker container.
- [On Elastic Beanstalk](https://docs.aws.amazon.com/xray/latest/devguide/xray-daemon-beanstalk.md): Use a configuration file to run the X-Ray daemon on your Elastic Beanstalk environment's Amazon EC2 instances.
- [On Amazon EC2](https://docs.aws.amazon.com/xray/latest/devguide/xray-daemon-ec2.md): Use a user data script to run the X-Ray Daemon on your Amazon EC2 instances.
- [On Amazon ECS](https://docs.aws.amazon.com/xray/latest/devguide/xray-daemon-ecs.md): Use a Docker image to run the X-Ray daemon on your Amazon ECS clusters.


## [Integrating with AWS services](https://docs.aws.amazon.com/xray/latest/devguide/xray-services.md)

- [Amazon Bedrock AgentCore](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-agentcore.md): Use AWS X-Ray to view end-to-end requests when using Amazon Bedrock AgentCore events.
- [Amazon EC2](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-ec2.md): Use an Amazon EC2 user data script to run the AWS X-Ray daemon on your application instances.
- [Amazon SNS](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-sns.md): Use AWS X-Ray to trace messages sent they travel through your Amazon SNS topics.
- [Amazon SQS](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-sqs.md): Enable AWS X-Ray to trace messages passed through Amazon SQS batches.
- [Amazon S3](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-s3.md): Use AWS X-Ray to view end-to-end requests when using Amazon S3 events.
- [AWS Distro for OpenTelemetry](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-adot.md): Collect metrics and traces using the AWS Distro for OpenTelemetry to send to X-Ray and other monitoring solutions.
- [AWS Config](https://docs.aws.amazon.com/xray/latest/devguide/xray-api-config.md): Integrate with AWS Config to record configuration changes made to the X-Ray encryption resource.
- [AWS AppSync](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-appsync.md): Enable active tracing and sampling for AWS AppSync requests.
- [API Gateway](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-apigateway.md): Use Amazon API Gateway to sample and record incoming requests.
- [App Mesh](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-appmesh.md): Use an Amazon EC2 user data script to run the AWS X-Ray daemon on your application instances.
- [App Runner](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-app-runner.md): Enable tracing for containerized applications with App Runner and X-Ray.
- [CloudTrail](https://docs.aws.amazon.com/xray/latest/devguide/xray-api-cloudtrail.md): Learn about logging AWS X-Ray with AWS CloudTrail.

### [CloudWatch](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-cloudwatch.md)

Integrate Amazon CloudWatch with X-Ray

- [CloudWatch RUM](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-RUM.md): Use CloudWatch RUM to trace user sessions with AWS X-Ray.
- [CloudWatch Synthetics](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-cloudwatch-synthetics.md): Debug and triage Amazon CloudWatch Synthetics canaries using AWS X-Ray
- [Elastic Beanstalk](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-beanstalk.md): Use AWS Elastic Beanstalk to run the AWS X-Ray daemon on your application instances.
- [Elastic Load Balancing](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-elb.md): Use Elastic Load Balancing to tag incoming requests for use with AWS X-Ray.
- [EventBridge](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-eventbridge.md): Enable AWS X-Ray to trace events passed through EventBridge.
- [Lambda](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-lambda.md): Use X-Ray to trace AWS Lambda functions.
- [Step Functions](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-stepfunctions.md): Use AWS X-Ray to trace and analyze requests for Step Functions.


## [Working with Go](https://docs.aws.amazon.com/xray/latest/devguide/xray-go.md)

- [AWS Distro for OpenTelemetry Go](https://docs.aws.amazon.com/xray/latest/devguide/xray-go-opentel-sdk.md): Use the AWS Distro for OpenTelemetry to instrument Go applications.

### [X-Ray SDK for Go](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-go.md)

Use the X-Ray SDK for Go to instrument Go applications.

- [Configuration](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-go-configuration.md): Configure the X-Ray SDK for Go module with service plugins, sampling rules, and log settings.
- [Incoming requests](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-go-handler.md): Use xray.Handler in your application with the X-Ray SDK for Go to trace incoming requests.
- [AWS SDK clients](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-go-awssdkclients.md): Instrument AWS SDK clients with the X-Ray SDK for Go to trace downstream calls to AWS services and resources.
- [Outgoing HTTP calls](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-go-httpclients.md): Instrument HTTP clients with the X-Ray SDK for Go to trace calls to downstream web APIs.
- [SQL queries](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-go-sqlclients.md): Instrument PostgreSQL and MySQL database connections with the X-Ray SDK for Go to trace SQL queries.
- [Custom subsegments](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-go-subsegments.md): Create additional subsegments with the X-Ray SDK for Go to trace functions or sections of code.
- [Annotations and metadata](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-go-segment.md): Add annotations and metadata to segments that the X-Ray SDK for Go records for your application.


## [Working with Java](https://docs.aws.amazon.com/xray/latest/devguide/xray-java.md)

- [AWS Distro for OpenTelemetry Java](https://docs.aws.amazon.com/xray/latest/devguide/xray-java-opentel-sdk.md): Use the AWS Distro for OpenTelemetry to instrument Java applications.

### [X-Ray SDK for Java](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-java.md)

Use the X-Ray SDK for Java to instrument Java applications.

- [Auto-instrumentation agent](https://docs.aws.amazon.com/xray/latest/devguide/aws-x-ray-auto-instrumentation-agent-for-java.md): Use the AWS X-Ray auto-instrumentation agent for Java.
- [Configuration](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-java-configuration.md): Configure the X-Ray SDK for Java module with service plugins, sampling rules, and log settings.
- [Incoming requests](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-java-filters.md): Add a filter to your application with the X-Ray SDK for Java to trace incoming requests.
- [AWS SDK clients](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-java-awssdkclients.md): Instrument AWS SDK for Java clients with the X-Ray SDK for Java to trace downstream calls to AWS services and resources.
- [Outgoing HTTP calls](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-java-httpclients.md): Instrument HTTP clients with the X-Ray SDK for Java to trace calls to downstream web APIs.
- [SQL queries](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-java-sqlclients.md): Instrument PostgreSQL and MySQL database connections with the X-Ray SDK for Java to trace SQL queries.
- [Custom subsegments](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-java-subsegments.md): Create additional subsegments with the X-Ray SDK for Java to trace functions or sections of code.
- [Annotations and metadata](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-java-segment.md): Add annotations and metadata to segments that the X-Ray SDK for Java records for your application.
- [Multithreading](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-java-multithreading.md): Considerations for instrumenting multithreaded applications with AWS X-Ray.
- [AOP with Spring](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-java-aop-spring.md): Instrument your application with AOP in Spring and the X-Ray SDK for Java.


## [Working with Node.js](https://docs.aws.amazon.com/xray/latest/devguide/xray-nodejs.md)

- [AWS Distro for OpenTelemetry JavaScript](https://docs.aws.amazon.com/xray/latest/devguide/xray-js-opentel-sdk.md): Use the AWS Distro for OpenTelemetry to instrument JavaScript applications.

### [X-Ray SDK for Node.js](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-nodejs.md)

Instrument your Node.js application with the X-Ray SDK for Node.js to trace incoming requests and the downstream calls that your application makes in response.

- [Configuration](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-nodejs-configuration.md): Configure the X-Ray SDK for Node.js module with service plugins and sampling rules.
- [Incoming requests](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-nodejs-middleware.md): Add middleware to your application with the X-Ray SDK for Node.js to trace incoming requests.
- [AWS SDK clients](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-nodejs-awssdkclients.md): Instrument AWS SDK for JavaScript in Node.js clients with the X-Ray SDK for Node.js to trace downstream calls to AWS services and resources.
- [Outgoing HTTP calls](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-nodejs-httpclients.md): Instrument HTTP clients with the X-Ray SDK for Node.js to trace calls to downstream web APIs.
- [SQL queries](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-nodejs-sqlclients.md): Instrument PostgreSQL and MySQL database connections with the X-Ray SDK for Node.js to trace SQL queries.
- [Custom subsegments](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-nodejs-subsegments.md): Create additional subsegments with the X-Ray SDK for Node.js to trace functions or sections of code.
- [Annotations and metadata](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-nodejs-segment.md): Add annotations and metadata to segments that the X-Ray SDK for Node.js records for your application.


## [Working with Python](https://docs.aws.amazon.com/xray/latest/devguide/xray-python.md)

- [AWS Distro for OpenTelemetry Python](https://docs.aws.amazon.com/xray/latest/devguide/xray-python-opentel-sdk.md): Use the AWS Distro for OpenTelemetry to instrument Python applications.

### [X-Ray SDK for Python](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-python.md)

Use the X-Ray SDK for Python to instrument Python applications.

- [Configuration](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-python-configuration.md): Configure the X-Ray SDK for Python module with service plugins, sampling rules, and log settings.
- [Incoming requests](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-python-middleware.md): Add a filter to your application with the X-Ray SDK for Python to trace incoming requests.
- [Patching libraries](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-python-patching.md): Instrument libraries with the X-Ray SDK for Python to trace downstream calls to AWS services, SQL databases, and other APIs.
- [AWS SDK clients](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-python-awssdkclients.md): Instrument AWS SDK for Java clients with the X-Ray SDK for Python to trace downstream calls to AWS services and resources.
- [Outgoing HTTP calls](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-python-httpclients.md): Instrument HTTP clients with the X-Ray SDK for Python to trace calls to downstream web APIs.
- [Custom subsegments](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-python-subsegments.md): Create additional subsegments with the X-Ray SDK for Python to trace functions or sections of code.
- [Annotations and metadata](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-python-segment.md): Add annotations and metadata to segments that the X-Ray SDK for Python records for your application.
- [Instrument serverless applications](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-python-serverless.md): AWS X-Ray SDK for Python supports instrumenting web frameworks deployed in serverless applications.


## [Working with .NET](https://docs.aws.amazon.com/xray/latest/devguide/xray-dotnet.md)

- [AWS Distro for OpenTelemetry .NET](https://docs.aws.amazon.com/xray/latest/devguide/xray-dotnet-opentel-sdk.md): Use the AWS Distro for OpenTelemetry to instrument .NET applications.

### [X-Ray SDK for .NET](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-dotnet.md)

Use the X-Ray SDK for .NET to instrument your application code and send trace data to AWS X-Ray.

- [Configuration](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-dotnet-configuration.md): Configure the X-Ray SDK for .NET module with service plugins and sampling rules.
- [Incoming requests](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-dotnet-messagehandler.md): Add a message handler to your application with the X-Ray SDK for .NET to trace incoming requests.
- [AWS SDK clients](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-dotnet-sdkclients.md): Instrument AWS SDK for .NET clients with the X-Ray SDK for .NET to trace downstream calls to AWS services and resources.
- [Outgoing HTTP calls](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-dotnet-httpclients.md): Instrument HTTP clients with the X-Ray SDK for .NET to trace calls to downstream web APIs.
- [SQL queries](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-dotnet-sqlqueries.md): Instrument database connections with the X-Ray SDK for .NET to trace SQL queries.
- [Custom subsegments](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-dotnet-subsegments.md): Create additional subsegments with the X-Ray SDK for .NET to trace functions or sections of code.
- [Annotations and metadata](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-dotnet-segment.md): Add annotations and metadata to segments that the X-Ray SDK for .NET records for your application.


## [Working with Ruby](https://docs.aws.amazon.com/xray/latest/devguide/xray-ruby.md)

- [AWS Distro for OpenTelemetry Ruby](https://docs.aws.amazon.com/xray/latest/devguide/xray-ruby-opentel-sdk.md): Use the AWS Distro for OpenTelemetry to instrument Ruby applications.

### [X-Ray SDK for Ruby](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-ruby.md)

Use the X-Ray SDK to instrument Ruby applications.

- [Configuration](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-ruby-configuration.md): Configure the X-Ray SDK for Ruby module with service plugins, sampling rules, and log settings.
- [Incoming requests](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-ruby-middleware.md): Add a filter to your application with the X-Ray SDK for Ruby to trace incoming requests.
- [Patching libraries](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-ruby-patching.md): Instrument libraries with the X-Ray SDK for Ruby to trace downstream calls to AWS services, SQL databases, and other APIs.
- [AWS SDK clients](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-ruby-awssdkclients.md): Instrument AWS SDK for Java clients with the X-Ray SDK for Ruby to trace downstream calls to AWS services and resources.
- [Custom subsegments](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-ruby-subsegments.md): Create additional subsegments with the X-Ray SDK to trace functions or sections of code.
- [Annotations and metadata](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-ruby-segment.md): Add annotations and metadata to segments that the X-Ray SDK for Ruby records for your application.


## [Migrating from X-Ray instrumentation to OpenTelemetry instrumentation](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-migration.md)

- [Migrating to OpenTelemetry Java](https://docs.aws.amazon.com/xray/latest/devguide/xray-migration-opentelemetry.md): This section provides guidance on migrating from the X-Ray SDK to the OpenTelemetry SDK for Java applications.
- [Migrate to OpenTelemetry Go](https://docs.aws.amazon.com/xray/latest/devguide/manual-instrumentation-go.md): Learn how to manually instrument your Go applications using the OpenTelemetry SDK as a replacement for X-Ray SDK instrumentation.
- [Migrate to OpenTelemetry Node.js](https://docs.aws.amazon.com/xray/latest/devguide/migrate-xray-to-opentelemetry-nodejs.md): This section explains how to migrate your Node.js applications from X-Ray SDK to OpenTelemetry.
- [Migrate to OpenTelemetry .NET](https://docs.aws.amazon.com/xray/latest/devguide/introduction-dotnet.md): This section provides guidance on migrating from X-Ray SDK to OpenTelemetry for .NET applications, including both zero-code automatic instrumentation and manual instrumentation approaches.
- [Migrate to OpenTelemetry Python](https://docs.aws.amazon.com/xray/latest/devguide/migrate-xray-to-opentelemetry-python.md): This chapter provides guidance on migrating from X-Ray SDK to OpenTelemetry for Python applications, including both zero-code automatic instrumentation and manual instrumentation approaches.
- [Migrate to OpenTelemetry Ruby](https://docs.aws.amazon.com/xray/latest/devguide/migrate-xray-to-opentelemetry-ruby.md): This section provides guidance on migrating from X-Ray SDK to OpenTelemetry for Ruby applications, focusing on the manual instrumentation approach.


## Full content

The entire guide is also available as a single markdown file, useful for feeding the full guide to an LLM in one pass:

- [Complete guide (single file)](https://docs.aws.amazon.com/xray/latest/devguide/full.md)