Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.XRay.Types.Insight

Description

Synopsis

data Insight = Insight' {
- summary :: Maybe Text
- state :: Maybe InsightState
- startTime :: Maybe POSIX
- insightId :: Maybe Text
- categories :: Maybe [InsightCategory]
- rootCauseServiceRequestImpactStatistics :: Maybe RequestImpactStatistics
- topAnomalousServices :: Maybe [AnomalousService]
- rootCauseServiceId :: Maybe ServiceId
- clientRequestImpactStatistics :: Maybe RequestImpactStatistics
- endTime :: Maybe POSIX
- groupARN :: Maybe Text
- groupName :: Maybe Text
}
newInsight :: Insight
insight_summary :: Lens' Insight (Maybe Text)
insight_state :: Lens' Insight (Maybe InsightState)
insight_startTime :: Lens' Insight (Maybe UTCTime)
insight_insightId :: Lens' Insight (Maybe Text)
insight_categories :: Lens' Insight (Maybe [InsightCategory])
insight_rootCauseServiceRequestImpactStatistics :: Lens' Insight (Maybe RequestImpactStatistics)
insight_topAnomalousServices :: Lens' Insight (Maybe [AnomalousService])
insight_rootCauseServiceId :: Lens' Insight (Maybe ServiceId)
insight_clientRequestImpactStatistics :: Lens' Insight (Maybe RequestImpactStatistics)
insight_endTime :: Lens' Insight (Maybe UTCTime)
insight_groupARN :: Lens' Insight (Maybe Text)
insight_groupName :: Lens' Insight (Maybe Text)

Documentation

data Insight Source #

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

summary :: Maybe Text
A brief description of the insight.
state :: Maybe InsightState
The current state of the insight.
startTime :: Maybe POSIX
The time, in Unix seconds, at which the insight began.
insightId :: Maybe Text
The insights unique identifier.
categories :: Maybe [InsightCategory]
The categories that label and describe the type of insight.
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.
topAnomalousServices :: Maybe [AnomalousService]
The service within the insight that is most impacted by the incident.
rootCauseServiceId :: Maybe ServiceId
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.

Instances

Instances details

Eq Insight Source #
Instance details Defined in Amazonka.XRay.Types.Insight Methods (==) :: Insight -> Insight -> Bool # (/=) :: Insight -> Insight -> Bool #
Read Insight Source #
Instance details Defined in Amazonka.XRay.Types.Insight Methods readsPrec :: Int -> ReadS Insight # readList :: ReadS [Insight] # readPrec :: ReadPrec Insight # readListPrec :: ReadPrec [Insight] #
Show Insight Source #
Instance details Defined in Amazonka.XRay.Types.Insight Methods showsPrec :: Int -> Insight -> ShowS # show :: Insight -> String # showList :: [Insight] -> ShowS #
Generic Insight Source #
Instance details Defined in Amazonka.XRay.Types.Insight Associated Types type Rep Insight :: Type -> Type # Methods from :: Insight -> Rep Insight x # to :: Rep Insight x -> Insight #
NFData Insight Source #
Instance details Defined in Amazonka.XRay.Types.Insight Methods rnf :: Insight -> () #
Hashable Insight Source #
Instance details Defined in Amazonka.XRay.Types.Insight Methods hashWithSalt :: Int -> Insight -> Int # hash :: Insight -> Int #
FromJSON Insight Source #
Instance details Defined in Amazonka.XRay.Types.Insight Methods parseJSON :: Value -> Parser Insight # parseJSONList :: Value -> Parser [Insight] #
type Rep Insight Source #
Instance details Defined in Amazonka.XRay.Types.Insight type Rep Insight = D1 ('MetaData "Insight" "Amazonka.XRay.Types.Insight" "libZSservicesZSamazonka-xrayZSamazonka-xray" 'False) (C1 ('MetaCons "Insight'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InsightState)) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "insightId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "categories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InsightCategory])) :: S1 ('MetaSel ('Just "rootCauseServiceRequestImpactStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestImpactStatistics))))) :: ((S1 ('MetaSel ('Just "topAnomalousServices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AnomalousService])) :: (S1 ('MetaSel ('Just "rootCauseServiceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceId)) :: 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)))))))

newInsight :: Insight Source #

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:summary:Insight', insight_summary - A brief description of the insight.

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

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

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

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

$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:topAnomalousServices:Insight', insight_topAnomalousServices - The service within the insight that is most impacted by the incident.

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

$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.

insight_summary :: Lens' Insight (Maybe Text) Source #

A brief description of the insight.

insight_state :: Lens' Insight (Maybe InsightState) Source #

The current state of the insight.

insight_startTime :: Lens' Insight (Maybe UTCTime) Source #

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

insight_insightId :: Lens' Insight (Maybe Text) Source #

The insights unique identifier.

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

The categories that label and describe the type of insight.

insight_rootCauseServiceRequestImpactStatistics :: Lens' Insight (Maybe RequestImpactStatistics) Source #

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_topAnomalousServices :: Lens' Insight (Maybe [AnomalousService]) Source #

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

insight_rootCauseServiceId :: Lens' Insight (Maybe ServiceId) Source #

Undocumented member.

insight_clientRequestImpactStatistics :: Lens' Insight (Maybe RequestImpactStatistics) Source #

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) Source #

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

insight_groupARN :: Lens' Insight (Maybe Text) Source #

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

insight_groupName :: Lens' Insight (Maybe Text) Source #

The name of the group that the insight belongs to.