Insight

When fault rates go outside of the expected range, X-Ray creates an insight. Insights tracks emergent issues within your applications.

Categories

The categories that label and describe the type of insight.

Type: Array of strings

Valid Values: FAULT

Required: No

ClientRequestImpactStatistics

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.

Type: RequestImpactStatistics object

Required: No

EndTime

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

Type: Timestamp

Required: No

GroupARN

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

Type: String

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

Required: No

GroupName

The name of the group that the insight belongs to.

Type: String

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

Required: No

InsightId

The insights unique identifier.

Type: String

Pattern: [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}

Required: No

RootCauseServiceId

Type: ServiceId object

Required: No

RootCauseServiceRequestImpactStatistics

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.

Type: RequestImpactStatistics object

Required: No

StartTime

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

Type: Timestamp

Required: No

State

The current state of the insight.

Type: String

Valid Values: ACTIVE | CLOSED

Required: No

Summary

A brief description of the insight.

Type: String

Required: No

TopAnomalousServices

The service within the insight that is most impacted by the incident.

Type: Array of AnomalousService objects

Required: No

Insight

Contents

See Also