{ "version": "2.0", "service": "
AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
", "operations": { "BatchGetTraces": "Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries
to get a list of trace IDs.
Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.
", "GetTraceGraph": "Retrieves a service graph for one or more specific trace IDs.
", "GetTraceSummaries": "Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces
.
A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com
:
service(\"api.example.com\")
This filter expression finds traces that have an annotation named account
with the value 12345
:
annotation.account = \"12345\"
For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the AWS X-Ray Developer Guide.
", "PutTelemetryRecords": "Used by the AWS X-Ray daemon to upload telemetry.
", "PutTraceSegments": "Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments.
Segments must include the following fields. For the full segment document schema, see AWS X-Ray Segment Documents in the AWS X-Ray Developer Guide.
Required Segment Document Fields
name
- The name of the service that handled the request.
id
- A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits.
trace_id
- A unique identifier that connects all segments and subsegments originating from a single client request.
start_time
- Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010
or 1.480615200010E9
.
end_time
- Time the segment or subsegment was closed. For example, 1480615200.090
or 1.480615200090E9
. Specify either an end_time
or in_progress
.
in_progress
- Set to true
instead of specifying an end_time
to record that a segment has been started, but is not complete. Send an in progress segment when your application receives a request that will take a long time to serve, to trace the fact that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment.
A trace_id
consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes:
Trace ID Format
The version number, i.e. 1
.
The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200
seconds, or 58406520
in hexadecimal.
A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.
An alias for an edge.
", "refs": { "AliasList$member": null } }, "AliasList": { "base": null, "refs": { "Edge$Aliases": "Aliases for the edge.
" } }, "AliasNames": { "base": null, "refs": { "Alias$Names": "A list of names for the alias, including the canonical name.
" } }, "AnnotationKey": { "base": null, "refs": { "Annotations$key": null } }, "AnnotationValue": { "base": "Value of a segment annotation. Has one of three value types: Number, Boolean or String.
", "refs": { "ValueWithServiceIds$AnnotationValue": "Values of the annotation.
" } }, "Annotations": { "base": null, "refs": { "TraceSummary$Annotations": "Annotations from the trace's segment documents.
" } }, "BackendConnectionErrors": { "base": "", "refs": { "TelemetryRecord$BackendConnectionErrors": "" } }, "BatchGetTracesRequest": { "base": null, "refs": { } }, "BatchGetTracesResult": { "base": null, "refs": { } }, "Double": { "base": null, "refs": { "HistogramEntry$Value": "The value of the entry.
" } }, "EC2InstanceId": { "base": null, "refs": { "PutTelemetryRecordsRequest$EC2InstanceId": "" } }, "Edge": { "base": "Information about a connection between two services.
", "refs": { "EdgeList$member": null } }, "EdgeList": { "base": null, "refs": { "Service$Edges": "Connections to downstream services.
" } }, "EdgeStatistics": { "base": "Response statistics for an edge.
", "refs": { "Edge$SummaryStatistics": "Response statistics for segments on the edge.
" } }, "ErrorMessage": { "base": null, "refs": { "InvalidRequestException$Message": null, "ThrottledException$Message": null } }, "ErrorStatistics": { "base": "Information about requests that failed with a 4xx Client Error status code.
", "refs": { "EdgeStatistics$ErrorStatistics": "Information about requests that failed with a 4xx Client Error status code.
", "ServiceStatistics$ErrorStatistics": "Information about requests that failed with a 4xx Client Error status code.
" } }, "FaultStatistics": { "base": "Information about requests that failed with a 5xx Server Error status code.
", "refs": { "EdgeStatistics$FaultStatistics": "Information about requests that failed with a 5xx Server Error status code.
", "ServiceStatistics$FaultStatistics": "Information about requests that failed with a 5xx Server Error status code.
" } }, "FilterExpression": { "base": null, "refs": { "GetTraceSummariesRequest$FilterExpression": "Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.
" } }, "GetServiceGraphRequest": { "base": null, "refs": { } }, "GetServiceGraphResult": { "base": null, "refs": { } }, "GetTraceGraphRequest": { "base": null, "refs": { } }, "GetTraceGraphResult": { "base": null, "refs": { } }, "GetTraceSummariesRequest": { "base": null, "refs": { } }, "GetTraceSummariesResult": { "base": null, "refs": { } }, "Histogram": { "base": null, "refs": { "Edge$ResponseTimeHistogram": "A histogram that maps the spread of client response times on an edge.
", "Service$DurationHistogram": "A histogram that maps the spread of service durations.
", "Service$ResponseTimeHistogram": "A histogram that maps the spread of service response times.
" } }, "HistogramEntry": { "base": "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.
", "refs": { "Histogram$member": null } }, "Hostname": { "base": null, "refs": { "PutTelemetryRecordsRequest$Hostname": "" } }, "Http": { "base": "Information about an HTTP request.
", "refs": { "TraceSummary$Http": "Information about the HTTP request served by the trace.
" } }, "Integer": { "base": null, "refs": { "HistogramEntry$Count": "The prevalence of the entry.
" } }, "InvalidRequestException": { "base": "The request is missing required parameters or has invalid parameters.
", "refs": { } }, "NullableBoolean": { "base": null, "refs": { "AnnotationValue$BooleanValue": "Value for a Boolean annotation.
", "GetTraceSummariesRequest$Sampling": "Set to true
to get summaries for only a subset of available traces.
Indicates that the service was the first service to process a request.
", "TraceSummary$HasFault": "One or more of the segment documents has a 500 series error.
", "TraceSummary$HasError": "One or more of the segment documents has a 400 series error.
", "TraceSummary$HasThrottle": "One or more of the segment documents has a 429 throttling error.
", "TraceSummary$IsPartial": "One or more of the segment documents is in progress.
" } }, "NullableDouble": { "base": null, "refs": { "AnnotationValue$NumberValue": "Value for a Number annotation.
", "EdgeStatistics$TotalResponseTime": "The aggregate response time of completed requests.
", "ServiceStatistics$TotalResponseTime": "The aggregate response time of completed requests.
", "Trace$Duration": "The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.
", "TraceSummary$Duration": "The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.
", "TraceSummary$ResponseTime": "The length of time in seconds between the start and end times of the root segment. If the service performs work asynchronously, the response time measures the time before the response is sent to the user, while the duration measures the amount of time before the last traced activity completes.
" } }, "NullableInteger": { "base": null, "refs": { "BackendConnectionErrors$TimeoutCount": "", "BackendConnectionErrors$ConnectionRefusedCount": "", "BackendConnectionErrors$HTTPCode4XXCount": "", "BackendConnectionErrors$HTTPCode5XXCount": "", "BackendConnectionErrors$UnknownHostCount": "", "BackendConnectionErrors$OtherCount": "", "Edge$ReferenceId": "Identifier of the edge. Unique within a service map.
", "Http$HttpStatus": "The response status.
", "Service$ReferenceId": "Identifier for the service. Unique within the service map.
", "TelemetryRecord$SegmentsReceivedCount": "", "TelemetryRecord$SegmentsSentCount": "", "TelemetryRecord$SegmentsSpilloverCount": "", "TelemetryRecord$SegmentsRejectedCount": "" } }, "NullableLong": { "base": null, "refs": { "EdgeStatistics$OkCount": "The number of requests that completed with a 2xx Success status code.
", "EdgeStatistics$TotalCount": "The total number of completed requests.
", "ErrorStatistics$ThrottleCount": "The number of requests that failed with a 419 throttling status code.
", "ErrorStatistics$OtherCount": "The number of requests that failed with untracked 4xx Client Error status codes.
", "ErrorStatistics$TotalCount": "The total number of requests that failed with a 4xx Client Error status code.
", "FaultStatistics$OtherCount": "The number of requests that failed with untracked 5xx Server Error status codes.
", "FaultStatistics$TotalCount": "The total number of requests that failed with a 5xx Server Error status code.
", "GetTraceSummariesResult$TracesProcessedCount": "The number of traces that were processed to get this set of summaries.
", "ServiceStatistics$OkCount": "The number of requests that completed with a 2xx Success status code.
", "ServiceStatistics$TotalCount": "The total number of completed requests.
" } }, "PutTelemetryRecordsRequest": { "base": null, "refs": { } }, "PutTelemetryRecordsResult": { "base": null, "refs": { } }, "PutTraceSegmentsRequest": { "base": null, "refs": { } }, "PutTraceSegmentsResult": { "base": null, "refs": { } }, "ResourceARN": { "base": null, "refs": { "PutTelemetryRecordsRequest$ResourceARN": "" } }, "Segment": { "base": "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.
The segment document
" } }, "SegmentId": { "base": null, "refs": { "Segment$Id": "The segment's ID.
" } }, "SegmentList": { "base": null, "refs": { "Trace$Segments": "Segment documents for the segments and subsegments that comprise the trace.
" } }, "Service": { "base": "Information about an application that processed requests, users that made requests, or downstream services, resources and applications that an application used.
", "refs": { "ServiceList$member": null } }, "ServiceId": { "base": "", "refs": { "ServiceIds$member": null } }, "ServiceIds": { "base": null, "refs": { "TraceSummary$ServiceIds": "Service IDs from the trace's segment documents.
", "TraceUser$ServiceIds": "Services that the user's request hit.
", "ValueWithServiceIds$ServiceIds": "Services to which the annotation applies.
" } }, "ServiceList": { "base": null, "refs": { "GetServiceGraphResult$Services": "The services that have processed a traced request during the specified time frame.
", "GetTraceGraphResult$Services": "The services that have processed one of the specified requests.
" } }, "ServiceNames": { "base": null, "refs": { "Service$Names": "A list of names for the service, including the canonical name.
", "ServiceId$Names": "" } }, "ServiceStatistics": { "base": "Response statistics for a service.
", "refs": { "Service$SummaryStatistics": "Aggregated statistics for the service.
" } }, "String": { "base": null, "refs": { "Alias$Name": "The canonical name of the alias.
", "Alias$Type": "The type of the alias.
", "AliasNames$member": null, "AnnotationValue$StringValue": "Value for a String annotation.
", "BatchGetTracesRequest$NextToken": "Pagination token. Not used.
", "BatchGetTracesResult$NextToken": "Pagination token. Not used.
", "GetServiceGraphRequest$NextToken": "Pagination token. Not used.
", "GetServiceGraphResult$NextToken": "Pagination token. Not used.
", "GetTraceGraphRequest$NextToken": "Pagination token. Not used.
", "GetTraceGraphResult$NextToken": "Pagination token. Not used.
", "GetTraceSummariesRequest$NextToken": "Specify the pagination token returned by a previous request to retrieve the next page of results.
", "GetTraceSummariesResult$NextToken": "If the requested time frame contained more than one page of results, you can use this token to retrieve the next page. The first page contains the most most recent results, closest to the end of the time frame.
", "Http$HttpURL": "The request URL.
", "Http$HttpMethod": "The request method.
", "Http$UserAgent": "The request's user agent string.
", "Http$ClientIp": "The IP address of the requestor.
", "Service$Name": "The canonical name of the service.
", "Service$AccountId": "Identifier of the AWS account in which the service runs.
", "Service$Type": "The type of service.
AWS Resource - The type of an AWS resource. For example, AWS::EC2::Instance
for a application running on Amazon EC2 or AWS::DynamoDB::Table
for an Amazon DynamoDB table that the application used.
AWS Service - The type of an AWS service. For example, AWS::DynamoDB
for downstream calls to Amazon DynamoDB that didn't target a specific table.
client
- Represents the clients that sent requests to a root service.
remote
- A downstream service of indeterminate type.
The service's state.
", "ServiceId$Name": "", "ServiceId$AccountId": "", "ServiceId$Type": "", "ServiceNames$member": null, "TraceUser$UserName": "The user's name.
", "UnprocessedTraceSegment$Id": "The segment's ID.
", "UnprocessedTraceSegment$ErrorCode": "The error that caused processing to fail.
", "UnprocessedTraceSegment$Message": "The error message.
" } }, "TelemetryRecord": { "base": "", "refs": { "TelemetryRecordList$member": null } }, "TelemetryRecordList": { "base": null, "refs": { "PutTelemetryRecordsRequest$TelemetryRecords": "" } }, "ThrottledException": { "base": "The request exceeds the maximum number of requests per second.
", "refs": { } }, "Timestamp": { "base": null, "refs": { "Edge$StartTime": "The start time of the first segment on the edge.
", "Edge$EndTime": "The end time of the last segment on the edge.
", "GetServiceGraphRequest$StartTime": "The start of the time frame for which to generate a graph.
", "GetServiceGraphRequest$EndTime": "The end of the time frame for which to generate a graph.
", "GetServiceGraphResult$StartTime": "The start of the time frame for which the graph was generated.
", "GetServiceGraphResult$EndTime": "The end of the time frame for which the graph was generated.
", "GetTraceSummariesRequest$StartTime": "The start of the time frame for which to retrieve traces.
", "GetTraceSummariesRequest$EndTime": "The end of the time frame for which to retrieve traces.
", "GetTraceSummariesResult$ApproximateTime": "The start time of this page of results.
", "Service$StartTime": "The start time of the first segment that the service generated.
", "Service$EndTime": "The end time of the last segment that the service generated.
", "TelemetryRecord$Timestamp": "" } }, "Trace": { "base": "A collection of segment documents with matching trace IDs.
", "refs": { "TraceList$member": null } }, "TraceId": { "base": null, "refs": { "Trace$Id": "The unique identifier for the request that generated the trace's segments and subsegments.
", "TraceIdList$member": null, "TraceSummary$Id": "The unique identifier for the request that generated the trace's segments and subsegments.
", "UnprocessedTraceIdList$member": null } }, "TraceIdList": { "base": null, "refs": { "BatchGetTracesRequest$TraceIds": "Specify the trace IDs of requests for which to retrieve segments.
", "GetTraceGraphRequest$TraceIds": "Trace IDs of requests for which to generate a service graph.
" } }, "TraceList": { "base": null, "refs": { "BatchGetTracesResult$Traces": "Full traces for the specified requests.
" } }, "TraceSegmentDocument": { "base": null, "refs": { "TraceSegmentDocumentList$member": null } }, "TraceSegmentDocumentList": { "base": null, "refs": { "PutTraceSegmentsRequest$TraceSegmentDocuments": "A string containing a JSON document defining one or more segments or subsegments.
" } }, "TraceSummary": { "base": "Metadata generated from the segment documents in a trace.
", "refs": { "TraceSummaryList$member": null } }, "TraceSummaryList": { "base": null, "refs": { "GetTraceSummariesResult$TraceSummaries": "Trace IDs and metadata for traces that were found in the specified time frame.
" } }, "TraceUser": { "base": "Information about a user recorded in segment documents.
", "refs": { "TraceUsers$member": null } }, "TraceUsers": { "base": null, "refs": { "TraceSummary$Users": "Users from the trace's segment documents.
" } }, "UnprocessedTraceIdList": { "base": null, "refs": { "BatchGetTracesResult$UnprocessedTraceIds": "Trace IDs of requests that haven't been processed.
" } }, "UnprocessedTraceSegment": { "base": "Information about a segment that failed processing.
", "refs": { "UnprocessedTraceSegmentList$member": null } }, "UnprocessedTraceSegmentList": { "base": null, "refs": { "PutTraceSegmentsResult$UnprocessedTraceSegments": "Segments that failed processing.
" } }, "ValueWithServiceIds": { "base": "Information about a segment annotation.
", "refs": { "ValuesWithServiceIds$member": null } }, "ValuesWithServiceIds": { "base": null, "refs": { "Annotations$value": null } } } }