@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.
|
CreateGroupResult |
createGroup(CreateGroupRequest request)
Creates a group resource with a name and a filter expression.
|
CreateSamplingRuleResult |
createSamplingRule(CreateSamplingRuleRequest request)
Creates a rule to control sampling behavior for instrumented applications.
|
DeleteGroupResult |
deleteGroup(DeleteGroupRequest request)
Deletes a group resource.
|
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest request)
Deletes a resource policy from the target Amazon Web Services account.
|
DeleteSamplingRuleResult |
deleteSamplingRule(DeleteSamplingRuleRequest request)
Deletes a sampling rule.
|
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.
|
GetEncryptionConfigResult |
getEncryptionConfig(GetEncryptionConfigRequest request)
Retrieves the current encryption configuration for X-Ray data.
|
GetGroupResult |
getGroup(GetGroupRequest request)
Retrieves group resource details.
|
GetGroupsResult |
getGroups(GetGroupsRequest request)
Retrieves all active group details.
|
GetInsightResult |
getInsight(GetInsightRequest request)
Retrieves the summary information of an insight.
|
GetInsightEventsResult |
getInsightEvents(GetInsightEventsRequest request)
X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event.
|
GetInsightImpactGraphResult |
getInsightImpactGraph(GetInsightImpactGraphRequest request)
Retrieves a service graph structure filtered by the specified insight.
|
GetInsightSummariesResult |
getInsightSummaries(GetInsightSummariesRequest request)
Retrieves the summaries of all insights in the specified group matching the provided filter values.
|
GetSamplingRulesResult |
getSamplingRules(GetSamplingRulesRequest request)
Retrieves all sampling rules.
|
GetSamplingStatisticSummariesResult |
getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest request)
Retrieves information about recent sampling results for all sampling rules.
|
GetSamplingTargetsResult |
getSamplingTargets(GetSamplingTargetsRequest request)
Requests a sampling quota for rules that the service is using to sample requests.
|
GetServiceGraphResult |
getServiceGraph(GetServiceGraphRequest request)
Retrieves a document that describes services that process incoming requests, and downstream services that they
call as a result.
|
GetTimeSeriesServiceStatisticsResult |
getTimeSeriesServiceStatistics(GetTimeSeriesServiceStatisticsRequest request)
Get an aggregation of service statistics defined by a specific time range.
|
GetTraceGraphResult |
getTraceGraph(GetTraceGraphRequest request)
Retrieves a service graph for one or more specific trace IDs.
|
GetTraceSummariesResult |
getTraceSummaries(GetTraceSummariesRequest request)
Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.
|
ListResourcePoliciesResult |
listResourcePolicies(ListResourcePoliciesRequest request)
Returns the list of resource policies in the target Amazon Web Services account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
|
PutEncryptionConfigResult |
putEncryptionConfig(PutEncryptionConfigRequest request)
Updates the encryption configuration for X-Ray data.
|
PutResourcePolicyResult |
putResourcePolicy(PutResourcePolicyRequest request)
Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access
X-Ray.
|
PutTelemetryRecordsResult |
putTelemetryRecords(PutTelemetryRecordsRequest request)
Used by the Amazon Web Services X-Ray daemon to upload telemetry.
|
PutTraceSegmentsResult |
putTraceSegments(PutTraceSegmentsRequest request)
Uploads segment documents to Amazon Web Services 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.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes tags from an Amazon Web Services X-Ray group or sampling rule.
|
UpdateGroupResult |
updateGroup(UpdateGroupRequest request)
Updates a group resource.
|
UpdateSamplingRuleResult |
updateSamplingRule(UpdateSamplingRuleRequest request)
Modifies a sampling rule's configuration.
|
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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
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 CreateGroupResult createGroup(CreateGroupRequest request)
AWSXRayCreates a group resource with a name and a filter expression.
createGroup in interface AWSXRaypublic CreateSamplingRuleResult createSamplingRule(CreateSamplingRuleRequest request)
AWSXRayCreates 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.
createSamplingRule in interface AWSXRaypublic DeleteGroupResult deleteGroup(DeleteGroupRequest request)
AWSXRayDeletes a group resource.
deleteGroup in interface AWSXRaypublic DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)
AWSXRayDeletes a resource policy from the target Amazon Web Services account.
deleteResourcePolicy in interface AWSXRaypublic DeleteSamplingRuleResult deleteSamplingRule(DeleteSamplingRuleRequest request)
AWSXRayDeletes a sampling rule.
deleteSamplingRule in interface AWSXRaypublic GetEncryptionConfigResult getEncryptionConfig(GetEncryptionConfigRequest request)
AWSXRayRetrieves the current encryption configuration for X-Ray data.
getEncryptionConfig in interface AWSXRaypublic GetGroupResult getGroup(GetGroupRequest request)
AWSXRayRetrieves group resource details.
getGroup in interface AWSXRaypublic GetGroupsResult getGroups(GetGroupsRequest request)
AWSXRayRetrieves all active group details.
getGroups in interface AWSXRaypublic GetInsightResult getInsight(GetInsightRequest request)
AWSXRayRetrieves 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.
getInsight in interface AWSXRaypublic GetInsightEventsResult getInsightEvents(GetInsightEventsRequest request)
AWSXRayX-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.
getInsightEvents in interface AWSXRaypublic GetInsightImpactGraphResult getInsightImpactGraph(GetInsightImpactGraphRequest request)
AWSXRayRetrieves 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.
getInsightImpactGraph in interface AWSXRaypublic GetInsightSummariesResult getInsightSummaries(GetInsightSummariesRequest request)
AWSXRayRetrieves the summaries of all insights in the specified group matching the provided filter values.
getInsightSummaries in interface AWSXRaypublic GetSamplingRulesResult getSamplingRules(GetSamplingRulesRequest request)
AWSXRayRetrieves all sampling rules.
getSamplingRules in interface AWSXRaypublic GetSamplingStatisticSummariesResult getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest request)
AWSXRayRetrieves information about recent sampling results for all sampling rules.
getSamplingStatisticSummaries in interface AWSXRaypublic GetSamplingTargetsResult getSamplingTargets(GetSamplingTargetsRequest request)
AWSXRayRequests a sampling quota for rules that the service is using to sample requests.
getSamplingTargets 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 Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.
getServiceGraph in interface AWSXRaypublic GetTimeSeriesServiceStatisticsResult getTimeSeriesServiceStatistics(GetTimeSeriesServiceStatisticsRequest request)
AWSXRayGet an aggregation of service statistics defined by a specific time range.
getTimeSeriesServiceStatistics 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 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.
getTraceSummaries in interface AWSXRaypublic ListResourcePoliciesResult listResourcePolicies(ListResourcePoliciesRequest request)
AWSXRayReturns the list of resource policies in the target Amazon Web Services account.
listResourcePolicies in interface AWSXRaypublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSXRayReturns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
listTagsForResource in interface AWSXRaypublic PutEncryptionConfigResult putEncryptionConfig(PutEncryptionConfigRequest request)
AWSXRayUpdates the encryption configuration for X-Ray data.
putEncryptionConfig in interface AWSXRaypublic PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)
AWSXRaySets 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.
putResourcePolicy in interface AWSXRaypublic PutTelemetryRecordsResult putTelemetryRecords(PutTelemetryRecordsRequest request)
AWSXRayUsed by the Amazon Web Services X-Ray daemon to upload telemetry.
putTelemetryRecords in interface AWSXRaypublic PutTraceSegmentsResult putTraceSegments(PutTraceSegmentsRequest request)
AWSXRayUploads 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.
putTraceSegments in interface AWSXRaypublic TagResourceResult tagResource(TagResourceRequest request)
AWSXRayApplies tags to an existing Amazon Web Services X-Ray group or sampling rule.
tagResource in interface AWSXRaypublic UntagResourceResult untagResource(UntagResourceRequest request)
AWSXRay
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).
untagResource in interface AWSXRaypublic UpdateGroupResult updateGroup(UpdateGroupRequest request)
AWSXRayUpdates a group resource.
updateGroup in interface AWSXRaypublic UpdateSamplingRuleResult updateSamplingRule(UpdateSamplingRuleRequest request)
AWSXRayModifies a sampling rule's configuration.
updateSamplingRule 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.