logo
Expand description

AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.

If you’re using the service, you’re probably looking for XRayClient and XRay.

Structs

An alias for an edge.

Value of a segment annotation. Has one of three value types: Number, Boolean, or String.

The service within the service graph that has anomalously high fault rates.

A list of Availability Zones corresponding to the segments in a trace.

Information about a connection between two services.

Response statistics for an edge.

A configuration document that specifies encryption configuration settings.

The root cause of a trace summary error.

A collection of segments and corresponding subsegments associated to a trace summary error.

A collection of fields identifying the services in a trace summary error.

Information about requests that failed with a 4xx Client Error status code.

The root cause information for a trace summary fault.

A collection of segments and corresponding subsegments associated to a trace summary fault error.

A collection of fields identifying the services in a trace summary fault.

Information about requests that failed with a 5xx Server Error status code.

The predicted high and low fault count. This is used to determine if a service has become anomalous and if an insight should be created.

Details and metadata for a group.

Details for a group without metadata.

An entry in a histogram for a statistic. A histogram maps the range of observed values on the X axis, and the prevalence of each value on the Y axis.

Information about an HTTP request.

When fault rates go outside of the expected range, X-Ray creates an insight. Insights tracks emergent issues within your applications.

X-Ray reevaluates insights periodically until they are resolved, and records each intermediate state in an event. You can review incident events in the Impact Timeline on the Inspect page in the X-Ray console.

The connection between two service in an insight impact graph.

Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.

Information that describes an insight.

The structure containing configurations related to insights.

A list of EC2 instance IDs corresponding to the segments in a trace.

Statistics that describe how the incident has impacted a service.

A list of resources ARNs corresponding to the segments in a trace.

The root cause information for a response time warning.

A collection of segments and corresponding subsegments associated to a response time warning.

A collection of fields identifying the service in a response time warning.

The exception associated with a root cause.

A sampling rule that services use to decide whether to instrument a request. Rule fields can match properties of the service, or properties of a request. The service can ignore rules that don't match its properties.

A SamplingRule and its metadata.

A document specifying changes to a sampling rule's configuration.

Aggregated request sampling data for a sampling rule across all services for a 10-second window.

Request sampling results for a single rule from a service. Results are for the last 10 seconds unless the service has been assigned a longer reporting interval after a previous call to GetSamplingTargets.

The name and value of a sampling rule to apply to a trace summary.

Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray calculates a new reservoir for each service based on the recent sampling results of all services that called GetSamplingTargets.

A segment from a trace that has been ingested by the X-Ray service. The segment can be compiled from documents uploaded with PutTraceSegments, or an inferred segment for a downstream service, generated from a subsegment sent by the service that called it.

For the full segment document schema, see AWS X-Ray Segment Documents in the AWS X-Ray Developer Guide.

Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.

Response statistics for a service.

A map that contains tag keys and tag values to attach to an AWS X-Ray group or sampling rule. For more information about ways to use tags, see Tagging AWS resources in the AWS General Reference.

The following restrictions apply to tags:

  • Maximum number of user-applied tags per resource: 50

  • Tag keys and values are case sensitive.

  • Don't use aws: as a prefix for keys; it's reserved for AWS use. You cannot edit or delete system tags.

A list of TimeSeriesStatistic structures.

A collection of segment documents with matching trace IDs.

Metadata generated from the segment documents in a trace.

Information about a user recorded in segment documents.

Sampling statistics from a call to GetSamplingTargets that X-Ray could not process.

Information about a segment that failed processing.

Information about a segment annotation.

A client for the AWS X-Ray API.

Enums

Errors returned by BatchGetTraces

Errors returned by CreateGroup

Errors returned by CreateSamplingRule

Errors returned by DeleteGroup

Errors returned by DeleteSamplingRule

Errors returned by GetEncryptionConfig

Errors returned by GetGroup

Errors returned by GetGroups

Errors returned by GetInsight

Errors returned by GetInsightEvents

Errors returned by GetInsightImpactGraph

Errors returned by GetInsightSummaries

Errors returned by GetSamplingRules

Errors returned by GetSamplingStatisticSummaries

Errors returned by GetSamplingTargets

Errors returned by GetServiceGraph

Errors returned by GetTimeSeriesServiceStatistics

Errors returned by GetTraceGraph

Errors returned by GetTraceSummaries

Errors returned by ListTagsForResource

Errors returned by PutEncryptionConfig

Errors returned by PutTelemetryRecords

Errors returned by PutTraceSegments

Errors returned by TagResource

Errors returned by UntagResource

Errors returned by UpdateGroup

Errors returned by UpdateSamplingRule

Traits

Trait representing the capabilities of the AWS X-Ray API. AWS X-Ray clients implement this trait.