@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSXRayClient extends AmazonWebServiceClient implements AWSXRay
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 |
|---|
AWSXRayClient()
Deprecated.
|
AWSXRayClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSXRayClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSXRayClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSXRayClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSXRayClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSXRayClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSXRayClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
BatchGetTracesResult |
batchGetTraces(BatchGetTracesRequest request)
Retrieves a list of traces specified by ID.
|
static AWSXRayClientBuilder |
builder() |
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetServiceGraphResult |
getServiceGraph(GetServiceGraphRequest request)
Retrieves a document that describes services that process incoming requests, and downstream services that they
call as a result.
|
GetTraceGraphResult |
getTraceGraph(GetTraceGraphRequest request)
Retrieves a service graph for one or more specific trace IDs.
|
GetTraceSummariesResult |
getTraceSummaries(GetTraceSummariesRequest request)
Retrieves IDs and metadata for traces available for a specified time frame using an optional filter.
|
PutTelemetryRecordsResult |
putTelemetryRecords(PutTelemetryRecordsRequest request)
Used by the AWS X-Ray daemon to upload telemetry.
|
PutTraceSegmentsResult |
putTraceSegments(PutTraceSegmentsRequest request)
Uploads segment documents to AWS X-Ray.
|
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdown@Deprecated public AWSXRayClient()
AWSXRayClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AWSXRayClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to AWS X-Ray (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AWSXRayClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSXRayClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSXRayClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS X-Ray (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSXRayClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSXRayClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS X-Ray (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSXRayClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS X-Ray (ex: proxy settings,
retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AWSXRayClientBuilder builder()
public BatchGetTracesResult batchGetTraces(BatchGetTracesRequest request)
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.
batchGetTraces in interface AWSXRaybatchGetTracesRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.public GetServiceGraphResult getServiceGraph(GetServiceGraphRequest request)
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.
getServiceGraph in interface AWSXRaygetServiceGraphRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.public GetTraceGraphResult getTraceGraph(GetTraceGraphRequest request)
Retrieves a service graph for one or more specific trace IDs.
getTraceGraph in interface AWSXRaygetTraceGraphRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.public GetTraceSummariesResult getTraceSummaries(GetTraceSummariesRequest request)
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.
getTraceSummaries in interface AWSXRaygetTraceSummariesRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.public PutTelemetryRecordsResult putTelemetryRecords(PutTelemetryRecordsRequest request)
Used by the AWS X-Ray daemon to upload telemetry.
putTelemetryRecords in interface AWSXRayputTelemetryRecordsRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.public PutTraceSegmentsResult putTraceSegments(PutTraceSegmentsRequest request)
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.
putTraceSegments in interface AWSXRayputTraceSegmentsRequest - InvalidRequestException - The request is missing required parameters or has invalid parameters.ThrottledException - The request exceeds the maximum number of requests per second.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AWSXRayrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.