AWS.XRay (aws-elixir v0.8.0) View Source

AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.

Link to this section Summary

Functions

Retrieves a list of traces specified by ID.

Creates a group resource with a name and a filter expression.

Creates a rule to control sampling behavior for instrumented applications.

Deletes a group resource.

Retrieves the current encryption configuration for X-Ray data.

Retrieves group resource details.

Retrieves all active group details.

Retrieves the summary information of an insight.

X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event.

Retrieves a service graph structure filtered by the specified insight.

Retrieves the summaries of all insights in the specified group matching the provided filter values.

Retrieves all sampling rules.

Retrieves information about recent sampling results for all sampling rules.

Requests a sampling quota for rules that the service is using to sample requests.

Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result.

Get an aggregation of service statistics defined by a specific time range.

Retrieves a service graph for one or more specific trace IDs.

Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.

Returns a list of tags that are applied to the specified AWS X-Ray group or sampling rule.

Updates the encryption configuration for X-Ray data.

Used by the AWS X-Ray daemon to upload telemetry.

Uploads segment documents to AWS X-Ray.

Applies tags to an existing AWS X-Ray group or sampling rule.

Removes tags from an AWS X-Ray group or sampling rule.

Updates a group resource.

Modifies a sampling rule's configuration.

Link to this section Functions

Link to this function

batch_get_traces(client, input, options \\ [])

View Source

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.

Link to this function

create_group(client, input, options \\ [])

View Source

Creates a group resource with a name and a filter expression.

Link to this function

create_sampling_rule(client, input, options \\ [])

View Source

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.

Link to this function

delete_group(client, input, options \\ [])

View Source

Deletes a group resource.

Link to this function

delete_sampling_rule(client, input, options \\ [])

View Source

Deletes a sampling rule.

Link to this function

get_encryption_config(client, input, options \\ [])

View Source

Retrieves the current encryption configuration for X-Ray data.

Link to this function

get_group(client, input, options \\ [])

View Source

Retrieves group resource details.

Link to this function

get_groups(client, input, options \\ [])

View Source

Retrieves all active group details.

Link to this function

get_insight(client, input, options \\ [])

View Source

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.

Link to this function

get_insight_events(client, input, options \\ [])

View Source

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.

Link to this function

get_insight_impact_graph(client, input, options \\ [])

View Source

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.

Link to this function

get_insight_summaries(client, input, options \\ [])

View Source

Retrieves the summaries of all insights in the specified group matching the provided filter values.

Link to this function

get_sampling_rules(client, input, options \\ [])

View Source

Retrieves all sampling rules.

Link to this function

get_sampling_statistic_summaries(client, input, options \\ [])

View Source

Retrieves information about recent sampling results for all sampling rules.

Link to this function

get_sampling_targets(client, input, options \\ [])

View Source

Requests a sampling quota for rules that the service is using to sample requests.

Link to this function

get_service_graph(client, input, options \\ [])

View Source

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.

Link to this function

get_time_series_service_statistics(client, input, options \\ [])

View Source

Get an aggregation of service statistics defined by a specific time range.

Link to this function

get_trace_graph(client, input, options \\ [])

View Source

Retrieves a service graph for one or more specific trace IDs.

Link to this function

get_trace_summaries(client, input, options \\ [])

View Source

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.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Returns a list of tags that are applied to the specified AWS X-Ray group or sampling rule.

Link to this function

put_encryption_config(client, input, options \\ [])

View Source

Updates the encryption configuration for X-Ray data.

Link to this function

put_telemetry_records(client, input, options \\ [])

View Source

Used by the AWS X-Ray daemon to upload telemetry.

Link to this function

put_trace_segments(client, input, options \\ [])

View Source

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 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.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Applies tags to an existing AWS X-Ray group or sampling rule.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes tags from an AWS X-Ray group or sampling rule.

You cannot edit or delete system tags (those with an aws: prefix).

Link to this function

update_group(client, input, options \\ [])

View Source

Updates a group resource.

Link to this function

update_sampling_rule(client, input, options \\ [])

View Source

Modifies a sampling rule's configuration.