trace_summaries
Creates, updates, deletes, gets or lists a trace_summaries resource.
Overview
| Name | trace_summaries |
| Type | Resource |
| Id | aws.xray.trace_summaries |
Fields
The following fields are returned by SELECT queries:
- get_trace_summaries
| Name | Datatype | Description |
|---|---|---|
annotations | object | Annotations from the trace's segment documents. |
availability_zones | array | A list of Availability Zones for any zone corresponding to the trace segments. |
duration | number (double) | The length of time in seconds between the start time of the earliest segment that started and the end time of the last segment that completed. |
entry_point | object | The root of a trace. |
error_root_causes | array | A collection of ErrorRootCause structures corresponding to the trace segments. |
fault_root_causes | array | A collection of FaultRootCause structures corresponding to the trace segments. |
has_error | boolean | The root segment document has a 400 series error. |
has_fault | boolean | The root segment document has a 500 series error. |
has_throttle | boolean | One or more of the segment documents has a 429 throttling error. |
http | object | Information about the HTTP request served by the trace. |
id | string | The unique identifier for the request that generated the trace's segments and subsegments. |
instance_ids | array | A list of EC2 instance IDs for any instance corresponding to the trace segments. |
is_partial | boolean | One or more of the segment documents is in progress. |
matched_event_time | string (date-time) | The matched time stamp of a defined event. |
resource_arns | array | A list of resource ARNs for any resource corresponding to the trace segments. |
response_time | number (double) | 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. |
response_time_root_causes | array | A collection of ResponseTimeRootCause structures corresponding to the trace segments. |
revision | integer | The revision number of a trace. |
service_ids | array | Service IDs from the trace's segment documents. |
start_time | string (date-time) | The start time of a trace, based on the earliest trace segment start time. |
users | array | Users from the trace's segment documents. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_trace_summaries | select | region | 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. 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 Use filter expressions in the Amazon Web Services X-Ray Developer Guide. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_trace_summaries
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. 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 Use filter expressions in the Amazon Web Services X-Ray Developer Guide.
SELECT
annotations,
availability_zones,
duration,
entry_point,
error_root_causes,
fault_root_causes,
has_error,
has_fault,
has_throttle,
http,
id,
instance_ids,
is_partial,
matched_event_time,
resource_arns,
response_time,
response_time_root_causes,
revision,
service_ids,
start_time,
users
FROM aws.xray.trace_summaries
WHERE region = '{{ region }}' -- required
;