Skip to content
AWS for Query.Farm

aws.xray.get_insight

Example SQL Queries

SELECT * FROM
aws.xray.get_insight
WHERE
"insight_id" = 'VALUE';

Description

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.

Table Definition

Column NameColumn Data Type
insight_id Required Input Column

The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
insight

The summary information of an insight.

STRUCT(
    "insight_id" VARCHAR,
    "group_arn" VARCHAR,
    "group_name" VARCHAR,
    "root_cause_service_id" STRUCT(
        "name" VARCHAR,
        "names" VARCHAR[],
        "account_id" VARCHAR,
        "type" VARCHAR
    ),
    "categories" VARCHAR[],
    "state" VARCHAR,
    "start_time" TIMESTAMP_S,
    "end_time" TIMESTAMP_S,
    "summary" VARCHAR,
    "client_request_impact_statistics" STRUCT(
        "fault_count" BIGINT,
        "ok_count" BIGINT,
        "total_count" BIGINT
    ),
    "root_cause_service_request_impact_statistics" STRUCT(
        "fault_count" BIGINT,
        "ok_count" BIGINT,
        "total_count" BIGINT
    ),
    "top_anomalous_services" STRUCT(
        "service_id" STRUCT(
            "name" VARCHAR,
            "names" VARCHAR[],
            "account_id" VARCHAR,
            "type" VARCHAR
        )
    )[]
)
Show child fields
insight.categories[]
insight.client_request_impact_statistics

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.

Show child fields
insight.client_request_impact_statistics.fault_count

The number of requests that have resulted in a fault,

insight.client_request_impact_statistics.ok_count

The number of successful requests.

insight.client_request_impact_statistics.total_count

The total number of requests to the service.

insight.end_time

The time, in Unix seconds, at which the insight ended.

insight.group_arn

The Amazon Resource Name (ARN) of the group that the insight belongs to.

insight.group_name

The name of the group that the insight belongs to.

insight.insight_id

The insights unique identifier.

insight.root_cause_service_id

Show child fields
insight.root_cause_service_id.account_id

insight.root_cause_service_id.name

insight.root_cause_service_id.names[]
insight.root_cause_service_id.type

insight.root_cause_service_request_impact_statistics

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.

Show child fields
insight.root_cause_service_request_impact_statistics.fault_count

The number of requests that have resulted in a fault,

insight.root_cause_service_request_impact_statistics.ok_count

The number of successful requests.

insight.root_cause_service_request_impact_statistics.total_count

The total number of requests to the service.

insight.start_time

The time, in Unix seconds, at which the insight began.

insight.state

The current state of the insight.

insight.summary

A brief description of the insight.

insight.top_anomalous_services[]
Show child fields
insight.top_anomalous_services[].service_id

Show child fields
insight.top_anomalous_services[].service_id.account_id

insight.top_anomalous_services[].service_id.name

insight.top_anomalous_services[].service_id.names[]
insight.top_anomalous_services[].service_id.type