@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSXRayAsyncClient extends AWSXRayClient implements AWSXRayAsync
AsyncHandler can be used to receive notification when
an asynchronous operation completes.
AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AWSXRayAsyncClient()
Deprecated.
|
AWSXRayAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AWSXRayAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AWSXRayAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AWSXRayAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSXRayAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSXRayAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AWSXRayAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AWSXRayAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static AWSXRayAsyncClientBuilder |
asyncBuilder() |
Future<BatchGetTracesResult> |
batchGetTracesAsync(BatchGetTracesRequest request)
Retrieves a list of traces specified by ID.
|
Future<BatchGetTracesResult> |
batchGetTracesAsync(BatchGetTracesRequest request,
AsyncHandler<BatchGetTracesRequest,BatchGetTracesResult> asyncHandler)
Retrieves a list of traces specified by ID.
|
ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async requests.
|
Future<GetServiceGraphResult> |
getServiceGraphAsync(GetServiceGraphRequest request)
Retrieves a document that describes services that process incoming requests, and downstream services that they
call as a result.
|
Future<GetServiceGraphResult> |
getServiceGraphAsync(GetServiceGraphRequest request,
AsyncHandler<GetServiceGraphRequest,GetServiceGraphResult> asyncHandler)
Retrieves a document that describes services that process incoming requests, and downstream services that they
call as a result.
|
Future<GetTraceGraphResult> |
getTraceGraphAsync(GetTraceGraphRequest request)
Retrieves a service graph for one or more specific trace IDs.
|
Future<GetTraceGraphResult> |
getTraceGraphAsync(GetTraceGraphRequest request,
AsyncHandler<GetTraceGraphRequest,GetTraceGraphResult> asyncHandler)
Retrieves a service graph for one or more specific trace IDs.
|
Future<GetTraceSummariesResult> |
getTraceSummariesAsync(GetTraceSummariesRequest request)
Retrieves IDs and metadata for traces available for a specified time frame using an optional filter.
|
Future<GetTraceSummariesResult> |
getTraceSummariesAsync(GetTraceSummariesRequest request,
AsyncHandler<GetTraceSummariesRequest,GetTraceSummariesResult> asyncHandler)
Retrieves IDs and metadata for traces available for a specified time frame using an optional filter.
|
Future<PutTelemetryRecordsResult> |
putTelemetryRecordsAsync(PutTelemetryRecordsRequest request)
Used by the AWS X-Ray daemon to upload telemetry.
|
Future<PutTelemetryRecordsResult> |
putTelemetryRecordsAsync(PutTelemetryRecordsRequest request,
AsyncHandler<PutTelemetryRecordsRequest,PutTelemetryRecordsResult> asyncHandler)
Used by the AWS X-Ray daemon to upload telemetry.
|
Future<PutTraceSegmentsResult> |
putTraceSegmentsAsync(PutTraceSegmentsRequest request)
Uploads segment documents to AWS X-Ray.
|
Future<PutTraceSegmentsResult> |
putTraceSegmentsAsync(PutTraceSegmentsRequest request,
AsyncHandler<PutTraceSegmentsRequest,PutTraceSegmentsResult> asyncHandler)
Uploads segment documents to AWS X-Ray.
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
batchGetTraces, builder, getCachedResponseMetadata, getServiceGraph, getTraceGraph, getTraceSummaries, putTelemetryRecords, putTraceSegmentsaddRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitbatchGetTraces, getCachedResponseMetadata, getServiceGraph, getTraceGraph, getTraceSummaries, putTelemetryRecords, putTraceSegments, setEndpoint, setRegion@Deprecated public AWSXRayAsyncClient()
AWSXRayAsyncClientBuilder.defaultClient()Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
@Deprecated public AWSXRayAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
clientConfiguration - The client configuration options controlling how this client connects to AWS X-Ray (ex: proxy settings,
retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AWSXRayAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AWSXRayAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AWSXRayAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AWSXRayAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AWSXRayAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AWSXRayAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AWSXRayAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.public static AWSXRayAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<BatchGetTracesResult> batchGetTracesAsync(BatchGetTracesRequest request)
AWSXRayAsync
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.
batchGetTracesAsync in interface AWSXRayAsyncpublic Future<BatchGetTracesResult> batchGetTracesAsync(BatchGetTracesRequest request, AsyncHandler<BatchGetTracesRequest,BatchGetTracesResult> asyncHandler)
AWSXRayAsync
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.
batchGetTracesAsync in interface AWSXRayAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetServiceGraphResult> getServiceGraphAsync(GetServiceGraphRequest request)
AWSXRayAsyncRetrieves 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.
getServiceGraphAsync in interface AWSXRayAsyncpublic Future<GetServiceGraphResult> getServiceGraphAsync(GetServiceGraphRequest request, AsyncHandler<GetServiceGraphRequest,GetServiceGraphResult> asyncHandler)
AWSXRayAsyncRetrieves 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.
getServiceGraphAsync in interface AWSXRayAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetTraceGraphResult> getTraceGraphAsync(GetTraceGraphRequest request)
AWSXRayAsyncRetrieves a service graph for one or more specific trace IDs.
getTraceGraphAsync in interface AWSXRayAsyncpublic Future<GetTraceGraphResult> getTraceGraphAsync(GetTraceGraphRequest request, AsyncHandler<GetTraceGraphRequest,GetTraceGraphResult> asyncHandler)
AWSXRayAsyncRetrieves a service graph for one or more specific trace IDs.
getTraceGraphAsync in interface AWSXRayAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetTraceSummariesResult> getTraceSummariesAsync(GetTraceSummariesRequest request)
AWSXRayAsync
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.
getTraceSummariesAsync in interface AWSXRayAsyncpublic Future<GetTraceSummariesResult> getTraceSummariesAsync(GetTraceSummariesRequest request, AsyncHandler<GetTraceSummariesRequest,GetTraceSummariesResult> asyncHandler)
AWSXRayAsync
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.
getTraceSummariesAsync in interface AWSXRayAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutTelemetryRecordsResult> putTelemetryRecordsAsync(PutTelemetryRecordsRequest request)
AWSXRayAsyncUsed by the AWS X-Ray daemon to upload telemetry.
putTelemetryRecordsAsync in interface AWSXRayAsyncpublic Future<PutTelemetryRecordsResult> putTelemetryRecordsAsync(PutTelemetryRecordsRequest request, AsyncHandler<PutTelemetryRecordsRequest,PutTelemetryRecordsResult> asyncHandler)
AWSXRayAsyncUsed by the AWS X-Ray daemon to upload telemetry.
putTelemetryRecordsAsync in interface AWSXRayAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutTraceSegmentsResult> putTraceSegmentsAsync(PutTraceSegmentsRequest request)
AWSXRayAsyncUploads 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.
putTraceSegmentsAsync in interface AWSXRayAsyncpublic Future<PutTraceSegmentsResult> putTraceSegmentsAsync(PutTraceSegmentsRequest request, AsyncHandler<PutTraceSegmentsRequest,PutTraceSegmentsResult> asyncHandler)
AWSXRayAsyncUploads 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.
putTraceSegmentsAsync in interface AWSXRayAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSXRayshutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.