AWS X-Ray website screenshot

AWS X-Ray

AWS X-Ray is a service that helps developers analyze and debug distributed applications by providing end-to-end tracing of requests as they travel through the application, identifying performance bottlenecks and errors. It is now part of Amazon CloudWatch Application Signals for unified observability.

1 APIs 9 Features
DebuggingDistributed TracingMicroservicesObservability

APIs

AWS X-Ray

AWS X-Ray is a service that helps developers analyze and debug distributed applications by providing end-to-end tracing of requests as they travel through the application, ident...

Collections

Pricing Plans

Aws X Ray Plans Pricing

3 plans

PLANS

Rate Limits

Aws X Ray Rate Limits

5 limits

RATE LIMITS

FinOps

Features

End-to-End Tracing

Trace requests from client to backend across all services in your distributed application.

Service Map

Visualize service dependencies and real-time health indicators in an interactive map.

Trace Analytics

Filter, search, and analyze traces using filter expressions and groups.

Sampling Rules

Control trace collection rates with dynamic sampling rules to manage cost and volume.

Annotations and Metadata

Add indexed annotations and non-indexed metadata to traces for custom filtering and context.

Error Analysis

Identify and analyze errors, faults, and throttling across distributed services.

Latency Analysis

Identify performance bottlenecks with detailed latency histograms and percentile data.

CloudWatch Integration

Integrated with CloudWatch Application Signals for unified observability and alerting.

SDK Support

Instrument applications with X-Ray SDKs for Java, Python, Go, Node.js, Ruby, and .NET.

Use Cases

Performance Optimization

Identify and resolve latency bottlenecks in distributed microservices applications.

Error Debugging

Trace errors and exceptions to their root cause across service boundaries.

Dependency Analysis

Understand service dependencies and the impact of downstream failures.

SLA Monitoring

Monitor request latency and error rates against service level agreements.

Microservices Visibility

Gain observability into complex microservices architectures and their interactions.

Semantic Vocabularies

Aws X Ray Context

19 classes · 0 properties

JSON-LD

API Governance Rules

AWS X-Ray API Rules

5 rules · 3 errors 1 warnings 1 info

SPECTRAL

JSON Structure

X Ray Batchgettracesresult Structure

0 properties

JSON STRUCTURE

X Ray Edgestatistics Structure

0 properties

JSON STRUCTURE

X Ray Encryptionconfig Structure

0 properties

JSON STRUCTURE

X Ray Getservicegraphresult Structure

0 properties

JSON STRUCTURE

X Ray Gettracesummariesresult Structure

0 properties

JSON STRUCTURE

X Ray Group Structure

0 properties

JSON STRUCTURE

X Ray Groupsummary Structure

0 properties

JSON STRUCTURE

X Ray Histogramentry Structure

0 properties

JSON STRUCTURE

X Ray Insight Structure

0 properties

JSON STRUCTURE

X Ray Insightsummary Structure

0 properties

JSON STRUCTURE

X Ray Samplingrule Structure

0 properties

JSON STRUCTURE

X Ray Samplingrulerecord Structure

0 properties

JSON STRUCTURE

X Ray Service Structure

0 properties

JSON STRUCTURE

X Ray Serviceid Structure

0 properties

JSON STRUCTURE

X Ray Servicestatistics Structure

0 properties

JSON STRUCTURE

X Ray Tag Structure

0 properties

JSON STRUCTURE

X Ray Timeseriesservicestatistics Structure

0 properties

JSON STRUCTURE

X Ray Trace Structure

0 properties

JSON STRUCTURE

X Ray Tracesummary Structure

0 properties

JSON STRUCTURE

Example Payloads

X Ray Edgestatistics Example

3 fields

EXAMPLE

X Ray Group Example

3 fields

EXAMPLE

X Ray Groupsummary Example

3 fields

EXAMPLE

X Ray Histogramentry Example

3 fields

EXAMPLE

X Ray Insight Example

3 fields

EXAMPLE

X Ray Insightsummary Example

3 fields

EXAMPLE

X Ray Samplingrule Example

3 fields

EXAMPLE

X Ray Service Example

3 fields

EXAMPLE

X Ray Serviceid Example

3 fields

EXAMPLE

X Ray Tag Example

3 fields

EXAMPLE

X Ray Trace Example

3 fields

EXAMPLE

X Ray Tracesummary Example

3 fields

EXAMPLE

Resources

🔗
Website
Website
🔗
Documentation
Documentation
🚀
GettingStarted
GettingStarted
💰
Pricing
Pricing
💬
FAQ
FAQ
📜
TermsOfService
TermsOfService
📜
PrivacyPolicy
PrivacyPolicy
💬
Support
Support
📰
Blog
Blog
🟢
StatusPage
StatusPage
🔗
SpectralRules
SpectralRules
🔗
Vocabulary
Vocabulary

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: AWS 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: AWS 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. A segment document can be a completed segment, an in-progress segment, or
      a subsegment.
  - info:
      name: AWS X-Ray Get a List of Traces by ID
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/TraceGraph
      body:
        type: json
        data: '{}'
    docs: Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from
      a single request.
  - info:
      name: AWS 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. To get the
      full traces, pass the trace IDs to BatchGetTraces.
- info:
    name: Service Graph
    type: folder
  items:
  - info:
      name: AWS 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, and downstream services that they call
      as a result.
  - info:
      name: AWS X-Ray Get Time Series Service Statistics
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/TimeSeriesServiceStatistics
      body:
        type: json
        data: '{}'
    docs: Get an aggregation of service statistics over a time period.
- info:
    name: Groups
    type: folder
  items:
  - info:
      name: AWS X-Ray Create a Group
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/Groups
      body:
        type: json
        data: '{}'
    docs: Creates a group resource with a name and a filter expression.
  - info:
      name: AWS X-Ray Get All Active Groups
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/GetGroups
      body:
        type: json
        data: '{}'
    docs: Retrieves all active group details.
  - info:
      name: AWS X-Ray Get a Group
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/Group
      body:
        type: json
        data: '{}'
    docs: Retrieves group resource details.
  - info:
      name: AWS X-Ray Update a Group
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/UpdateGroup
      body:
        type: json
        data: '{}'
    docs: Updates a group resource.
  - info:
      name: AWS X-Ray Delete a Group
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/DeleteGroup
      body:
        type: json
        data: '{}'
    docs: Deletes a group resource.
- info:
    name: Sampling
    type: folder
  items:
  - info:
      name: AWS X-Ray Get All 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: AWS X-Ray Create a Sampling Rule
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/CreateSamplingRule
      body:
        type: json
        data: '{}'
    docs: Creates a rule to control sampling behavior for instrumented applications.
  - info:
      name: AWS X-Ray Update a Sampling Rule
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/UpdateSamplingRule
      body:
        type: json
        data: '{}'
    docs: Modifies a sampling rule's configuration.
  - info:
      name: AWS X-Ray Delete a Sampling Rule
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/DeleteSamplingRule
      body:
        type: json
        data: '{}'
    docs: Deletes a sampling rule.
  - info:
      name: AWS X-Ray Get Sampling Targets
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/SamplingTargets
      body:
        type: json
        data: '{}'
    docs: Requests a sampling quota for rules that the service is using to sample requests.
- info:
    name: Encryption
    type: folder
  items:
  - info:
      name: AWS X-Ray Get Encryption Configuration
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/EncryptionConfig
    docs: Retrieves the current encryption configuration for X-Ray data.
  - info:
      name: AWS X-Ray Update Encryption Configuration
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/PutEncryptionConfig
      body:
        type: json
        data: '{}'
    docs: Updates the encryption configuration for X-Ray data.
- info:
    name: Default
    type: folder
  items:
  - info:
      name: AWS X-Ray List Tags for a Resource
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/Tags
      body:
        type: json
        data: '{}'
    docs: Returns a list of tags applied to the specified X-Ray resource.
  - info:
      name: AWS X-Ray Tag a Resource
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/TagResource
      body:
        type: json
        data: '{}'
    docs: Applies tags to an existing X-Ray resource.
  - info:
      name: AWS X-Ray Untag a Resource
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/UntagResource
      body:
        type: json
        data: '{}'
    docs: Removes tags from an X-Ray resource.
- info:
    name: Insights
    type: folder
  items:
  - info:
      name: AWS X-Ray Get Insight Summaries
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/Insights
      body:
        type: json
        data: '{}'
    docs: Retrieves the summaries of all insights for the specified group.
  - info:
      name: AWS X-Ray Get Insight Details
      type: http
    http:
      method: POST
      url: https://xray.{region}.amazonaws.com/Insight
      body:
        type: json
        data: '{}'
    docs: Retrieves the summary information of an insight.
bundled: true