NAME

Paws::XRay - Perl Interface to AWS AWS X-Ray

SYNOPSIS

use Paws;

my $obj = Paws->service('XRay');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

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

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12

METHODS

BatchGetTraces

TraceIds => ArrayRef[Str|Undef]
[NextToken => Str]

Each argument is described in detail in: Paws::XRay::BatchGetTraces

Returns: a Paws::XRay::BatchGetTracesResult instance

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.

CreateGroup

GroupName => Str
[FilterExpression => Str]
[InsightsConfiguration => Paws::XRay::InsightsConfiguration]
[Tags => ArrayRef[Paws::XRay::Tag]]

Each argument is described in detail in: Paws::XRay::CreateGroup

Returns: a Paws::XRay::CreateGroupResult instance

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

CreateSamplingRule

SamplingRule => Paws::XRay::SamplingRule
[Tags => ArrayRef[Paws::XRay::Tag]]

Each argument is described in detail in: Paws::XRay::CreateSamplingRule

Returns: a Paws::XRay::CreateSamplingRuleResult instance

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.

DeleteGroup

[GroupARN => Str]
[GroupName => Str]

Each argument is described in detail in: Paws::XRay::DeleteGroup

Returns: a Paws::XRay::DeleteGroupResult instance

Deletes a group resource.

DeleteSamplingRule

[RuleARN => Str]
[RuleName => Str]

Each argument is described in detail in: Paws::XRay::DeleteSamplingRule

Returns: a Paws::XRay::DeleteSamplingRuleResult instance

Deletes a sampling rule.

GetEncryptionConfig

Each argument is described in detail in: Paws::XRay::GetEncryptionConfig

Returns: a Paws::XRay::GetEncryptionConfigResult instance

Retrieves the current encryption configuration for X-Ray data.

GetGroup

[GroupARN => Str]
[GroupName => Str]

Each argument is described in detail in: Paws::XRay::GetGroup

Returns: a Paws::XRay::GetGroupResult instance

Retrieves group resource details.

GetGroups

[NextToken => Str]

Each argument is described in detail in: Paws::XRay::GetGroups

Returns: a Paws::XRay::GetGroupsResult instance

Retrieves all active group details.

GetInsight

InsightId => Str

Each argument is described in detail in: Paws::XRay::GetInsight

Returns: a Paws::XRay::GetInsightResult instance

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.

GetInsightEvents

InsightId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::XRay::GetInsightEvents

Returns: a Paws::XRay::GetInsightEventsResult instance

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.

GetInsightImpactGraph

EndTime => Str
InsightId => Str
StartTime => Str
[NextToken => Str]

Each argument is described in detail in: Paws::XRay::GetInsightImpactGraph

Returns: a Paws::XRay::GetInsightImpactGraphResult instance

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.

GetInsightSummaries

EndTime => Str
StartTime => Str
[GroupARN => Str]
[GroupName => Str]
[MaxResults => Int]
[NextToken => Str]
[States => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::XRay::GetInsightSummaries

Returns: a Paws::XRay::GetInsightSummariesResult instance

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

GetSamplingRules

[NextToken => Str]

Each argument is described in detail in: Paws::XRay::GetSamplingRules

Returns: a Paws::XRay::GetSamplingRulesResult instance

Retrieves all sampling rules.

GetSamplingStatisticSummaries

[NextToken => Str]

Each argument is described in detail in: Paws::XRay::GetSamplingStatisticSummaries

Returns: a Paws::XRay::GetSamplingStatisticSummariesResult instance

Retrieves information about recent sampling results for all sampling rules.

GetSamplingTargets

SamplingStatisticsDocuments => ArrayRef[Paws::XRay::SamplingStatisticsDocument]

Each argument is described in detail in: Paws::XRay::GetSamplingTargets

Returns: a Paws::XRay::GetSamplingTargetsResult instance

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

GetServiceGraph

EndTime => Str
StartTime => Str
[GroupARN => Str]
[GroupName => Str]
[NextToken => Str]

Each argument is described in detail in: Paws::XRay::GetServiceGraph

Returns: a Paws::XRay::GetServiceGraphResult instance

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 (https://docs.aws.amazon.com/xray/index.html). Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.

GetTimeSeriesServiceStatistics

EndTime => Str
StartTime => Str
[EntitySelectorExpression => Str]
[ForecastStatistics => Bool]
[GroupARN => Str]
[GroupName => Str]
[NextToken => Str]
[Period => Int]

Each argument is described in detail in: Paws::XRay::GetTimeSeriesServiceStatistics

Returns: a Paws::XRay::GetTimeSeriesServiceStatisticsResult instance

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

GetTraceGraph

TraceIds => ArrayRef[Str|Undef]
[NextToken => Str]

Each argument is described in detail in: Paws::XRay::GetTraceGraph

Returns: a Paws::XRay::GetTraceGraphResult instance

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

GetTraceSummaries

EndTime => Str
StartTime => Str
[FilterExpression => Str]
[NextToken => Str]
[Sampling => Bool]
[SamplingStrategy => Paws::XRay::SamplingStrategy]
[TimeRangeType => Str]

Each argument is described in detail in: Paws::XRay::GetTraceSummaries

Returns: a Paws::XRay::GetTraceSummariesResult instance

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 (https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html) in the AWS X-Ray Developer Guide.

ListTagsForResource

ResourceARN => Str
[NextToken => Str]

Each argument is described in detail in: Paws::XRay::ListTagsForResource

Returns: a Paws::XRay::ListTagsForResourceResponse instance

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

PutEncryptionConfig

Type => Str
[KeyId => Str]

Each argument is described in detail in: Paws::XRay::PutEncryptionConfig

Returns: a Paws::XRay::PutEncryptionConfigResult instance

Updates the encryption configuration for X-Ray data.

PutTelemetryRecords

TelemetryRecords => ArrayRef[Paws::XRay::TelemetryRecord]
[EC2InstanceId => Str]
[Hostname => Str]
[ResourceARN => Str]

Each argument is described in detail in: Paws::XRay::PutTelemetryRecords

Returns: a Paws::XRay::PutTelemetryRecordsResult instance

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

PutTraceSegments

TraceSegmentDocuments => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::XRay::PutTraceSegments

Returns: a Paws::XRay::PutTraceSegmentsResult instance

Uploads segment documents to AWS X-Ray. The X-Ray SDK (https://docs.aws.amazon.com/xray/index.html) 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 (https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html) 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.

TagResource

ResourceARN => Str
Tags => ArrayRef[Paws::XRay::Tag]

Each argument is described in detail in: Paws::XRay::TagResource

Returns: a Paws::XRay::TagResourceResponse instance

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

UntagResource

ResourceARN => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::XRay::UntagResource

Returns: a Paws::XRay::UntagResourceResponse instance

Removes tags from an AWS X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix).

UpdateGroup

[FilterExpression => Str]
[GroupARN => Str]
[GroupName => Str]
[InsightsConfiguration => Paws::XRay::InsightsConfiguration]

Each argument is described in detail in: Paws::XRay::UpdateGroup

Returns: a Paws::XRay::UpdateGroupResult instance

Updates a group resource.

UpdateSamplingRule

SamplingRuleUpdate => Paws::XRay::SamplingRuleUpdate

Each argument is described in detail in: Paws::XRay::UpdateSamplingRule

Returns: a Paws::XRay::UpdateSamplingRuleResult instance

Modifies a sampling rule's configuration.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results