@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSXRay extends Object implements AWSXRay
AWSXRay. Convenient method forms pass through to the corresponding overload that
takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
BatchGetTracesResult |
batchGetTraces(BatchGetTracesRequest request)
Retrieves a list of traces specified by ID.
|
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.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("xray.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSXRay.setEndpoint(String), sets the regional endpoint for this client's service
calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
public void setEndpoint(String endpoint)
AWSXRay
Callers can pass in just the endpoint (ex: "xray.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "xray.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this
client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint in interface AWSXRayendpoint - The endpoint (ex: "xray.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"xray.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.public void setRegion(Region region)
AWSXRayAWSXRay.setEndpoint(String), sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion in interface AWSXRayregion - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public BatchGetTracesResult batchGetTraces(BatchGetTracesRequest request)
AWSXRay
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 AWSXRaypublic GetServiceGraphResult getServiceGraph(GetServiceGraphRequest request)
AWSXRayRetrieves 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 AWSXRaypublic GetTraceGraphResult getTraceGraph(GetTraceGraphRequest request)
AWSXRayRetrieves a service graph for one or more specific trace IDs.
getTraceGraph in interface AWSXRaypublic GetTraceSummariesResult getTraceSummaries(GetTraceSummariesRequest request)
AWSXRay
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 AWSXRaypublic PutTelemetryRecordsResult putTelemetryRecords(PutTelemetryRecordsRequest request)
AWSXRayUsed by the AWS X-Ray daemon to upload telemetry.
putTelemetryRecords in interface AWSXRaypublic PutTraceSegmentsResult putTraceSegments(PutTraceSegmentsRequest request)
AWSXRayUploads 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 AWSXRaypublic void shutdown()
AWSXRaypublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSXRayResponse 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 a request.
getCachedResponseMetadata in interface AWSXRayrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.