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

Description

Synopsis

data TraceSummary = TraceSummary' {
- annotations :: Maybe (HashMap Text [ValueWithServiceIds])
- hasThrottle :: Maybe Bool
- users :: Maybe [TraceUser]
- entryPoint :: Maybe ServiceId
- hasFault :: Maybe Bool
- serviceIds :: Maybe [ServiceId]
- matchedEventTime :: Maybe POSIX
- isPartial :: Maybe Bool
- errorRootCauses :: Maybe [ErrorRootCause]
- resourceARNs :: Maybe [ResourceARNDetail]
- availabilityZones :: Maybe [AvailabilityZoneDetail]
- instanceIds :: Maybe [InstanceIdDetail]
- responseTimeRootCauses :: Maybe [ResponseTimeRootCause]
- hasError :: Maybe Bool
- id :: Maybe Text
- http :: Maybe Http
- revision :: Maybe Int
- duration :: Maybe Double
- faultRootCauses :: Maybe [FaultRootCause]
- responseTime :: Maybe Double
}
newTraceSummary :: TraceSummary
traceSummary_annotations :: Lens' TraceSummary (Maybe (HashMap Text [ValueWithServiceIds]))
traceSummary_hasThrottle :: Lens' TraceSummary (Maybe Bool)
traceSummary_users :: Lens' TraceSummary (Maybe [TraceUser])
traceSummary_entryPoint :: Lens' TraceSummary (Maybe ServiceId)
traceSummary_hasFault :: Lens' TraceSummary (Maybe Bool)
traceSummary_serviceIds :: Lens' TraceSummary (Maybe [ServiceId])
traceSummary_matchedEventTime :: Lens' TraceSummary (Maybe UTCTime)
traceSummary_isPartial :: Lens' TraceSummary (Maybe Bool)
traceSummary_errorRootCauses :: Lens' TraceSummary (Maybe [ErrorRootCause])
traceSummary_resourceARNs :: Lens' TraceSummary (Maybe [ResourceARNDetail])
traceSummary_availabilityZones :: Lens' TraceSummary (Maybe [AvailabilityZoneDetail])
traceSummary_instanceIds :: Lens' TraceSummary (Maybe [InstanceIdDetail])
traceSummary_responseTimeRootCauses :: Lens' TraceSummary (Maybe [ResponseTimeRootCause])
traceSummary_hasError :: Lens' TraceSummary (Maybe Bool)
traceSummary_id :: Lens' TraceSummary (Maybe Text)
traceSummary_http :: Lens' TraceSummary (Maybe Http)
traceSummary_revision :: Lens' TraceSummary (Maybe Int)
traceSummary_duration :: Lens' TraceSummary (Maybe Double)
traceSummary_faultRootCauses :: Lens' TraceSummary (Maybe [FaultRootCause])
traceSummary_responseTime :: Lens' TraceSummary (Maybe Double)

Documentation

data TraceSummary Source #

Metadata generated from the segment documents in a trace.

See: newTraceSummary smart constructor.

Constructors

TraceSummary'

Fields

annotations :: Maybe (HashMap Text [ValueWithServiceIds])
Annotations from the trace's segment documents.
hasThrottle :: Maybe Bool
One or more of the segment documents has a 429 throttling error.
users :: Maybe [TraceUser]
Users from the trace's segment documents.
entryPoint :: Maybe ServiceId
The root of a trace.
hasFault :: Maybe Bool
The root segment document has a 500 series error.
serviceIds :: Maybe [ServiceId]
Service IDs from the trace's segment documents.
matchedEventTime :: Maybe POSIX
The matched time stamp of a defined event.
isPartial :: Maybe Bool
One or more of the segment documents is in progress.
errorRootCauses :: Maybe [ErrorRootCause]
A collection of ErrorRootCause structures corresponding to the trace segments.
resourceARNs :: Maybe [ResourceARNDetail]
A list of resource ARNs for any resource corresponding to the trace segments.
availabilityZones :: Maybe [AvailabilityZoneDetail]
A list of Availability Zones for any zone corresponding to the trace segments.
instanceIds :: Maybe [InstanceIdDetail]
A list of EC2 instance IDs for any instance corresponding to the trace segments.
responseTimeRootCauses :: Maybe [ResponseTimeRootCause]
A collection of ResponseTimeRootCause structures corresponding to the trace segments.
hasError :: Maybe Bool
The root segment document has a 400 series error.
id :: Maybe Text
The unique identifier for the request that generated the trace's segments and subsegments.
http :: Maybe Http
Information about the HTTP request served by the trace.
revision :: Maybe Int
The revision number of a trace.
duration :: Maybe Double
The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.
faultRootCauses :: Maybe [FaultRootCause]
A collection of FaultRootCause structures corresponding to the trace segments.
responseTime :: Maybe Double
The length of time in seconds between the start and end times of the root segment. If the service performs work asynchronously, the response time measures the time before the response is sent to the user, while the duration measures the amount of time before the last traced activity completes.

Instances

Instances details

Eq TraceSummary Source #
Instance details Defined in Amazonka.XRay.Types.TraceSummary Methods (==) :: TraceSummary -> TraceSummary -> Bool # (/=) :: TraceSummary -> TraceSummary -> Bool #
Read TraceSummary Source #
Instance details Defined in Amazonka.XRay.Types.TraceSummary Methods readsPrec :: Int -> ReadS TraceSummary # readList :: ReadS [TraceSummary] # readPrec :: ReadPrec TraceSummary # readListPrec :: ReadPrec [TraceSummary] #
Show TraceSummary Source #
Instance details Defined in Amazonka.XRay.Types.TraceSummary Methods showsPrec :: Int -> TraceSummary -> ShowS # show :: TraceSummary -> String # showList :: [TraceSummary] -> ShowS #
Generic TraceSummary Source #
Instance details Defined in Amazonka.XRay.Types.TraceSummary Associated Types type Rep TraceSummary :: Type -> Type # Methods from :: TraceSummary -> Rep TraceSummary x # to :: Rep TraceSummary x -> TraceSummary #
NFData TraceSummary Source #
Instance details Defined in Amazonka.XRay.Types.TraceSummary Methods rnf :: TraceSummary -> () #
Hashable TraceSummary Source #
Instance details Defined in Amazonka.XRay.Types.TraceSummary Methods hashWithSalt :: Int -> TraceSummary -> Int # hash :: TraceSummary -> Int #
FromJSON TraceSummary Source #
Instance details Defined in Amazonka.XRay.Types.TraceSummary Methods parseJSON :: Value -> Parser TraceSummary # parseJSONList :: Value -> Parser [TraceSummary] #
type Rep TraceSummary Source #
Instance details Defined in Amazonka.XRay.Types.TraceSummary type Rep TraceSummary = D1 ('MetaData "TraceSummary" "Amazonka.XRay.Types.TraceSummary" "libZSservicesZSamazonka-xrayZSamazonka-xray" 'False) (C1 ('MetaCons "TraceSummary'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "annotations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [ValueWithServiceIds]))) :: S1 ('MetaSel ('Just "hasThrottle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TraceUser])) :: (S1 ('MetaSel ('Just "entryPoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceId)) :: S1 ('MetaSel ('Just "hasFault") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "serviceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ServiceId])) :: S1 ('MetaSel ('Just "matchedEventTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "isPartial") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "errorRootCauses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ErrorRootCause])) :: S1 ('MetaSel ('Just "resourceARNs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceARNDetail])))))) :: (((S1 ('MetaSel ('Just "availabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AvailabilityZoneDetail])) :: S1 ('MetaSel ('Just "instanceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InstanceIdDetail]))) :: (S1 ('MetaSel ('Just "responseTimeRootCauses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResponseTimeRootCause])) :: (S1 ('MetaSel ('Just "hasError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "http") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Http)) :: S1 ('MetaSel ('Just "revision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: (S1 ('MetaSel ('Just "faultRootCauses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FaultRootCause])) :*: S1 ('MetaSel ('Just "responseTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))))))

newTraceSummary :: TraceSummary Source #

Create a value of TraceSummary 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:annotations:TraceSummary', traceSummary_annotations - Annotations from the trace's segment documents.

$sel:hasThrottle:TraceSummary', traceSummary_hasThrottle - One or more of the segment documents has a 429 throttling error.

$sel:users:TraceSummary', traceSummary_users - Users from the trace's segment documents.

$sel:entryPoint:TraceSummary', traceSummary_entryPoint - The root of a trace.

$sel:hasFault:TraceSummary', traceSummary_hasFault - The root segment document has a 500 series error.

$sel:serviceIds:TraceSummary', traceSummary_serviceIds - Service IDs from the trace's segment documents.

$sel:matchedEventTime:TraceSummary', traceSummary_matchedEventTime - The matched time stamp of a defined event.

$sel:isPartial:TraceSummary', traceSummary_isPartial - One or more of the segment documents is in progress.

$sel:errorRootCauses:TraceSummary', traceSummary_errorRootCauses - A collection of ErrorRootCause structures corresponding to the trace segments.

$sel:resourceARNs:TraceSummary', traceSummary_resourceARNs - A list of resource ARNs for any resource corresponding to the trace segments.

$sel:availabilityZones:TraceSummary', traceSummary_availabilityZones - A list of Availability Zones for any zone corresponding to the trace segments.

$sel:instanceIds:TraceSummary', traceSummary_instanceIds - A list of EC2 instance IDs for any instance corresponding to the trace segments.

$sel:responseTimeRootCauses:TraceSummary', traceSummary_responseTimeRootCauses - A collection of ResponseTimeRootCause structures corresponding to the trace segments.

$sel:hasError:TraceSummary', traceSummary_hasError - The root segment document has a 400 series error.

$sel:id:TraceSummary', traceSummary_id - The unique identifier for the request that generated the trace's segments and subsegments.

$sel:http:TraceSummary', traceSummary_http - Information about the HTTP request served by the trace.

$sel:revision:TraceSummary', traceSummary_revision - The revision number of a trace.

$sel:duration:TraceSummary', traceSummary_duration - The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.

$sel:faultRootCauses:TraceSummary', traceSummary_faultRootCauses - A collection of FaultRootCause structures corresponding to the trace segments.

$sel:responseTime:TraceSummary', traceSummary_responseTime - The length of time in seconds between the start and end times of the root segment. If the service performs work asynchronously, the response time measures the time before the response is sent to the user, while the duration measures the amount of time before the last traced activity completes.

traceSummary_annotations :: Lens' TraceSummary (Maybe (HashMap Text [ValueWithServiceIds])) Source #

Annotations from the trace's segment documents.

traceSummary_hasThrottle :: Lens' TraceSummary (Maybe Bool) Source #

One or more of the segment documents has a 429 throttling error.

traceSummary_users :: Lens' TraceSummary (Maybe [TraceUser]) Source #

Users from the trace's segment documents.

traceSummary_entryPoint :: Lens' TraceSummary (Maybe ServiceId) Source #

The root of a trace.

traceSummary_hasFault :: Lens' TraceSummary (Maybe Bool) Source #

The root segment document has a 500 series error.

traceSummary_serviceIds :: Lens' TraceSummary (Maybe [ServiceId]) Source #

Service IDs from the trace's segment documents.

traceSummary_matchedEventTime :: Lens' TraceSummary (Maybe UTCTime) Source #

The matched time stamp of a defined event.

traceSummary_isPartial :: Lens' TraceSummary (Maybe Bool) Source #

One or more of the segment documents is in progress.

traceSummary_errorRootCauses :: Lens' TraceSummary (Maybe [ErrorRootCause]) Source #

A collection of ErrorRootCause structures corresponding to the trace segments.

traceSummary_resourceARNs :: Lens' TraceSummary (Maybe [ResourceARNDetail]) Source #

A list of resource ARNs for any resource corresponding to the trace segments.

traceSummary_availabilityZones :: Lens' TraceSummary (Maybe [AvailabilityZoneDetail]) Source #

A list of Availability Zones for any zone corresponding to the trace segments.

traceSummary_instanceIds :: Lens' TraceSummary (Maybe [InstanceIdDetail]) Source #

A list of EC2 instance IDs for any instance corresponding to the trace segments.

traceSummary_responseTimeRootCauses :: Lens' TraceSummary (Maybe [ResponseTimeRootCause]) Source #

A collection of ResponseTimeRootCause structures corresponding to the trace segments.

traceSummary_hasError :: Lens' TraceSummary (Maybe Bool) Source #

The root segment document has a 400 series error.

traceSummary_id :: Lens' TraceSummary (Maybe Text) Source #

The unique identifier for the request that generated the trace's segments and subsegments.

traceSummary_http :: Lens' TraceSummary (Maybe Http) Source #

Information about the HTTP request served by the trace.

traceSummary_revision :: Lens' TraceSummary (Maybe Int) Source #

The revision number of a trace.

traceSummary_duration :: Lens' TraceSummary (Maybe Double) Source #

The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.

traceSummary_faultRootCauses :: Lens' TraceSummary (Maybe [FaultRootCause]) Source #

A collection of FaultRootCause structures corresponding to the trace segments.

traceSummary_responseTime :: Lens' TraceSummary (Maybe Double) Source #

The length of time in seconds between the start and end times of the root segment. If the service performs work asynchronously, the response time measures the time before the response is sent to the user, while the duration measures the amount of time before the last traced activity completes.