Struct rusoto_xray::XRayClient
[−]
[src]
pub struct XRayClient<P, D> where
P: ProvideAwsCredentials,
D: DispatchSignedRequest, { /* fields omitted */ }
A client for the AWS X-Ray API.
Methods
impl<P, D> XRayClient<P, D> where
P: ProvideAwsCredentials,
D: DispatchSignedRequest,
[src]
P: ProvideAwsCredentials,
D: DispatchSignedRequest,
Trait Implementations
impl<P, D> XRay for XRayClient<P, D> where
P: ProvideAwsCredentials,
D: DispatchSignedRequest,
[src]
P: ProvideAwsCredentials,
D: DispatchSignedRequest,
fn batch_get_traces(
&self,
input: &BatchGetTracesRequest
) -> Result<BatchGetTracesResult, BatchGetTracesError>
[src]
&self,
input: &BatchGetTracesRequest
) -> Result<BatchGetTracesResult, BatchGetTracesError>
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.
fn get_service_graph(
&self,
input: &GetServiceGraphRequest
) -> Result<GetServiceGraphResult, GetServiceGraphError>
[src]
&self,
input: &GetServiceGraphRequest
) -> Result<GetServiceGraphResult, GetServiceGraphError>
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.
fn get_trace_graph(
&self,
input: &GetTraceGraphRequest
) -> Result<GetTraceGraphResult, GetTraceGraphError>
[src]
&self,
input: &GetTraceGraphRequest
) -> Result<GetTraceGraphResult, GetTraceGraphError>
Retrieves a service graph for one or more specific trace IDs.
fn get_trace_summaries(
&self,
input: &GetTraceSummariesRequest
) -> Result<GetTraceSummariesResult, GetTraceSummariesError>
[src]
&self,
input: &GetTraceSummariesRequest
) -> Result<GetTraceSummariesResult, GetTraceSummariesError>
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.
fn put_telemetry_records(
&self,
input: &PutTelemetryRecordsRequest
) -> Result<PutTelemetryRecordsResult, PutTelemetryRecordsError>
[src]
&self,
input: &PutTelemetryRecordsRequest
) -> Result<PutTelemetryRecordsResult, PutTelemetryRecordsError>
Used by the AWS X-Ray daemon to upload telemetry.
fn put_trace_segments(
&self,
input: &PutTraceSegmentsRequest
) -> Result<PutTraceSegmentsResult, PutTraceSegmentsError>
[src]
&self,
input: &PutTraceSegmentsRequest
) -> Result<PutTraceSegmentsResult, PutTraceSegmentsError>
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
or1.480615200010E9
. -
end_time
- Time the segment or subsegment was closed. For example,1480615200.090
or1.480615200090E9
. Specify either anend_time
orin_progress
. -
in_progress
- Set totrue
instead of specifying anend_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, or58406520
in hexadecimal. -
A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.