@Generated(value="software.amazon.awssdk:codegen") public interface XRayAsyncClient extends SdkClient, SdkAutoCloseable
builder()
method.
AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<BatchGetTracesResponse> |
batchGetTraces(BatchGetTracesRequest batchGetTracesRequest)
Retrieves a list of traces specified by ID.
|
default CompletableFuture<BatchGetTracesResponse> |
batchGetTraces(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest)
Retrieves a list of traces specified by ID.
|
static XRayAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
XRayAsyncClient . |
static XRayAsyncClient |
create()
Create a
XRayAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from
the DefaultCredentialsProvider . |
default CompletableFuture<GetServiceGraphResponse> |
getServiceGraph(Consumer<GetServiceGraphRequest.Builder> getServiceGraphRequest)
Retrieves a document that describes services that process incoming requests, and downstream services that they
call as a result.
|
default CompletableFuture<GetServiceGraphResponse> |
getServiceGraph(GetServiceGraphRequest getServiceGraphRequest)
Retrieves a document that describes services that process incoming requests, and downstream services that they
call as a result.
|
default CompletableFuture<GetTraceGraphResponse> |
getTraceGraph(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
|
default CompletableFuture<GetTraceGraphResponse> |
getTraceGraph(GetTraceGraphRequest getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
|
default CompletableFuture<GetTraceSummariesResponse> |
getTraceSummaries(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest)
Retrieves IDs and metadata for traces available for a specified time frame using an optional filter.
|
default CompletableFuture<GetTraceSummariesResponse> |
getTraceSummaries(GetTraceSummariesRequest getTraceSummariesRequest)
Retrieves IDs and metadata for traces available for a specified time frame using an optional filter.
|
default CompletableFuture<PutTelemetryRecordsResponse> |
putTelemetryRecords(Consumer<PutTelemetryRecordsRequest.Builder> putTelemetryRecordsRequest)
Used by the AWS X-Ray daemon to upload telemetry.
|
default CompletableFuture<PutTelemetryRecordsResponse> |
putTelemetryRecords(PutTelemetryRecordsRequest putTelemetryRecordsRequest)
Used by the AWS X-Ray daemon to upload telemetry.
|
default CompletableFuture<PutTraceSegmentsResponse> |
putTraceSegments(Consumer<PutTraceSegmentsRequest.Builder> putTraceSegmentsRequest)
Uploads segment documents to AWS X-Ray.
|
default CompletableFuture<PutTraceSegmentsResponse> |
putTraceSegments(PutTraceSegmentsRequest putTraceSegmentsRequest)
Uploads segment documents to AWS X-Ray.
|
serviceName
close
static final String SERVICE_NAME
static XRayAsyncClient create()
XRayAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static XRayAsyncClientBuilder builder()
XRayAsyncClient
.default CompletableFuture<BatchGetTracesResponse> batchGetTraces(BatchGetTracesRequest batchGetTracesRequest)
Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from
a single request. Use GetTraceSummaries
to get a list of trace IDs.
batchGetTracesRequest
- default CompletableFuture<BatchGetTracesResponse> batchGetTraces(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest)
Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from
a single request. Use GetTraceSummaries
to get a list of trace IDs.
BatchGetTracesRequest.Builder
avoiding the need to
create one manually via BatchGetTracesRequest.builder()
batchGetTracesRequest
- a Consumer
that will call methods on BatchGetTracesRequest.Builder
.default CompletableFuture<GetServiceGraphResponse> getServiceGraph(GetServiceGraphRequest getServiceGraphRequest)
Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.
getServiceGraphRequest
- default CompletableFuture<GetServiceGraphResponse> getServiceGraph(Consumer<GetServiceGraphRequest.Builder> getServiceGraphRequest)
Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.
GetServiceGraphRequest.Builder
avoiding the need
to create one manually via GetServiceGraphRequest.builder()
getServiceGraphRequest
- a Consumer
that will call methods on GetServiceGraphRequest.Builder
.default CompletableFuture<GetTraceGraphResponse> getTraceGraph(GetTraceGraphRequest getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
getTraceGraphRequest
- default CompletableFuture<GetTraceGraphResponse> getTraceGraph(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
GetTraceGraphRequest.Builder
avoiding the need to
create one manually via GetTraceGraphRequest.builder()
getTraceGraphRequest
- a Consumer
that will call methods on GetTraceGraphRequest.Builder
.default CompletableFuture<GetTraceSummariesResponse> getTraceSummaries(GetTraceSummariesRequest getTraceSummariesRequest)
Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the
full traces, pass the trace IDs to BatchGetTraces
.
A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come
from a known user. For example, the following filter expression targets traces that pass through
api.example.com
:
service("api.example.com")
This filter expression finds traces that have an annotation named account
with the value
12345
:
annotation.account = "12345"
For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the AWS X-Ray Developer Guide.
getTraceSummariesRequest
- default CompletableFuture<GetTraceSummariesResponse> getTraceSummaries(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest)
Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the
full traces, pass the trace IDs to BatchGetTraces
.
A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come
from a known user. For example, the following filter expression targets traces that pass through
api.example.com
:
service("api.example.com")
This filter expression finds traces that have an annotation named account
with the value
12345
:
annotation.account = "12345"
For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the AWS X-Ray Developer Guide.
GetTraceSummariesRequest.Builder
avoiding the need
to create one manually via GetTraceSummariesRequest.builder()
getTraceSummariesRequest
- a Consumer
that will call methods on GetTraceSummariesRequest.Builder
.default CompletableFuture<PutTelemetryRecordsResponse> putTelemetryRecords(PutTelemetryRecordsRequest putTelemetryRecordsRequest)
Used by the AWS X-Ray daemon to upload telemetry.
putTelemetryRecordsRequest
- default CompletableFuture<PutTelemetryRecordsResponse> putTelemetryRecords(Consumer<PutTelemetryRecordsRequest.Builder> putTelemetryRecordsRequest)
Used by the AWS X-Ray daemon to upload telemetry.
PutTelemetryRecordsRequest.Builder
avoiding the
need to create one manually via PutTelemetryRecordsRequest.builder()
putTelemetryRecordsRequest
- a Consumer
that will call methods on PutTelemetryRecordsRequest.Builder
.default CompletableFuture<PutTraceSegmentsResponse> putTraceSegments(PutTraceSegmentsRequest putTraceSegmentsRequest)
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.
putTraceSegmentsRequest
- default CompletableFuture<PutTraceSegmentsResponse> putTraceSegments(Consumer<PutTraceSegmentsRequest.Builder> putTraceSegmentsRequest)
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.
PutTraceSegmentsRequest.Builder
avoiding the need
to create one manually via PutTraceSegmentsRequest.builder()
putTraceSegmentsRequest
- a Consumer
that will call methods on PutTraceSegmentsRequest.Builder
.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.