Network.AWS.XRay.PutTraceSegments

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.

Segments must include the following fields. For the full segment document schema, see AWS X-Ray Segment Documents in the AWS X-Ray Developer Guide .

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.

Creating a Request

putTraceSegments :: PutTraceSegments

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 string containing a JSON document defining one or more segments or subsegments.

data PutTraceSegments

See: putTraceSegments smart constructor.

Instances

Eq PutTraceSegments

Methods

(==) :: PutTraceSegments -> PutTraceSegments -> Bool

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

Data PutTraceSegments

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

Methods

readsPrec :: Int -> ReadS PutTraceSegments

readList :: ReadS [PutTraceSegments]

readPrec :: ReadPrec PutTraceSegments

readListPrec :: ReadPrec [PutTraceSegments]

Show PutTraceSegments

Methods

showsPrec :: Int -> PutTraceSegments -> ShowS

show :: PutTraceSegments -> String

showList :: [PutTraceSegments] -> ShowS

Generic PutTraceSegments

Associated Types

type Rep PutTraceSegments :: * -> *

Methods

from :: PutTraceSegments -> Rep PutTraceSegments x

to :: Rep PutTraceSegments x -> PutTraceSegments

Hashable PutTraceSegments

Methods

hashWithSalt :: Int -> PutTraceSegments -> Int

hash :: PutTraceSegments -> Int

ToJSON PutTraceSegments

Methods

toJSON :: PutTraceSegments -> Value

toEncoding :: PutTraceSegments -> Encoding

toJSONList :: [PutTraceSegments] -> Value

toEncodingList :: [PutTraceSegments] -> Encoding

NFData PutTraceSegments

Methods

rnf :: PutTraceSegments -> ()

AWSRequest PutTraceSegments

Associated Types

type Rs PutTraceSegments :: *

Methods

request :: PutTraceSegments -> Request PutTraceSegments

response :: MonadResource m => Logger -> Service -> Proxy * PutTraceSegments -> ClientResponse -> m (Response PutTraceSegments)

ToQuery PutTraceSegments

Methods

toQuery :: PutTraceSegments -> QueryString

ToPath PutTraceSegments

Methods

toPath :: PutTraceSegments -> ByteString

ToHeaders PutTraceSegments

Methods

toHeaders :: PutTraceSegments -> [Header]

type Rep PutTraceSegments

type Rep PutTraceSegments = D1 (MetaData "PutTraceSegments" "Network.AWS.XRay.PutTraceSegments" "amazonka-xray-1.5.0-AMTKBzdR01nBVBDWOdpea8" True) (C1 (MetaCons "PutTraceSegments'" PrefixI True) (S1 (MetaSel (Just Symbol "_ptsTraceSegmentDocuments") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])))

type Rs PutTraceSegments

type Rs PutTraceSegments = PutTraceSegmentsResponse

Request Lenses

ptsTraceSegmentDocuments :: Lens' PutTraceSegments [Text]

A string containing a JSON document defining one or more segments or subsegments.

Destructuring the Response

putTraceSegmentsResponse

Arguments

:: Int

ptsrsResponseStatus

-> PutTraceSegmentsResponse

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:

• ptsrsUnprocessedTraceSegments - Segments that failed processing.
• ptsrsResponseStatus - -- | The response status code.

data PutTraceSegmentsResponse

See: putTraceSegmentsResponse smart constructor.

Instances

Eq PutTraceSegmentsResponse

Methods

(==) :: PutTraceSegmentsResponse -> PutTraceSegmentsResponse -> Bool

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

Data PutTraceSegmentsResponse

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

Methods

readsPrec :: Int -> ReadS PutTraceSegmentsResponse

readList :: ReadS [PutTraceSegmentsResponse]

readPrec :: ReadPrec PutTraceSegmentsResponse

readListPrec :: ReadPrec [PutTraceSegmentsResponse]

Show PutTraceSegmentsResponse

Methods

showsPrec :: Int -> PutTraceSegmentsResponse -> ShowS

show :: PutTraceSegmentsResponse -> String

showList :: [PutTraceSegmentsResponse] -> ShowS

Generic PutTraceSegmentsResponse

Associated Types

type Rep PutTraceSegmentsResponse :: * -> *

Methods

from :: PutTraceSegmentsResponse -> Rep PutTraceSegmentsResponse x

to :: Rep PutTraceSegmentsResponse x -> PutTraceSegmentsResponse

NFData PutTraceSegmentsResponse

Methods

rnf :: PutTraceSegmentsResponse -> ()

type Rep PutTraceSegmentsResponse

type Rep PutTraceSegmentsResponse = D1 (MetaData "PutTraceSegmentsResponse" "Network.AWS.XRay.PutTraceSegments" "amazonka-xray-1.5.0-AMTKBzdR01nBVBDWOdpea8" False) (C1 (MetaCons "PutTraceSegmentsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ptsrsUnprocessedTraceSegments") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [UnprocessedTraceSegment]))) (S1 (MetaSel (Just Symbol "_ptsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

ptsrsUnprocessedTraceSegments :: Lens' PutTraceSegmentsResponse [UnprocessedTraceSegment]

Segments that failed processing.

ptsrsResponseStatus :: Lens' PutTraceSegmentsResponse Int

• - | The response status code.