@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.
Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_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.
|
batchGetTraces, builder, createGroup, createSamplingRule, deleteGroup, deleteResourcePolicy, deleteSamplingRule, getCachedResponseMetadata, getEncryptionConfig, getGroup, getGroups, getInsight, getInsightEvents, getInsightImpactGraph, getInsightSummaries, getSamplingRules, getSamplingStatisticSummaries, getSamplingTargets, getServiceGraph, getTimeSeriesServiceStatistics, getTraceGraph, getTraceSummaries, listResourcePolicies, listTagsForResource, putEncryptionConfig, putResourcePolicy, putTelemetryRecords, putTraceSegments, tagResource, untagResource, updateGroup, updateSamplingRule
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
batchGetTraces, createGroup, createSamplingRule, deleteGroup, deleteResourcePolicy, deleteSamplingRule, getCachedResponseMetadata, getEncryptionConfig, getGroup, getGroups, getInsight, getInsightEvents, getInsightImpactGraph, getInsightSummaries, getSamplingRules, getSamplingStatisticSummaries, getSamplingTargets, getServiceGraph, getTimeSeriesServiceStatistics, getTraceGraph, getTraceSummaries, listResourcePolicies, listTagsForResource, putEncryptionConfig, putResourcePolicy, putTelemetryRecords, putTraceSegments, setEndpoint, setRegion, tagResource, untagResource, updateGroup, updateSamplingRule
@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 AWSXRayAsync
public 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 AWSXRayAsync
asyncHandler
- 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<CreateGroupResult> createGroupAsync(CreateGroupRequest request)
AWSXRayAsync
Creates a group resource with a name and a filter expression.
createGroupAsync
in interface AWSXRayAsync
public Future<CreateGroupResult> createGroupAsync(CreateGroupRequest request, AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)
AWSXRayAsync
Creates a group resource with a name and a filter expression.
createGroupAsync
in interface AWSXRayAsync
asyncHandler
- 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<CreateSamplingRuleResult> createSamplingRuleAsync(CreateSamplingRuleRequest request)
AWSXRayAsync
Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.
createSamplingRuleAsync
in interface AWSXRayAsync
public Future<CreateSamplingRuleResult> createSamplingRuleAsync(CreateSamplingRuleRequest request, AsyncHandler<CreateSamplingRuleRequest,CreateSamplingRuleResult> asyncHandler)
AWSXRayAsync
Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.
createSamplingRuleAsync
in interface AWSXRayAsync
asyncHandler
- 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<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request)
AWSXRayAsync
Deletes a group resource.
deleteGroupAsync
in interface AWSXRayAsync
public Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request, AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
AWSXRayAsync
Deletes a group resource.
deleteGroupAsync
in interface AWSXRayAsync
asyncHandler
- 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<DeleteResourcePolicyResult> deleteResourcePolicyAsync(DeleteResourcePolicyRequest request)
AWSXRayAsync
Deletes a resource policy from the target Amazon Web Services account.
deleteResourcePolicyAsync
in interface AWSXRayAsync
public Future<DeleteResourcePolicyResult> deleteResourcePolicyAsync(DeleteResourcePolicyRequest request, AsyncHandler<DeleteResourcePolicyRequest,DeleteResourcePolicyResult> asyncHandler)
AWSXRayAsync
Deletes a resource policy from the target Amazon Web Services account.
deleteResourcePolicyAsync
in interface AWSXRayAsync
asyncHandler
- 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<DeleteSamplingRuleResult> deleteSamplingRuleAsync(DeleteSamplingRuleRequest request)
AWSXRayAsync
Deletes a sampling rule.
deleteSamplingRuleAsync
in interface AWSXRayAsync
public Future<DeleteSamplingRuleResult> deleteSamplingRuleAsync(DeleteSamplingRuleRequest request, AsyncHandler<DeleteSamplingRuleRequest,DeleteSamplingRuleResult> asyncHandler)
AWSXRayAsync
Deletes a sampling rule.
deleteSamplingRuleAsync
in interface AWSXRayAsync
asyncHandler
- 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<GetEncryptionConfigResult> getEncryptionConfigAsync(GetEncryptionConfigRequest request)
AWSXRayAsync
Retrieves the current encryption configuration for X-Ray data.
getEncryptionConfigAsync
in interface AWSXRayAsync
public Future<GetEncryptionConfigResult> getEncryptionConfigAsync(GetEncryptionConfigRequest request, AsyncHandler<GetEncryptionConfigRequest,GetEncryptionConfigResult> asyncHandler)
AWSXRayAsync
Retrieves the current encryption configuration for X-Ray data.
getEncryptionConfigAsync
in interface AWSXRayAsync
asyncHandler
- 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<GetGroupResult> getGroupAsync(GetGroupRequest request)
AWSXRayAsync
Retrieves group resource details.
getGroupAsync
in interface AWSXRayAsync
public Future<GetGroupResult> getGroupAsync(GetGroupRequest request, AsyncHandler<GetGroupRequest,GetGroupResult> asyncHandler)
AWSXRayAsync
Retrieves group resource details.
getGroupAsync
in interface AWSXRayAsync
asyncHandler
- 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<GetGroupsResult> getGroupsAsync(GetGroupsRequest request)
AWSXRayAsync
Retrieves all active group details.
getGroupsAsync
in interface AWSXRayAsync
public Future<GetGroupsResult> getGroupsAsync(GetGroupsRequest request, AsyncHandler<GetGroupsRequest,GetGroupsResult> asyncHandler)
AWSXRayAsync
Retrieves all active group details.
getGroupsAsync
in interface AWSXRayAsync
asyncHandler
- 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<GetInsightResult> getInsightAsync(GetInsightRequest request)
AWSXRayAsync
Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.
getInsightAsync
in interface AWSXRayAsync
public Future<GetInsightResult> getInsightAsync(GetInsightRequest request, AsyncHandler<GetInsightRequest,GetInsightResult> asyncHandler)
AWSXRayAsync
Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.
getInsightAsync
in interface AWSXRayAsync
asyncHandler
- 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<GetInsightEventsResult> getInsightEventsAsync(GetInsightEventsRequest request)
AWSXRayAsync
X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.
getInsightEventsAsync
in interface AWSXRayAsync
public Future<GetInsightEventsResult> getInsightEventsAsync(GetInsightEventsRequest request, AsyncHandler<GetInsightEventsRequest,GetInsightEventsResult> asyncHandler)
AWSXRayAsync
X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.
getInsightEventsAsync
in interface AWSXRayAsync
asyncHandler
- 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<GetInsightImpactGraphResult> getInsightImpactGraphAsync(GetInsightImpactGraphRequest request)
AWSXRayAsync
Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.
getInsightImpactGraphAsync
in interface AWSXRayAsync
public Future<GetInsightImpactGraphResult> getInsightImpactGraphAsync(GetInsightImpactGraphRequest request, AsyncHandler<GetInsightImpactGraphRequest,GetInsightImpactGraphResult> asyncHandler)
AWSXRayAsync
Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.
getInsightImpactGraphAsync
in interface AWSXRayAsync
asyncHandler
- 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<GetInsightSummariesResult> getInsightSummariesAsync(GetInsightSummariesRequest request)
AWSXRayAsync
Retrieves the summaries of all insights in the specified group matching the provided filter values.
getInsightSummariesAsync
in interface AWSXRayAsync
public Future<GetInsightSummariesResult> getInsightSummariesAsync(GetInsightSummariesRequest request, AsyncHandler<GetInsightSummariesRequest,GetInsightSummariesResult> asyncHandler)
AWSXRayAsync
Retrieves the summaries of all insights in the specified group matching the provided filter values.
getInsightSummariesAsync
in interface AWSXRayAsync
asyncHandler
- 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<GetSamplingRulesResult> getSamplingRulesAsync(GetSamplingRulesRequest request)
AWSXRayAsync
Retrieves all sampling rules.
getSamplingRulesAsync
in interface AWSXRayAsync
public Future<GetSamplingRulesResult> getSamplingRulesAsync(GetSamplingRulesRequest request, AsyncHandler<GetSamplingRulesRequest,GetSamplingRulesResult> asyncHandler)
AWSXRayAsync
Retrieves all sampling rules.
getSamplingRulesAsync
in interface AWSXRayAsync
asyncHandler
- 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<GetSamplingStatisticSummariesResult> getSamplingStatisticSummariesAsync(GetSamplingStatisticSummariesRequest request)
AWSXRayAsync
Retrieves information about recent sampling results for all sampling rules.
getSamplingStatisticSummariesAsync
in interface AWSXRayAsync
public Future<GetSamplingStatisticSummariesResult> getSamplingStatisticSummariesAsync(GetSamplingStatisticSummariesRequest request, AsyncHandler<GetSamplingStatisticSummariesRequest,GetSamplingStatisticSummariesResult> asyncHandler)
AWSXRayAsync
Retrieves information about recent sampling results for all sampling rules.
getSamplingStatisticSummariesAsync
in interface AWSXRayAsync
asyncHandler
- 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<GetSamplingTargetsResult> getSamplingTargetsAsync(GetSamplingTargetsRequest request)
AWSXRayAsync
Requests a sampling quota for rules that the service is using to sample requests.
getSamplingTargetsAsync
in interface AWSXRayAsync
public Future<GetSamplingTargetsResult> getSamplingTargetsAsync(GetSamplingTargetsRequest request, AsyncHandler<GetSamplingTargetsRequest,GetSamplingTargetsResult> asyncHandler)
AWSXRayAsync
Requests a sampling quota for rules that the service is using to sample requests.
getSamplingTargetsAsync
in interface AWSXRayAsync
asyncHandler
- 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)
AWSXRayAsync
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 Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.
getServiceGraphAsync
in interface AWSXRayAsync
public Future<GetServiceGraphResult> getServiceGraphAsync(GetServiceGraphRequest request, AsyncHandler<GetServiceGraphRequest,GetServiceGraphResult> asyncHandler)
AWSXRayAsync
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 Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.
getServiceGraphAsync
in interface AWSXRayAsync
asyncHandler
- 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<GetTimeSeriesServiceStatisticsResult> getTimeSeriesServiceStatisticsAsync(GetTimeSeriesServiceStatisticsRequest request)
AWSXRayAsync
Get an aggregation of service statistics defined by a specific time range.
getTimeSeriesServiceStatisticsAsync
in interface AWSXRayAsync
public Future<GetTimeSeriesServiceStatisticsResult> getTimeSeriesServiceStatisticsAsync(GetTimeSeriesServiceStatisticsRequest request, AsyncHandler<GetTimeSeriesServiceStatisticsRequest,GetTimeSeriesServiceStatisticsResult> asyncHandler)
AWSXRayAsync
Get an aggregation of service statistics defined by a specific time range.
getTimeSeriesServiceStatisticsAsync
in interface AWSXRayAsync
asyncHandler
- 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)
AWSXRayAsync
Retrieves a service graph for one or more specific trace IDs.
getTraceGraphAsync
in interface AWSXRayAsync
public Future<GetTraceGraphResult> getTraceGraphAsync(GetTraceGraphRequest request, AsyncHandler<GetTraceGraphRequest,GetTraceGraphResult> asyncHandler)
AWSXRayAsync
Retrieves a service graph for one or more specific trace IDs.
getTraceGraphAsync
in interface AWSXRayAsync
asyncHandler
- 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 annotations 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 Amazon Web Services X-Ray Developer Guide.
getTraceSummariesAsync
in interface AWSXRayAsync
public Future<GetTraceSummariesResult> getTraceSummariesAsync(GetTraceSummariesRequest request, AsyncHandler<GetTraceSummariesRequest,GetTraceSummariesResult> asyncHandler)
AWSXRayAsync
Retrieves IDs and annotations 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 Amazon Web Services X-Ray Developer Guide.
getTraceSummariesAsync
in interface AWSXRayAsync
asyncHandler
- 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<ListResourcePoliciesResult> listResourcePoliciesAsync(ListResourcePoliciesRequest request)
AWSXRayAsync
Returns the list of resource policies in the target Amazon Web Services account.
listResourcePoliciesAsync
in interface AWSXRayAsync
public Future<ListResourcePoliciesResult> listResourcePoliciesAsync(ListResourcePoliciesRequest request, AsyncHandler<ListResourcePoliciesRequest,ListResourcePoliciesResult> asyncHandler)
AWSXRayAsync
Returns the list of resource policies in the target Amazon Web Services account.
listResourcePoliciesAsync
in interface AWSXRayAsync
asyncHandler
- 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<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSXRayAsync
Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
listTagsForResourceAsync
in interface AWSXRayAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSXRayAsync
Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
listTagsForResourceAsync
in interface AWSXRayAsync
asyncHandler
- 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<PutEncryptionConfigResult> putEncryptionConfigAsync(PutEncryptionConfigRequest request)
AWSXRayAsync
Updates the encryption configuration for X-Ray data.
putEncryptionConfigAsync
in interface AWSXRayAsync
public Future<PutEncryptionConfigResult> putEncryptionConfigAsync(PutEncryptionConfigRequest request, AsyncHandler<PutEncryptionConfigRequest,PutEncryptionConfigResult> asyncHandler)
AWSXRayAsync
Updates the encryption configuration for X-Ray data.
putEncryptionConfigAsync
in interface AWSXRayAsync
asyncHandler
- 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<PutResourcePolicyResult> putResourcePolicyAsync(PutResourcePolicyRequest request)
AWSXRayAsync
Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.
putResourcePolicyAsync
in interface AWSXRayAsync
public Future<PutResourcePolicyResult> putResourcePolicyAsync(PutResourcePolicyRequest request, AsyncHandler<PutResourcePolicyRequest,PutResourcePolicyResult> asyncHandler)
AWSXRayAsync
Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.
putResourcePolicyAsync
in interface AWSXRayAsync
asyncHandler
- 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)
AWSXRayAsync
Used by the Amazon Web Services X-Ray daemon to upload telemetry.
putTelemetryRecordsAsync
in interface AWSXRayAsync
public Future<PutTelemetryRecordsResult> putTelemetryRecordsAsync(PutTelemetryRecordsRequest request, AsyncHandler<PutTelemetryRecordsRequest,PutTelemetryRecordsResult> asyncHandler)
AWSXRayAsync
Used by the Amazon Web Services X-Ray daemon to upload telemetry.
putTelemetryRecordsAsync
in interface AWSXRayAsync
asyncHandler
- 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)
AWSXRayAsync
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.
putTraceSegmentsAsync
in interface AWSXRayAsync
public Future<PutTraceSegmentsResult> putTraceSegmentsAsync(PutTraceSegmentsRequest request, AsyncHandler<PutTraceSegmentsRequest,PutTraceSegmentsResult> asyncHandler)
AWSXRayAsync
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.
putTraceSegmentsAsync
in interface AWSXRayAsync
asyncHandler
- 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<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSXRayAsync
Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.
tagResourceAsync
in interface AWSXRayAsync
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSXRayAsync
Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.
tagResourceAsync
in interface AWSXRayAsync
asyncHandler
- 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<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSXRayAsync
Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags
(those with an aws:
prefix).
untagResourceAsync
in interface AWSXRayAsync
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSXRayAsync
Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags
(those with an aws:
prefix).
untagResourceAsync
in interface AWSXRayAsync
asyncHandler
- 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<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest request)
AWSXRayAsync
Updates a group resource.
updateGroupAsync
in interface AWSXRayAsync
public Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest request, AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler)
AWSXRayAsync
Updates a group resource.
updateGroupAsync
in interface AWSXRayAsync
asyncHandler
- 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<UpdateSamplingRuleResult> updateSamplingRuleAsync(UpdateSamplingRuleRequest request)
AWSXRayAsync
Modifies a sampling rule's configuration.
updateSamplingRuleAsync
in interface AWSXRayAsync
public Future<UpdateSamplingRuleResult> updateSamplingRuleAsync(UpdateSamplingRuleRequest request, AsyncHandler<UpdateSamplingRuleRequest,UpdateSamplingRuleResult> asyncHandler)
AWSXRayAsync
Modifies a sampling rule's configuration.
updateSamplingRuleAsync
in interface AWSXRayAsync
asyncHandler
- 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 AWSXRay
shutdown
in class AWSXRayClient