Amazonka.XRay.Types.Insight

Documentation

data Insight

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

See: newInsight smart constructor.

Constructors

Insight'

Fields

• categories :: Maybe [InsightCategory]

  The categories that label and describe the type of insight.

• clientRequestImpactStatistics :: Maybe RequestImpactStatistics

  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.

• endTime :: Maybe POSIX

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

• groupARN :: Maybe Text

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

• groupName :: Maybe Text

  The name of the group that the insight belongs to.

• insightId :: Maybe Text

  The insights unique identifier.

• rootCauseServiceId :: Maybe ServiceId
• rootCauseServiceRequestImpactStatistics :: Maybe RequestImpactStatistics

  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.

• startTime :: Maybe POSIX

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

• state :: Maybe InsightState

  The current state of the insight.

• summary :: Maybe Text

  A brief description of the insight.

• topAnomalousServices :: Maybe [AnomalousService]

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

Instances

FromJSON Insight

Defined in Amazonka.XRay.Types.Insight

Methods

parseJSON :: Value -> Parser Insight

parseJSONList :: Value -> Parser [Insight]

Generic Insight

Defined in Amazonka.XRay.Types.Insight

Associated Types

type Rep Insight :: Type -> Type

Methods

from :: Insight -> Rep Insight x

to :: Rep Insight x -> Insight

Read Insight

Defined in Amazonka.XRay.Types.Insight

Methods

readsPrec :: Int -> ReadS Insight

readList :: ReadS [Insight]

readPrec :: ReadPrec Insight

readListPrec :: ReadPrec [Insight]

Show Insight

Defined in Amazonka.XRay.Types.Insight

Methods

showsPrec :: Int -> Insight -> ShowS

show :: Insight -> String

showList :: [Insight] -> ShowS

NFData Insight

Defined in Amazonka.XRay.Types.Insight

Methods

rnf :: Insight -> ()

Eq Insight

Defined in Amazonka.XRay.Types.Insight

Methods

(==) :: Insight -> Insight -> Bool

(/=) :: Insight -> Insight -> Bool

Hashable Insight

Defined in Amazonka.XRay.Types.Insight

Methods

hashWithSalt :: Int -> Insight -> Int

hash :: Insight -> Int

type Rep Insight

Defined in Amazonka.XRay.Types.Insight

type Rep Insight = D1 ('MetaData "Insight" "Amazonka.XRay.Types.Insight" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "Insight'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "categories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InsightCategory])) :*: (S1 ('MetaSel ('Just "clientRequestImpactStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestImpactStatistics)) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "groupARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "insightId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "rootCauseServiceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceId)) :*: (S1 ('MetaSel ('Just "rootCauseServiceRequestImpactStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestImpactStatistics)) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InsightState)) :*: (S1 ('MetaSel ('Just "summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "topAnomalousServices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AnomalousService])))))))

newInsight :: Insight

Create a value of Insight with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:categories:Insight', insight_categories - The categories that label and describe the type of insight.

$sel:clientRequestImpactStatistics:Insight', insight_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.

$sel:endTime:Insight', insight_endTime - The time, in Unix seconds, at which the insight ended.

$sel:groupARN:Insight', insight_groupARN - The Amazon Resource Name (ARN) of the group that the insight belongs to.

$sel:groupName:Insight', insight_groupName - The name of the group that the insight belongs to.

$sel:insightId:Insight', insight_insightId - The insights unique identifier.

$sel:rootCauseServiceId:Insight', insight_rootCauseServiceId - Undocumented member.

$sel:rootCauseServiceRequestImpactStatistics:Insight', insight_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.

$sel:startTime:Insight', insight_startTime - The time, in Unix seconds, at which the insight began.

$sel:state:Insight', insight_state - The current state of the insight.

$sel:summary:Insight', insight_summary - A brief description of the insight.

$sel:topAnomalousServices:Insight', insight_topAnomalousServices - The service within the insight that is most impacted by the incident.

insight_categories :: Lens' Insight (Maybe [InsightCategory])

The categories that label and describe the type of insight.

insight_clientRequestImpactStatistics :: Lens' Insight (Maybe RequestImpactStatistics)

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.

insight_endTime :: Lens' Insight (Maybe UTCTime)

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

insight_groupARN :: Lens' Insight (Maybe Text)

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

insight_groupName :: Lens' Insight (Maybe Text)

The name of the group that the insight belongs to.

insight_insightId :: Lens' Insight (Maybe Text)

The insights unique identifier.

insight_rootCauseServiceId :: Lens' Insight (Maybe ServiceId)

Undocumented member.

insight_rootCauseServiceRequestImpactStatistics :: Lens' Insight (Maybe RequestImpactStatistics)

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.

insight_startTime :: Lens' Insight (Maybe UTCTime)

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

insight_state :: Lens' Insight (Maybe InsightState)

The current state of the insight.

insight_summary :: Lens' Insight (Maybe Text)

A brief description of the insight.

insight_topAnomalousServices :: Lens' Insight (Maybe [AnomalousService])

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