amazonka-xray-1.4.5: Amazon X-Ray SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.XRay.PutTraceSegments

Contents

Description

Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments.

Synopsis

Creating a Request

putTraceSegments :: PutTraceSegments Source #

Creates a value of PutTraceSegments with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ptsTraceSegmentDocuments - A JSON document defining one or more segments or subsegments. Segments must include the following fields. Required Segment Document Fields * name - The name of the service that handled the request. * id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits. * trace_id - A unique identifier that connects all segments and subsegments originating from a single client request. * start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9 . * end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9 . Specify either an end_time or in_progress . * in_progress - Set to true instead of specifying an end_time to record that a segment has been started, but is not complete. Send an in progress segment when your application receives a request that will take a long time to serve, to trace the fact that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment. A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes: Trace ID Format * The version number, i.e. 1 . * The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal. * A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.

data PutTraceSegments Source #

See: putTraceSegments smart constructor.

Instances

Eq PutTraceSegments Source # 
Data PutTraceSegments Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutTraceSegments -> c PutTraceSegments #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutTraceSegments #

toConstr :: PutTraceSegments -> Constr #

dataTypeOf :: PutTraceSegments -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PutTraceSegments) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutTraceSegments) #

gmapT :: (forall b. Data b => b -> b) -> PutTraceSegments -> PutTraceSegments #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutTraceSegments -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutTraceSegments -> r #

gmapQ :: (forall d. Data d => d -> u) -> PutTraceSegments -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutTraceSegments -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutTraceSegments -> m PutTraceSegments #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutTraceSegments -> m PutTraceSegments #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutTraceSegments -> m PutTraceSegments #

Read PutTraceSegments Source # 
Show PutTraceSegments Source # 
Generic PutTraceSegments Source # 
Hashable PutTraceSegments Source # 
ToJSON PutTraceSegments Source # 
NFData PutTraceSegments Source # 

Methods

rnf :: PutTraceSegments -> () #

AWSRequest PutTraceSegments Source # 
ToPath PutTraceSegments Source # 
ToHeaders PutTraceSegments Source # 
ToQuery PutTraceSegments Source # 
type Rep PutTraceSegments Source # 
type Rep PutTraceSegments = D1 (MetaData "PutTraceSegments" "Network.AWS.XRay.PutTraceSegments" "amazonka-xray-1.4.5-LjspqNOSXLI2hjE4zOSXE1" True) (C1 (MetaCons "PutTraceSegments'" PrefixI True) (S1 (MetaSel (Just Symbol "_ptsTraceSegmentDocuments") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])))
type Rs PutTraceSegments Source # 

Request Lenses

ptsTraceSegmentDocuments :: Lens' PutTraceSegments [Text] Source #

A JSON document defining one or more segments or subsegments. Segments must include the following fields. Required Segment Document Fields * name - The name of the service that handled the request. * id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits. * trace_id - A unique identifier that connects all segments and subsegments originating from a single client request. * start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9 . * end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9 . Specify either an end_time or in_progress . * in_progress - Set to true instead of specifying an end_time to record that a segment has been started, but is not complete. Send an in progress segment when your application receives a request that will take a long time to serve, to trace the fact that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment. A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes: Trace ID Format * The version number, i.e. 1 . * The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal. * A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.

Destructuring the Response

putTraceSegmentsResponse Source #

Creates a value of PutTraceSegmentsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data PutTraceSegmentsResponse Source #

See: putTraceSegmentsResponse smart constructor.

Instances

Eq PutTraceSegmentsResponse Source # 
Data PutTraceSegmentsResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutTraceSegmentsResponse -> c PutTraceSegmentsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutTraceSegmentsResponse #

toConstr :: PutTraceSegmentsResponse -> Constr #

dataTypeOf :: PutTraceSegmentsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PutTraceSegmentsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutTraceSegmentsResponse) #

gmapT :: (forall b. Data b => b -> b) -> PutTraceSegmentsResponse -> PutTraceSegmentsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutTraceSegmentsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutTraceSegmentsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> PutTraceSegmentsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutTraceSegmentsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutTraceSegmentsResponse -> m PutTraceSegmentsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutTraceSegmentsResponse -> m PutTraceSegmentsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutTraceSegmentsResponse -> m PutTraceSegmentsResponse #

Read PutTraceSegmentsResponse Source # 
Show PutTraceSegmentsResponse Source # 
Generic PutTraceSegmentsResponse Source # 
NFData PutTraceSegmentsResponse Source # 
type Rep PutTraceSegmentsResponse Source # 
type Rep PutTraceSegmentsResponse = D1 (MetaData "PutTraceSegmentsResponse" "Network.AWS.XRay.PutTraceSegments" "amazonka-xray-1.4.5-LjspqNOSXLI2hjE4zOSXE1" False) (C1 (MetaCons "PutTraceSegmentsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ptsrsUnprocessedTraceSegments") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [UnprocessedTraceSegment]))) (S1 (MetaSel (Just Symbol "_ptsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses