AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Uploads segment documents to Amazon Web Services X-Ray. 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.
For trace IDs created by an X-Ray SDK, or by Amazon Web Services services integrated
with X-Ray, a trace ID 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.
Trace IDs created via OpenTelemetry have a different format based on the W3C
Trace Context specification. A W3C trace ID must be formatted in the X-Ray trace
ID format when sending to X-Ray. For example, a W3C trace ID 4efaaf4d1e8720b39541901950019ee5
should be formatted as 1-4efaaf4d-1e8720b39541901950019ee5 when sending to
X-Ray. While X-Ray trace IDs include the original request timestamp in Unix epoch
time, this is not required or validated.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginPutTraceSegments and EndPutTraceSegments.
Namespace: Amazon.XRay
Assembly: AWSSDK.XRay.dll
Version: 3.x.y.z
public virtual Task<PutTraceSegmentsResponse> PutTraceSegmentsAsync( PutTraceSegmentsRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the PutTraceSegments service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| InvalidRequestException | The request is missing required parameters or has invalid parameters. |
| ThrottledException | The request exceeds the maximum number of requests per second. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer