AWS X-Ray
API Reference (API Version 2016-04-12)

TraceSummary

Metadata generated from the segment documents in a trace.

Contents

Annotations

Annotations from the trace's segment documents.

Type: String to array of ValueWithServiceIds objects map

Required: No

AvailabilityZones

A list of availability zones for any zone corresponding to the trace segments.

Type: Array of AvailabilityZoneDetail objects

Required: No

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.

Type: Double

Required: No

EntryPoint

The root of a trace.

Type: ServiceId object

Required: No

ErrorRootCauses

A collection of ErrorRootCause structures corresponding to the trace segments.

Type: Array of ErrorRootCause objects

Required: No

FaultRootCauses

A collection of FaultRootCause structures corresponding to the the trace segments.

Type: Array of FaultRootCause objects

Required: No

HasError

One or more of the segment documents has a 400 series error.

Type: Boolean

Required: No

HasFault

One or more of the segment documents has a 500 series error.

Type: Boolean

Required: No

HasThrottle

One or more of the segment documents has a 429 throttling error.

Type: Boolean

Required: No

Http

Information about the HTTP request served by the trace.

Type: Http object

Required: No

Id

The unique identifier for the request that generated the trace's segments and subsegments.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 35.

Required: No

InstanceIds

A list of EC2 instance IDs for any instance corresponding to the trace segments.

Type: Array of InstanceIdDetail objects

Required: No

IsPartial

One or more of the segment documents is in progress.

Type: Boolean

Required: No

ResourceARNs

A list of resource ARNs for any resource corresponding to the trace segments.

Type: Array of ResourceARNDetail objects

Required: No

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.

Type: Double

Required: No

ResponseTimeRootCauses

A collection of ResponseTimeRootCause structures corresponding to the trace segments.

Type: Array of ResponseTimeRootCause objects

Required: No

Revision

The revision number of a trace.

Type: Integer

Required: No

ServiceIds

Service IDs from the trace's segment documents.

Type: Array of ServiceId objects

Required: No

Users

Users from the trace's segment documents.

Type: Array of TraceUser objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: