Struct rusoto_xray::XRayClient
source · [−]pub struct XRayClient { /* private fields */ }
Expand description
A client for the AWS X-Ray API.
Implementations
sourceimpl XRayClient
impl XRayClient
sourcepub fn new(region: Region) -> XRayClient
pub fn new(region: Region) -> XRayClient
Creates a client backed by the default tokio event loop.
The client will use the default credentials provider and tls client.
pub fn new_with<P, D>(
request_dispatcher: D,
credentials_provider: P,
region: Region
) -> XRayClient where
P: ProvideAwsCredentials + Send + Sync + 'static,
D: DispatchSignedRequest + Send + Sync + 'static,
pub fn new_with_client(client: Client, region: Region) -> XRayClient
Trait Implementations
sourceimpl Clone for XRayClient
impl Clone for XRayClient
sourcefn clone(&self) -> XRayClient
fn clone(&self) -> XRayClient
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl XRay for XRayClient
impl XRay for XRayClient
sourcefn batch_get_traces<'life0, 'async_trait>(
&'life0 self,
input: BatchGetTracesRequest
) -> Pin<Box<dyn Future<Output = Result<BatchGetTracesResult, RusotoError<BatchGetTracesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn batch_get_traces<'life0, 'async_trait>(
&'life0 self,
input: BatchGetTracesRequest
) -> Pin<Box<dyn Future<Output = Result<BatchGetTracesResult, RusotoError<BatchGetTracesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
sourcefn create_group<'life0, 'async_trait>(
&'life0 self,
input: CreateGroupRequest
) -> Pin<Box<dyn Future<Output = Result<CreateGroupResult, RusotoError<CreateGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn create_group<'life0, 'async_trait>(
&'life0 self,
input: CreateGroupRequest
) -> Pin<Box<dyn Future<Output = Result<CreateGroupResult, RusotoError<CreateGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Creates a group resource with a name and a filter expression.
sourcefn create_sampling_rule<'life0, 'async_trait>(
&'life0 self,
input: CreateSamplingRuleRequest
) -> Pin<Box<dyn Future<Output = Result<CreateSamplingRuleResult, RusotoError<CreateSamplingRuleError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn create_sampling_rule<'life0, 'async_trait>(
&'life0 self,
input: CreateSamplingRuleRequest
) -> Pin<Box<dyn Future<Output = Result<CreateSamplingRuleResult, RusotoError<CreateSamplingRuleError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
sourcefn delete_group<'life0, 'async_trait>(
&'life0 self,
input: DeleteGroupRequest
) -> Pin<Box<dyn Future<Output = Result<DeleteGroupResult, RusotoError<DeleteGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn delete_group<'life0, 'async_trait>(
&'life0 self,
input: DeleteGroupRequest
) -> Pin<Box<dyn Future<Output = Result<DeleteGroupResult, RusotoError<DeleteGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Deletes a group resource.
sourcefn delete_sampling_rule<'life0, 'async_trait>(
&'life0 self,
input: DeleteSamplingRuleRequest
) -> Pin<Box<dyn Future<Output = Result<DeleteSamplingRuleResult, RusotoError<DeleteSamplingRuleError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn delete_sampling_rule<'life0, 'async_trait>(
&'life0 self,
input: DeleteSamplingRuleRequest
) -> Pin<Box<dyn Future<Output = Result<DeleteSamplingRuleResult, RusotoError<DeleteSamplingRuleError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Deletes a sampling rule.
sourcefn get_encryption_config<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<GetEncryptionConfigResult, RusotoError<GetEncryptionConfigError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_encryption_config<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<GetEncryptionConfigResult, RusotoError<GetEncryptionConfigError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Retrieves the current encryption configuration for X-Ray data.
sourcefn get_group<'life0, 'async_trait>(
&'life0 self,
input: GetGroupRequest
) -> Pin<Box<dyn Future<Output = Result<GetGroupResult, RusotoError<GetGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_group<'life0, 'async_trait>(
&'life0 self,
input: GetGroupRequest
) -> Pin<Box<dyn Future<Output = Result<GetGroupResult, RusotoError<GetGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Retrieves group resource details.
sourcefn get_groups<'life0, 'async_trait>(
&'life0 self,
input: GetGroupsRequest
) -> Pin<Box<dyn Future<Output = Result<GetGroupsResult, RusotoError<GetGroupsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_groups<'life0, 'async_trait>(
&'life0 self,
input: GetGroupsRequest
) -> Pin<Box<dyn Future<Output = Result<GetGroupsResult, RusotoError<GetGroupsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Retrieves all active group details.
sourcefn get_insight<'life0, 'async_trait>(
&'life0 self,
input: GetInsightRequest
) -> Pin<Box<dyn Future<Output = Result<GetInsightResult, RusotoError<GetInsightError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_insight<'life0, 'async_trait>(
&'life0 self,
input: GetInsightRequest
) -> Pin<Box<dyn Future<Output = Result<GetInsightResult, RusotoError<GetInsightError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
sourcefn get_insight_events<'life0, 'async_trait>(
&'life0 self,
input: GetInsightEventsRequest
) -> Pin<Box<dyn Future<Output = Result<GetInsightEventsResult, RusotoError<GetInsightEventsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_insight_events<'life0, 'async_trait>(
&'life0 self,
input: GetInsightEventsRequest
) -> Pin<Box<dyn Future<Output = Result<GetInsightEventsResult, RusotoError<GetInsightEventsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
sourcefn get_insight_impact_graph<'life0, 'async_trait>(
&'life0 self,
input: GetInsightImpactGraphRequest
) -> Pin<Box<dyn Future<Output = Result<GetInsightImpactGraphResult, RusotoError<GetInsightImpactGraphError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_insight_impact_graph<'life0, 'async_trait>(
&'life0 self,
input: GetInsightImpactGraphRequest
) -> Pin<Box<dyn Future<Output = Result<GetInsightImpactGraphResult, RusotoError<GetInsightImpactGraphError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
sourcefn get_insight_summaries<'life0, 'async_trait>(
&'life0 self,
input: GetInsightSummariesRequest
) -> Pin<Box<dyn Future<Output = Result<GetInsightSummariesResult, RusotoError<GetInsightSummariesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_insight_summaries<'life0, 'async_trait>(
&'life0 self,
input: GetInsightSummariesRequest
) -> Pin<Box<dyn Future<Output = Result<GetInsightSummariesResult, RusotoError<GetInsightSummariesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Retrieves the summaries of all insights in the specified group matching the provided filter values.
sourcefn get_sampling_rules<'life0, 'async_trait>(
&'life0 self,
input: GetSamplingRulesRequest
) -> Pin<Box<dyn Future<Output = Result<GetSamplingRulesResult, RusotoError<GetSamplingRulesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_sampling_rules<'life0, 'async_trait>(
&'life0 self,
input: GetSamplingRulesRequest
) -> Pin<Box<dyn Future<Output = Result<GetSamplingRulesResult, RusotoError<GetSamplingRulesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Retrieves all sampling rules.
sourcefn get_sampling_statistic_summaries<'life0, 'async_trait>(
&'life0 self,
input: GetSamplingStatisticSummariesRequest
) -> Pin<Box<dyn Future<Output = Result<GetSamplingStatisticSummariesResult, RusotoError<GetSamplingStatisticSummariesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_sampling_statistic_summaries<'life0, 'async_trait>(
&'life0 self,
input: GetSamplingStatisticSummariesRequest
) -> Pin<Box<dyn Future<Output = Result<GetSamplingStatisticSummariesResult, RusotoError<GetSamplingStatisticSummariesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Retrieves information about recent sampling results for all sampling rules.
sourcefn get_sampling_targets<'life0, 'async_trait>(
&'life0 self,
input: GetSamplingTargetsRequest
) -> Pin<Box<dyn Future<Output = Result<GetSamplingTargetsResult, RusotoError<GetSamplingTargetsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_sampling_targets<'life0, 'async_trait>(
&'life0 self,
input: GetSamplingTargetsRequest
) -> Pin<Box<dyn Future<Output = Result<GetSamplingTargetsResult, RusotoError<GetSamplingTargetsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Requests a sampling quota for rules that the service is using to sample requests.
sourcefn get_service_graph<'life0, 'async_trait>(
&'life0 self,
input: GetServiceGraphRequest
) -> Pin<Box<dyn Future<Output = Result<GetServiceGraphResult, RusotoError<GetServiceGraphError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_service_graph<'life0, 'async_trait>(
&'life0 self,
input: GetServiceGraphRequest
) -> Pin<Box<dyn Future<Output = Result<GetServiceGraphResult, RusotoError<GetServiceGraphError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
sourcefn get_time_series_service_statistics<'life0, 'async_trait>(
&'life0 self,
input: GetTimeSeriesServiceStatisticsRequest
) -> Pin<Box<dyn Future<Output = Result<GetTimeSeriesServiceStatisticsResult, RusotoError<GetTimeSeriesServiceStatisticsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_time_series_service_statistics<'life0, 'async_trait>(
&'life0 self,
input: GetTimeSeriesServiceStatisticsRequest
) -> Pin<Box<dyn Future<Output = Result<GetTimeSeriesServiceStatisticsResult, RusotoError<GetTimeSeriesServiceStatisticsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Get an aggregation of service statistics defined by a specific time range.
sourcefn get_trace_graph<'life0, 'async_trait>(
&'life0 self,
input: GetTraceGraphRequest
) -> Pin<Box<dyn Future<Output = Result<GetTraceGraphResult, RusotoError<GetTraceGraphError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_trace_graph<'life0, 'async_trait>(
&'life0 self,
input: GetTraceGraphRequest
) -> Pin<Box<dyn Future<Output = Result<GetTraceGraphResult, RusotoError<GetTraceGraphError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Retrieves a service graph for one or more specific trace IDs.
sourcefn get_trace_summaries<'life0, 'async_trait>(
&'life0 self,
input: GetTraceSummariesRequest
) -> Pin<Box<dyn Future<Output = Result<GetTraceSummariesResult, RusotoError<GetTraceSummariesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_trace_summaries<'life0, 'async_trait>(
&'life0 self,
input: GetTraceSummariesRequest
) -> Pin<Box<dyn Future<Output = Result<GetTraceSummariesResult, RusotoError<GetTraceSummariesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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 AWS X-Ray Developer Guide.
Returns a list of tags that are applied to the specified AWS X-Ray group or sampling rule.
sourcefn put_encryption_config<'life0, 'async_trait>(
&'life0 self,
input: PutEncryptionConfigRequest
) -> Pin<Box<dyn Future<Output = Result<PutEncryptionConfigResult, RusotoError<PutEncryptionConfigError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn put_encryption_config<'life0, 'async_trait>(
&'life0 self,
input: PutEncryptionConfigRequest
) -> Pin<Box<dyn Future<Output = Result<PutEncryptionConfigResult, RusotoError<PutEncryptionConfigError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Updates the encryption configuration for X-Ray data.
sourcefn put_telemetry_records<'life0, 'async_trait>(
&'life0 self,
input: PutTelemetryRecordsRequest
) -> Pin<Box<dyn Future<Output = Result<PutTelemetryRecordsResult, RusotoError<PutTelemetryRecordsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn put_telemetry_records<'life0, 'async_trait>(
&'life0 self,
input: PutTelemetryRecordsRequest
) -> Pin<Box<dyn Future<Output = Result<PutTelemetryRecordsResult, RusotoError<PutTelemetryRecordsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Used by the AWS X-Ray daemon to upload telemetry.
sourcefn put_trace_segments<'life0, 'async_trait>(
&'life0 self,
input: PutTraceSegmentsRequest
) -> Pin<Box<dyn Future<Output = Result<PutTraceSegmentsResult, RusotoError<PutTraceSegmentsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn put_trace_segments<'life0, 'async_trait>(
&'life0 self,
input: PutTraceSegmentsRequest
) -> Pin<Box<dyn Future<Output = Result<PutTraceSegmentsResult, RusotoError<PutTraceSegmentsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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. -
traceid
- A unique identifier that connects all segments and subsegments originating from a single client request. -
starttime
- Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example,1480615200.010
or1.480615200010E9
. -
endtime
- Time the segment or subsegment was closed. For example,1480615200.090
or1.480615200090E9
. Specify either anendtime
orinprogress
. -
inprogress
- Set totrue
instead of specifying anendtime
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 traceid
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, or58406520
in hexadecimal. -
A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.
sourcefn tag_resource<'life0, 'async_trait>(
&'life0 self,
input: TagResourceRequest
) -> Pin<Box<dyn Future<Output = Result<TagResourceResponse, RusotoError<TagResourceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn tag_resource<'life0, 'async_trait>(
&'life0 self,
input: TagResourceRequest
) -> Pin<Box<dyn Future<Output = Result<TagResourceResponse, RusotoError<TagResourceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Applies tags to an existing AWS X-Ray group or sampling rule.
sourcefn untag_resource<'life0, 'async_trait>(
&'life0 self,
input: UntagResourceRequest
) -> Pin<Box<dyn Future<Output = Result<UntagResourceResponse, RusotoError<UntagResourceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn untag_resource<'life0, 'async_trait>(
&'life0 self,
input: UntagResourceRequest
) -> Pin<Box<dyn Future<Output = Result<UntagResourceResponse, RusotoError<UntagResourceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Removes tags from an AWS X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws:
prefix).
sourcefn update_group<'life0, 'async_trait>(
&'life0 self,
input: UpdateGroupRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateGroupResult, RusotoError<UpdateGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn update_group<'life0, 'async_trait>(
&'life0 self,
input: UpdateGroupRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateGroupResult, RusotoError<UpdateGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Updates a group resource.
sourcefn update_sampling_rule<'life0, 'async_trait>(
&'life0 self,
input: UpdateSamplingRuleRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateSamplingRuleResult, RusotoError<UpdateSamplingRuleError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn update_sampling_rule<'life0, 'async_trait>(
&'life0 self,
input: UpdateSamplingRuleRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateSamplingRuleResult, RusotoError<UpdateSamplingRuleError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Modifies a sampling rule's configuration.
Auto Trait Implementations
impl !RefUnwindSafe for XRayClient
impl Send for XRayClient
impl Sync for XRayClient
impl Unpin for XRayClient
impl !UnwindSafe for XRayClient
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more