Amazon X-Ray website screenshot

Amazon X-Ray

AWS X-Ray is a distributed tracing service that helps developers analyze and debug production applications, providing end-to-end visibility into requests as they travel through the application. X-Ray provides service maps, trace analysis, sampling rules, group filtering, and AI-powered insights for identifying performance bottlenecks and errors across microservices and serverless architectures.

1 APIs 8 Features
Application PerformanceDebuggingDistributed TracingMonitoringObservability

APIs

Amazon X-Ray REST API

RESTful API for AWS X-Ray distributed tracing operations including trace retrieval, service map generation, sampling rule management, group management, and insights analysis for...

Collections

Pricing Plans

Rate Limits

Amazon Xray Rate Limits

5 limits

RATE LIMITS

FinOps

Features

End-to-End Distributed Tracing

Trace requests as they travel across services, microservices, and serverless functions to identify bottlenecks and errors.

Service Map Visualization

Automatically generate visual service maps showing all connected services and their health status and latency.

Trace Filtering and Groups

Create groups with filter expressions to organize and analyze subsets of traces based on service names, URLs, or annotations.

Adaptive Sampling

Configurable sampling rules to control the percentage of requests traced, balancing coverage with cost.

X-Ray Insights

AI-powered automatic detection of anomalies and performance issues with root cause analysis across the service map.

AWS Service Integration

Native tracing support across Lambda, EC2, ECS, EKS, API Gateway, SNS, SQS, and 200+ other AWS services.

SDK and Agent Support

X-Ray SDKs for Java, Node.js, Python, Go, Ruby, and .NET for custom application instrumentation.

CloudWatch Integration

Deep integration with Amazon CloudWatch for correlating traces with metrics, logs, and alarms.

Use Cases

Microservices Debugging

Trace requests across microservices to identify which service is causing latency or errors in distributed applications.

Serverless Application Monitoring

Monitor Lambda function execution chains and identify cold start impacts and downstream service bottlenecks.

Performance Optimization

Use trace data and service maps to identify and eliminate performance bottlenecks in production applications.

Root Cause Analysis

Drill into traces to understand the exact call chain that caused an error or latency spike.

SLA Compliance Monitoring

Track end-to-end latency and error rates across services to ensure application SLAs are being met.

Integrations

AWS Lambda

Automatic tracing of Lambda function invocations and downstream calls.

Amazon API Gateway

Native tracing of API Gateway requests through backend services.

Amazon CloudWatch

Correlation of traces with CloudWatch metrics, logs, and alarms.

AWS App Mesh

Service mesh integration for automatic tracing of Envoy-based microservices.

OpenTelemetry

X-Ray supports the OpenTelemetry standard via the AWS Distro for OpenTelemetry.

Semantic Vocabularies

Amazon Xray Context

108 classes · 164 properties

JSON-LD

API Governance Rules

Amazon X-Ray API Rules

15 rules · 8 errors 5 warnings 2 info

SPECTRAL

JSON Structure

Xray Alias List Structure

0 properties

JSON STRUCTURE

Xray Alias Names Structure

0 properties

JSON STRUCTURE

Xray Alias Structure

3 properties

JSON STRUCTURE

Xray Amazon Resource Name Structure

0 properties

JSON STRUCTURE

Xray Annotation Key Structure

0 properties

JSON STRUCTURE

Xray Annotation Value Structure

3 properties

JSON STRUCTURE

Xray Annotations Structure

0 properties

JSON STRUCTURE

Xray Anomalous Service List Structure

0 properties

JSON STRUCTURE

Xray Anomalous Service Structure

1 properties

JSON STRUCTURE

Xray Attribute Key Structure

0 properties

JSON STRUCTURE

Xray Attribute Map Structure

0 properties

JSON STRUCTURE

Xray Attribute Value Structure

0 properties

JSON STRUCTURE

Xray Availability Zone Detail Structure

1 properties

JSON STRUCTURE

Xray Backend Connection Errors Structure

6 properties

JSON STRUCTURE

Xray Batch Get Traces Request Structure

2 properties

JSON STRUCTURE

Xray Batch Get Traces Result Structure

3 properties

JSON STRUCTURE

Xray Boolean Structure

0 properties

JSON STRUCTURE

Xray Borrow Count Structure

0 properties

JSON STRUCTURE

Xray Client Id Structure

0 properties

JSON STRUCTURE

Xray Create Group Request Structure

4 properties

JSON STRUCTURE

Xray Create Group Result Structure

1 properties

JSON STRUCTURE

Xray Create Sampling Rule Request Structure

2 properties

JSON STRUCTURE

Xray Create Sampling Rule Result Structure

1 properties

JSON STRUCTURE

Xray Delete Group Request Structure

2 properties

JSON STRUCTURE

Xray Delete Group Result Structure

0 properties

JSON STRUCTURE

Xray Delete Resource Policy Request Structure

2 properties

JSON STRUCTURE

Xray Delete Resource Policy Result Structure

0 properties

JSON STRUCTURE

Xray Delete Sampling Rule Request Structure

2 properties

JSON STRUCTURE

Xray Delete Sampling Rule Result Structure

1 properties

JSON STRUCTURE

Xray Double Structure

0 properties

JSON STRUCTURE

Xray Ec2 Instance Id Structure

0 properties

JSON STRUCTURE

Xray Edge List Structure

0 properties

JSON STRUCTURE

Xray Edge Statistics Structure

5 properties

JSON STRUCTURE

Xray Edge Structure

8 properties

JSON STRUCTURE

Xray Encryption Config Structure

3 properties

JSON STRUCTURE

Xray Encryption Key Id Structure

0 properties

JSON STRUCTURE

Xray Encryption Status Structure

0 properties

JSON STRUCTURE

Xray Encryption Type Structure

0 properties

JSON STRUCTURE

Xray Entity Selector Expression Structure

0 properties

JSON STRUCTURE

Xray Error Root Cause Entity Path Structure

0 properties

JSON STRUCTURE

Xray Error Root Cause Entity Structure

3 properties

JSON STRUCTURE

Xray Error Root Cause Service Structure

6 properties

JSON STRUCTURE

Xray Error Root Cause Services Structure

0 properties

JSON STRUCTURE

Xray Error Root Cause Structure

2 properties

JSON STRUCTURE

Xray Error Root Causes Structure

0 properties

JSON STRUCTURE

Xray Error Statistics Structure

3 properties

JSON STRUCTURE

Xray Event Summary Text Structure

0 properties

JSON STRUCTURE

Xray Fault Root Cause Entity Path Structure

0 properties

JSON STRUCTURE

Xray Fault Root Cause Entity Structure

3 properties

JSON STRUCTURE

Xray Fault Root Cause Service Structure

6 properties

JSON STRUCTURE

Xray Fault Root Cause Services Structure

0 properties

JSON STRUCTURE

Xray Fault Root Cause Structure

2 properties

JSON STRUCTURE

Xray Fault Root Causes Structure

0 properties

JSON STRUCTURE

Xray Fault Statistics Structure

2 properties

JSON STRUCTURE

Xray Filter Expression Structure

0 properties

JSON STRUCTURE

Xray Fixed Rate Structure

0 properties

JSON STRUCTURE

Xray Forecast Statistics Structure

2 properties

JSON STRUCTURE

Xray Get Encryption Config Request Structure

0 properties

JSON STRUCTURE

Xray Get Encryption Config Result Structure

1 properties

JSON STRUCTURE

Xray Get Group Request Structure

2 properties

JSON STRUCTURE

Xray Get Group Result Structure

1 properties

JSON STRUCTURE

Xray Get Groups Next Token Structure

0 properties

JSON STRUCTURE

Xray Get Groups Request Structure

1 properties

JSON STRUCTURE

Xray Get Groups Result Structure

2 properties

JSON STRUCTURE

Xray Get Insight Events Max Results Structure

0 properties

JSON STRUCTURE

Xray Get Insight Events Request Structure

3 properties

JSON STRUCTURE

Xray Get Insight Events Result Structure

2 properties

JSON STRUCTURE

Xray Get Insight Request Structure

1 properties

JSON STRUCTURE

Xray Get Insight Result Structure

1 properties

JSON STRUCTURE

Xray Get Insight Summaries Request Structure

7 properties

JSON STRUCTURE

Xray Get Insight Summaries Result Structure

2 properties

JSON STRUCTURE

Xray Get Sampling Rules Request Structure

1 properties

JSON STRUCTURE

Xray Get Sampling Rules Result Structure

2 properties

JSON STRUCTURE

Xray Get Sampling Targets Request Structure

1 properties

JSON STRUCTURE

Xray Get Sampling Targets Result Structure

3 properties

JSON STRUCTURE

Xray Get Service Graph Request Structure

5 properties

JSON STRUCTURE

Xray Get Service Graph Result Structure

5 properties

JSON STRUCTURE

Xray Get Trace Graph Request Structure

2 properties

JSON STRUCTURE

Xray Get Trace Graph Result Structure

2 properties

JSON STRUCTURE

Xray Get Trace Summaries Request Structure

7 properties

JSON STRUCTURE

Xray Get Trace Summaries Result Structure

4 properties

JSON STRUCTURE

Xray Group Arn Structure

0 properties

JSON STRUCTURE

Xray Group Name Structure

0 properties

JSON STRUCTURE

Xray Group Structure

4 properties

JSON STRUCTURE

Xray Group Summary List Structure

0 properties

JSON STRUCTURE

Xray Group Summary Structure

4 properties

JSON STRUCTURE

Xray Histogram Entry Structure

2 properties

JSON STRUCTURE

Xray Histogram Structure

0 properties

JSON STRUCTURE

Xray Host Structure

0 properties

JSON STRUCTURE

Xray Hostname Structure

0 properties

JSON STRUCTURE

Xray Http Method Structure

0 properties

JSON STRUCTURE

Xray Http Structure

5 properties

JSON STRUCTURE

Xray Insight Category List Structure

0 properties

JSON STRUCTURE

Xray Insight Category Structure

0 properties

JSON STRUCTURE

Xray Insight Event List Structure

0 properties

JSON STRUCTURE

Xray Insight Event Structure

5 properties

JSON STRUCTURE

Xray Insight Id Structure

0 properties

JSON STRUCTURE

Xray Insight Impact Graph Edge List Structure

0 properties

JSON STRUCTURE

Xray Insight Impact Graph Edge Structure

1 properties

JSON STRUCTURE

Xray Insight Impact Graph Service Structure

6 properties

JSON STRUCTURE

Xray Insight State List Structure

0 properties

JSON STRUCTURE

Xray Insight State Structure

0 properties

JSON STRUCTURE

Xray Insight Structure

12 properties

JSON STRUCTURE

Xray Insight Summary List Structure

0 properties

JSON STRUCTURE

Xray Insight Summary Structure

13 properties

JSON STRUCTURE

Xray Insight Summary Text Structure

0 properties

JSON STRUCTURE

Xray Insights Configuration Structure

2 properties

JSON STRUCTURE

Xray Instance Id Detail Structure

1 properties

JSON STRUCTURE

Xray Integer Structure

0 properties

JSON STRUCTURE

Xray Invalid Request Exception Structure

0 properties

JSON STRUCTURE

Xray List Resource Policies Request Structure

1 properties

JSON STRUCTURE

Xray List Resource Policies Result Structure

2 properties

JSON STRUCTURE

Xray List Tags For Resource Request Structure

2 properties

JSON STRUCTURE

Xray Lockout Prevention Exception Structure

0 properties

JSON STRUCTURE

Xray Nullable Boolean Structure

0 properties

JSON STRUCTURE

Xray Nullable Double Structure

0 properties

JSON STRUCTURE

Xray Nullable Integer Structure

0 properties

JSON STRUCTURE

Xray Nullable Long Structure

0 properties

JSON STRUCTURE

Xray Policy Document Structure

0 properties

JSON STRUCTURE

Xray Policy Name Structure

0 properties

JSON STRUCTURE

Xray Policy Revision Id Structure

0 properties

JSON STRUCTURE

Xray Priority Structure

0 properties

JSON STRUCTURE

Xray Put Encryption Config Request Structure

2 properties

JSON STRUCTURE

Xray Put Encryption Config Result Structure

1 properties

JSON STRUCTURE

Xray Put Resource Policy Request Structure

4 properties

JSON STRUCTURE

Xray Put Resource Policy Result Structure

1 properties

JSON STRUCTURE

Xray Put Telemetry Records Request Structure

4 properties

JSON STRUCTURE

Xray Put Telemetry Records Result Structure

0 properties

JSON STRUCTURE

Xray Put Trace Segments Request Structure

1 properties

JSON STRUCTURE

Xray Put Trace Segments Result Structure

1 properties

JSON STRUCTURE

Xray Request Count Structure

0 properties

JSON STRUCTURE

Xray Request Impact Statistics Structure

3 properties

JSON STRUCTURE

Xray Reservoir Size Structure

0 properties

JSON STRUCTURE

Xray Resource Arn Detail Structure

1 properties

JSON STRUCTURE

Xray Resource Arn Structure

0 properties

JSON STRUCTURE

Xray Resource Not Found Exception Structure

0 properties

JSON STRUCTURE

Xray Resource Policy List Structure

0 properties

JSON STRUCTURE

Xray Resource Policy Next Token Structure

0 properties

JSON STRUCTURE

Xray Resource Policy Structure

4 properties

JSON STRUCTURE

Xray Response Time Root Cause Structure

2 properties

JSON STRUCTURE

Xray Response Time Root Causes Structure

0 properties

JSON STRUCTURE

Xray Root Cause Exception Structure

2 properties

JSON STRUCTURE

Xray Root Cause Exceptions Structure

0 properties

JSON STRUCTURE

Xray Rule Limit Exceeded Exception Structure

0 properties

JSON STRUCTURE

Xray Rule Name Structure

0 properties

JSON STRUCTURE

Xray Sampled Count Structure

0 properties

JSON STRUCTURE

Xray Sampling Rule Record List Structure

0 properties

JSON STRUCTURE

Xray Sampling Rule Record Structure

3 properties

JSON STRUCTURE

Xray Sampling Rule Structure

13 properties

JSON STRUCTURE

Xray Sampling Rule Update Structure

12 properties

JSON STRUCTURE

Xray Sampling Statistic Summary Structure

5 properties

JSON STRUCTURE

Xray Sampling Statistics Document Structure

6 properties

JSON STRUCTURE

Xray Sampling Strategy Name Structure

0 properties

JSON STRUCTURE

Xray Sampling Strategy Structure

2 properties

JSON STRUCTURE

Xray Sampling Target Document List Structure

0 properties

JSON STRUCTURE

Xray Sampling Target Document Structure

5 properties

JSON STRUCTURE

Xray Segment Document Structure

0 properties

JSON STRUCTURE

Xray Segment Id Structure

0 properties

JSON STRUCTURE

Xray Segment List Structure

0 properties

JSON STRUCTURE

Xray Segment Structure

2 properties

JSON STRUCTURE

Xray Service Id Structure

4 properties

JSON STRUCTURE

Xray Service Ids Structure

0 properties

JSON STRUCTURE

Xray Service List Structure

0 properties

JSON STRUCTURE

Xray Service Name Structure

0 properties

JSON STRUCTURE

Xray Service Names Structure

0 properties

JSON STRUCTURE

Xray Service Statistics Structure

5 properties

JSON STRUCTURE

Xray Service Structure

13 properties

JSON STRUCTURE

Xray Service Type Structure

0 properties

JSON STRUCTURE

Xray String Structure

0 properties

JSON STRUCTURE

Xray Tag Key List Structure

0 properties

JSON STRUCTURE

Xray Tag Key Structure

0 properties

JSON STRUCTURE

Xray Tag List Structure

0 properties

JSON STRUCTURE

Xray Tag Resource Request Structure

2 properties

JSON STRUCTURE

Xray Tag Resource Response Structure

0 properties

JSON STRUCTURE

Xray Tag Structure

2 properties

JSON STRUCTURE

Xray Tag Value Structure

0 properties

JSON STRUCTURE

Xray Telemetry Record List Structure

0 properties

JSON STRUCTURE

Xray Telemetry Record Structure

6 properties

JSON STRUCTURE

Xray Throttled Exception Structure

0 properties

JSON STRUCTURE

Xray Time Range Type Structure

0 properties

JSON STRUCTURE

Xray Time Series Service Statistics Structure

5 properties

JSON STRUCTURE

Xray Timestamp Structure

0 properties

JSON STRUCTURE

Xray Token Structure

0 properties

JSON STRUCTURE

Xray Too Many Tags Exception Structure

0 properties

JSON STRUCTURE

Xray Trace Availability Zones Structure

0 properties

JSON STRUCTURE

Xray Trace Id List Structure

0 properties

JSON STRUCTURE

Xray Trace Id Structure

0 properties

JSON STRUCTURE

Xray Trace Instance Ids Structure

0 properties

JSON STRUCTURE

Xray Trace List Structure

0 properties

JSON STRUCTURE

Xray Trace Resource Ar Ns Structure

0 properties

JSON STRUCTURE

Xray Trace Segment Document List Structure

0 properties

JSON STRUCTURE

Xray Trace Segment Document Structure

0 properties

JSON STRUCTURE

Xray Trace Structure

4 properties

JSON STRUCTURE

Xray Trace Summary List Structure

0 properties

JSON STRUCTURE

Xray Trace Summary Structure

20 properties

JSON STRUCTURE

Xray Trace User Structure

2 properties

JSON STRUCTURE

Xray Trace Users Structure

0 properties

JSON STRUCTURE

Xray Unprocessed Statistics List Structure

0 properties

JSON STRUCTURE

Xray Unprocessed Statistics Structure

3 properties

JSON STRUCTURE

Xray Unprocessed Trace Id List Structure

0 properties

JSON STRUCTURE

Xray Unprocessed Trace Segment List Structure

0 properties

JSON STRUCTURE

Xray Unprocessed Trace Segment Structure

3 properties

JSON STRUCTURE

Xray Untag Resource Request Structure

2 properties

JSON STRUCTURE

Xray Untag Resource Response Structure

0 properties

JSON STRUCTURE

Xray Update Group Request Structure

4 properties

JSON STRUCTURE

Xray Update Group Result Structure

1 properties

JSON STRUCTURE

Xray Update Sampling Rule Request Structure

1 properties

JSON STRUCTURE

Xray Update Sampling Rule Result Structure

1 properties

JSON STRUCTURE

Xray Url Path Structure

0 properties

JSON STRUCTURE

Xray Value With Service Ids Structure

2 properties

JSON STRUCTURE

Xray Values With Service Ids Structure

0 properties

JSON STRUCTURE

Xray Version Structure

0 properties

JSON STRUCTURE

Example Payloads

Xray Alias Example

3 fields

EXAMPLE

Xray Edge Example

8 fields

EXAMPLE

Xray Edge Statistics Example

5 fields

EXAMPLE

Xray Group Example

4 fields

EXAMPLE

Xray Group Summary Example

4 fields

EXAMPLE

Xray Histogram Entry Example

2 fields

EXAMPLE

Xray Http Example

5 fields

EXAMPLE

Xray Insight Event Example

5 fields

EXAMPLE

Xray Insight Example

12 fields

EXAMPLE

Xray Insight Summary Example

13 fields

EXAMPLE

Xray Resource Policy Example

4 fields

EXAMPLE

Xray Sampling Rule Example

13 fields

EXAMPLE

Xray Segment Example

2 fields

EXAMPLE

Xray Service Example

13 fields

EXAMPLE

Xray Service Id Example

4 fields

EXAMPLE

Xray Tag Example

2 fields

EXAMPLE

Xray Trace Example

4 fields

EXAMPLE

Xray Trace Summary Example

20 fields

EXAMPLE

Xray Trace User Example

2 fields

EXAMPLE

Resources

🌐
Portal
Portal
🔗
Website
Website
🔗
Documentation
Documentation
📜
TermsOfService
TermsOfService
📜
PrivacyPolicy
PrivacyPolicy
💬
Support
Support
📰
Blog
Blog
👥
GitHubOrganization
GitHubOrganization
🌐
Console
Console
📝
Signup
Signup
🔗
Login
Login
🟢
StatusPage
StatusPage
🔗
KnowledgeCenter
KnowledgeCenter
👥
YouTube
YouTube
👥
StackOverflow
StackOverflow
🔗
Contact
Contact
🔗
SpectralRules
SpectralRules
🔗
Vocabulary
Vocabulary

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: Amazon X-Ray API
  version: '2016-04-12'
request:
  auth:
    type: apikey
    key: Authorization
    value: '{{Authorization}}'
    placement: header
items:
- info:
    name: Traces
    type: folder
  items:
  - info:
      name: Amazon X-Ray Upload trace segments
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/Traces
      body:
        type: json
        data: '{}'
    docs: Uploads segment documents to AWS X-Ray.
  - info:
      name: Amazon X-Ray Get trace summaries
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/TraceSummaries
      body:
        type: json
        data: '{}'
    docs: Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.
- info:
    name: Service Graph
    type: folder
  items:
  - info:
      name: Amazon X-Ray Get the service graph
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/ServiceGraph
      body:
        type: json
        data: '{}'
    docs: Retrieves a document that describes services that process incoming requests.
- info:
    name: Sampling
    type: folder
  items:
  - info:
      name: Amazon X-Ray Get sampling rules
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/SamplingRules
      body:
        type: json
        data: '{}'
    docs: Retrieves all sampling rules.
- info:
    name: Groups
    type: folder
  items:
  - info:
      name: Amazon X-Ray Get groups
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/Groups
      body:
        type: json
        data: '{}'
    docs: Retrieves all active group details.
bundled: true