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§
- Alias
An alias for an edge.
- Annotation
Value Value of a segment annotation. Has one of three value types: Number, Boolean, or String.
- Anomalous
Service The service within the service graph that has anomalously high fault rates.
- Availability
Zone Detail A list of Availability Zones corresponding to the segments in a trace.
- Backend
Connection Errors - Batch
GetTraces Request - Batch
GetTraces Result - Create
Group Request - Create
Group Result - Create
Sampling Rule Request - Create
Sampling Rule Result - Delete
Group Request - Delete
Group Result - Delete
Sampling Rule Request - Delete
Sampling Rule Result - Edge
Information about a connection between two services.
- Edge
Statistics Response statistics for an edge.
- Encryption
Config A configuration document that specifies encryption configuration settings.
- Error
Root Cause The root cause of a trace summary error.
- Error
Root Cause Entity A collection of segments and corresponding subsegments associated to a trace summary error.
- Error
Root Cause Service A collection of fields identifying the services in a trace summary error.
- Error
Statistics Information about requests that failed with a 4xx Client Error status code.
- Fault
Root Cause The root cause information for a trace summary fault.
- Fault
Root Cause Entity A collection of segments and corresponding subsegments associated to a trace summary fault error.
- Fault
Root Cause Service A collection of fields identifying the services in a trace summary fault.
- Fault
Statistics Information about requests that failed with a 5xx Server Error status code.
- Forecast
Statistics 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.
- GetEncryption
Config Request - GetEncryption
Config Result - GetGroup
Request - GetGroup
Result - GetGroups
Request - GetGroups
Result - GetInsight
Events Request - GetInsight
Events Result - GetInsight
Impact Graph Request - GetInsight
Impact Graph Result - GetInsight
Request - GetInsight
Result - GetInsight
Summaries Request - GetInsight
Summaries Result - GetSampling
Rules Request - GetSampling
Rules Result - GetSampling
Statistic Summaries Request - GetSampling
Statistic Summaries Result - GetSampling
Targets Request - GetSampling
Targets Result - GetService
Graph Request - GetService
Graph Result - GetTime
Series Service Statistics Request - GetTime
Series Service Statistics Result - GetTrace
Graph Request - GetTrace
Graph Result - GetTrace
Summaries Request - GetTrace
Summaries Result - Group
Details and metadata for a group.
- Group
Summary Details for a group without metadata.
- Histogram
Entry 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.
- Http
Information about an HTTP request.
- Insight
When fault rates go outside of the expected range, X-Ray creates an insight. Insights tracks emergent issues within your applications.
- Insight
Event 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.
- Insight
Impact Graph Edge The connection between two service in an insight impact graph.
- Insight
Impact Graph Service Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.
- Insight
Summary Information that describes an insight.
- Insights
Configuration The structure containing configurations related to insights.
- Instance
IdDetail A list of EC2 instance IDs corresponding to the segments in a trace.
- List
Tags ForResource Request - List
Tags ForResource Response - PutEncryption
Config Request - PutEncryption
Config Result - PutTelemetry
Records Request - PutTelemetry
Records Result - PutTrace
Segments Request - PutTrace
Segments Result - Request
Impact Statistics Statistics that describe how the incident has impacted a service.
- ResourceARN
Detail A list of resources ARNs corresponding to the segments in a trace.
- Response
Time Root Cause The root cause information for a response time warning.
- Response
Time Root Cause Entity A collection of segments and corresponding subsegments associated to a response time warning.
- Response
Time Root Cause Service A collection of fields identifying the service in a response time warning.
- Root
Cause Exception The exception associated with a root cause.
- Sampling
Rule 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.
- Sampling
Rule Record A SamplingRule and its metadata.
- Sampling
Rule Update A document specifying changes to a sampling rule's configuration.
- Sampling
Statistic Summary Aggregated request sampling data for a sampling rule across all services for a 10-second window.
- Sampling
Statistics Document 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.
- Sampling
Strategy The name and value of a sampling rule to apply to a trace summary.
- Sampling
Target Document 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.
- Segment
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
inferredsegment 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.
- Service
Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.
- Service
Id - Service
Statistics Response statistics for a service.
- Tag
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.
-
- TagResource
Request - TagResource
Response - Telemetry
Record - Time
Series Service Statistics A list of TimeSeriesStatistic structures.
- Trace
A collection of segment documents with matching trace IDs.
- Trace
Summary Metadata generated from the segment documents in a trace.
- Trace
User Information about a user recorded in segment documents.
- Unprocessed
Statistics Sampling statistics from a call to GetSamplingTargets that X-Ray could not process.
- Unprocessed
Trace Segment Information about a segment that failed processing.
- Untag
Resource Request - Untag
Resource Response - Update
Group Request - Update
Group Result - Update
Sampling Rule Request - Update
Sampling Rule Result - Value
With Service Ids Information about a segment annotation.
- XRay
Client - A client for the AWS X-Ray API.
Enums§
- Batch
GetTraces Error - Errors returned by BatchGetTraces
- Create
Group Error - Errors returned by CreateGroup
- Create
Sampling Rule Error - Errors returned by CreateSamplingRule
- Delete
Group Error - Errors returned by DeleteGroup
- Delete
Sampling Rule Error - Errors returned by DeleteSamplingRule
- GetEncryption
Config Error - Errors returned by GetEncryptionConfig
- GetGroup
Error - Errors returned by GetGroup
- GetGroups
Error - Errors returned by GetGroups
- GetInsight
Error - Errors returned by GetInsight
- GetInsight
Events Error - Errors returned by GetInsightEvents
- GetInsight
Impact Graph Error - Errors returned by GetInsightImpactGraph
- GetInsight
Summaries Error - Errors returned by GetInsightSummaries
- GetSampling
Rules Error - Errors returned by GetSamplingRules
- GetSampling
Statistic Summaries Error - Errors returned by GetSamplingStatisticSummaries
- GetSampling
Targets Error - Errors returned by GetSamplingTargets
- GetService
Graph Error - Errors returned by GetServiceGraph
- GetTime
Series Service Statistics Error - Errors returned by GetTimeSeriesServiceStatistics
- GetTrace
Graph Error - Errors returned by GetTraceGraph
- GetTrace
Summaries Error - Errors returned by GetTraceSummaries
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- PutEncryption
Config Error - Errors returned by PutEncryptionConfig
- PutTelemetry
Records Error - Errors returned by PutTelemetryRecords
- PutTrace
Segments Error - Errors returned by PutTraceSegments
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Group Error - Errors returned by UpdateGroup
- Update
Sampling Rule Error - Errors returned by UpdateSamplingRule
Traits§
- XRay
- Trait representing the capabilities of the AWS X-Ray API. AWS X-Ray clients implement this trait.