insights
Creates, updates, deletes, gets or lists an insights resource.
Overview
| Name | insights |
| Type | Resource |
| Id | aws.xray.insights |
Fields
The following fields are returned by SELECT queries:
- get_insight
| Name | Datatype | Description |
|---|---|---|
categories | array | The categories that label and describe the type of insight. |
client_request_impact_statistics | object | The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay. |
end_time | string (date-time) | The time, in Unix seconds, at which the insight ended. |
group_arn | string | The Amazon Resource Name (ARN) of the group that the insight belongs to. |
group_name | string | The name of the group that the insight belongs to. |
insight_id | string | The insights unique identifier. (pattern: <code>[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}</code>) |
root_cause_service_id | object | |
root_cause_service_request_impact_statistics | object | The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay. |
start_time | string (date-time) | The time, in Unix seconds, at which the insight began. |
state | string | The current state of the insight. (ACTIVE, CLOSED) |
summary | string | A brief description of the insight. |
top_anomalous_services | array | The service within the insight that is most impacted by the incident. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_insight | select | region | Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight. |
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_insight
Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.
SELECT
categories,
client_request_impact_statistics,
end_time,
group_arn,
group_name,
insight_id,
root_cause_service_id,
root_cause_service_request_impact_statistics,
start_time,
state,
summary,
top_anomalous_services
FROM aws.xray.insights
WHERE region = '{{ region }}' -- required
;