Amazonka.XRay.PutTraceSegments

Uploads segment documents to Amazon Web Services 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 Amazon Web Services X-Ray Segment Documents in the Amazon Web Services 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 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, for instance, 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

data PutTraceSegments

See: newPutTraceSegments smart constructor.

Constructors

PutTraceSegments'

Fields

• traceSegmentDocuments :: [Text]

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

Instances

ToJSON PutTraceSegments

Defined in Amazonka.XRay.PutTraceSegments

Methods

toJSON :: PutTraceSegments -> Value

toEncoding :: PutTraceSegments -> Encoding

toJSONList :: [PutTraceSegments] -> Value

toEncodingList :: [PutTraceSegments] -> Encoding

ToHeaders PutTraceSegments

Defined in Amazonka.XRay.PutTraceSegments

Methods

toHeaders :: PutTraceSegments -> [Header]

ToPath PutTraceSegments

Defined in Amazonka.XRay.PutTraceSegments

Methods

toPath :: PutTraceSegments -> ByteString

ToQuery PutTraceSegments

Defined in Amazonka.XRay.PutTraceSegments

Methods

toQuery :: PutTraceSegments -> QueryString

AWSRequest PutTraceSegments

Defined in Amazonka.XRay.PutTraceSegments

Associated Types

type AWSResponse PutTraceSegments

Methods

request :: (Service -> Service) -> PutTraceSegments -> Request PutTraceSegments

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutTraceSegments -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutTraceSegments)))

Generic PutTraceSegments

Defined in Amazonka.XRay.PutTraceSegments

Associated Types

type Rep PutTraceSegments :: Type -> Type

Methods

from :: PutTraceSegments -> Rep PutTraceSegments x

to :: Rep PutTraceSegments x -> PutTraceSegments

Read PutTraceSegments

Defined in Amazonka.XRay.PutTraceSegments

Methods

readsPrec :: Int -> ReadS PutTraceSegments

readList :: ReadS [PutTraceSegments]

readPrec :: ReadPrec PutTraceSegments

readListPrec :: ReadPrec [PutTraceSegments]

Show PutTraceSegments

Defined in Amazonka.XRay.PutTraceSegments

Methods

showsPrec :: Int -> PutTraceSegments -> ShowS

show :: PutTraceSegments -> String

showList :: [PutTraceSegments] -> ShowS

NFData PutTraceSegments

Defined in Amazonka.XRay.PutTraceSegments

Methods

rnf :: PutTraceSegments -> ()

Eq PutTraceSegments

Defined in Amazonka.XRay.PutTraceSegments

Methods

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

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

Hashable PutTraceSegments

Defined in Amazonka.XRay.PutTraceSegments

Methods

hashWithSalt :: Int -> PutTraceSegments -> Int

hash :: PutTraceSegments -> Int

type AWSResponse PutTraceSegments

Defined in Amazonka.XRay.PutTraceSegments

type AWSResponse PutTraceSegments = PutTraceSegmentsResponse

type Rep PutTraceSegments

Defined in Amazonka.XRay.PutTraceSegments

type Rep PutTraceSegments = D1 ('MetaData "PutTraceSegments" "Amazonka.XRay.PutTraceSegments" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "PutTraceSegments'" 'PrefixI 'True) (S1 ('MetaSel ('Just "traceSegmentDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newPutTraceSegments :: PutTraceSegments

Create a value of PutTraceSegments 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:traceSegmentDocuments:PutTraceSegments', putTraceSegments_traceSegmentDocuments - A string containing a JSON document defining one or more segments or subsegments.

Request Lenses

putTraceSegments_traceSegmentDocuments :: Lens' PutTraceSegments [Text]

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

Destructuring the Response

data PutTraceSegmentsResponse

See: newPutTraceSegmentsResponse smart constructor.

Constructors

PutTraceSegmentsResponse'

Fields

• unprocessedTraceSegments :: Maybe [UnprocessedTraceSegment]

  Segments that failed processing.

• httpStatus :: Int

  The response's http status code.

Instances

Generic PutTraceSegmentsResponse

Defined in Amazonka.XRay.PutTraceSegments

Associated Types

type Rep PutTraceSegmentsResponse :: Type -> Type

Methods

from :: PutTraceSegmentsResponse -> Rep PutTraceSegmentsResponse x

to :: Rep PutTraceSegmentsResponse x -> PutTraceSegmentsResponse

Read PutTraceSegmentsResponse

Defined in Amazonka.XRay.PutTraceSegments

Methods

readsPrec :: Int -> ReadS PutTraceSegmentsResponse

readList :: ReadS [PutTraceSegmentsResponse]

readPrec :: ReadPrec PutTraceSegmentsResponse

readListPrec :: ReadPrec [PutTraceSegmentsResponse]

Show PutTraceSegmentsResponse

Defined in Amazonka.XRay.PutTraceSegments

Methods

showsPrec :: Int -> PutTraceSegmentsResponse -> ShowS

show :: PutTraceSegmentsResponse -> String

showList :: [PutTraceSegmentsResponse] -> ShowS

NFData PutTraceSegmentsResponse

Defined in Amazonka.XRay.PutTraceSegments

Methods

rnf :: PutTraceSegmentsResponse -> ()

Eq PutTraceSegmentsResponse

Defined in Amazonka.XRay.PutTraceSegments

Methods

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

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

type Rep PutTraceSegmentsResponse

Defined in Amazonka.XRay.PutTraceSegments

type Rep PutTraceSegmentsResponse = D1 ('MetaData "PutTraceSegmentsResponse" "Amazonka.XRay.PutTraceSegments" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "PutTraceSegmentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "unprocessedTraceSegments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UnprocessedTraceSegment])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutTraceSegmentsResponse

Arguments

:: Int

PutTraceSegmentsResponse

-> PutTraceSegmentsResponse

Create a value of PutTraceSegmentsResponse 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:unprocessedTraceSegments:PutTraceSegmentsResponse', putTraceSegmentsResponse_unprocessedTraceSegments - Segments that failed processing.

PutTraceSegmentsResponse, putTraceSegmentsResponse_httpStatus - The response's http status code.

Response Lenses

putTraceSegmentsResponse_unprocessedTraceSegments :: Lens' PutTraceSegmentsResponse (Maybe [UnprocessedTraceSegment])

Segments that failed processing.

putTraceSegmentsResponse_httpStatus :: Lens' PutTraceSegmentsResponse Int

The response's http status code.