XRay / Client / get_insight_events

get_insight_events#

XRay.Client.get_insight_events(**kwargs)#

X-Ray reevaluates insights periodically until they’re resolved, and records each intermediate state as an event. You can review an insight’s events in the Impact Timeline on the Inspect page in the X-Ray console.

See also: AWS API Documentation

Request Syntax

response = client.get_insight_events(
    InsightId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • InsightId (string) –

    [REQUIRED]

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

  • MaxResults (integer) – Used to retrieve at most the specified value of events.

  • NextToken (string) – Specify the pagination token returned by a previous request to retrieve the next page of events.

Return type:

dict

Returns:

Response Syntax

{
    'InsightEvents': [
        {
            'Summary': 'string',
            'EventTime': datetime(2015, 1, 1),
            'ClientRequestImpactStatistics': {
                'FaultCount': 123,
                'OkCount': 123,
                'TotalCount': 123
            },
            'RootCauseServiceRequestImpactStatistics': {
                'FaultCount': 123,
                'OkCount': 123,
                'TotalCount': 123
            },
            'TopAnomalousServices': [
                {
                    'ServiceId': {
                        'Name': 'string',
                        'Names': [
                            'string',
                        ],
                        'AccountId': 'string',
                        'Type': 'string'
                    }
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • InsightEvents (list) –

      A detailed description of the event. This includes the time of the event, client and root cause impact statistics, and the top anomalous service at the time of the event.

      • (dict) –

        X-Ray reevaluates insights periodically until they are resolved, and records each intermediate state in an event. You can review incident events in the Impact Timeline on the Inspect page in the X-Ray console.

        • Summary (string) –

          A brief description of the event.

        • EventTime (datetime) –

          The time, in Unix seconds, at which the event was recorded.

        • ClientRequestImpactStatistics (dict) –

          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.

          • FaultCount (integer) –

            The number of requests that have resulted in a fault,

          • OkCount (integer) –

            The number of successful requests.

          • TotalCount (integer) –

            The total number of requests to the service.

        • RootCauseServiceRequestImpactStatistics (dict) –

          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.

          • FaultCount (integer) –

            The number of requests that have resulted in a fault,

          • OkCount (integer) –

            The number of successful requests.

          • TotalCount (integer) –

            The total number of requests to the service.

        • TopAnomalousServices (list) –

          The service during the event that is most impacted by the incident.

          • (dict) –

            The service within the service graph that has anomalously high fault rates.

            • ServiceId (dict) –

              • Name (string) –

              • Names (list) –

                • (string) –

              • AccountId (string) –

              • Type (string) –

    • NextToken (string) –

      Use this token to retrieve the next page of insight events.

Exceptions