AWS.XRay — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.XRay

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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

Sending a Request Using XRay

var xray = new AWS.XRay();
xray.getSamplingTargets(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the XRay object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var xray = new AWS.XRay({apiVersion: '2016-04-12'});

You can also set the API version globally in AWS.config.apiVersions using the xray service identifier:

AWS.config.apiVersions = {
  xray: '2016-04-12',
  // other service API versions
};

var xray = new AWS.XRay();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.XRay(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

batchGetTraces(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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

createSamplingRule(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

Deletes a group resource.

deleteResourcePolicy(params = {}, callback) ⇒ AWS.Request

Deletes a resource policy from the target Amazon Web Services account.

deleteSamplingRule(params = {}, callback) ⇒ AWS.Request

getEncryptionConfig(params = {}, callback) ⇒ AWS.Request

Retrieves the current encryption configuration for X-Ray data.

getGroup(params = {}, callback) ⇒ AWS.Request

Retrieves group resource details.

getGroups(params = {}, callback) ⇒ AWS.Request

Retrieves all active group details.

getInsight(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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

getSamplingRules(params = {}, callback) ⇒ AWS.Request

Retrieves all sampling rules.

getSamplingStatisticSummaries(params = {}, callback) ⇒ AWS.Request

Retrieves information about recent sampling results for all sampling rules.

getSamplingTargets(params = {}, callback) ⇒ AWS.Request

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

getServiceGraph(params = {}, callback) ⇒ AWS.Request

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 Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.

getTimeSeriesServiceStatistics(params = {}, callback) ⇒ AWS.Request

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

getTraceGraph(params = {}, callback) ⇒ AWS.Request

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

getTraceSummaries(params = {}, callback) ⇒ AWS.Request

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.

listResourcePolicies(params = {}, callback) ⇒ AWS.Request

Returns the list of resource policies in the target Amazon Web Services account.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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

putEncryptionConfig(params = {}, callback) ⇒ AWS.Request

Updates the encryption configuration for X-Ray data.

putResourcePolicy(params = {}, callback) ⇒ AWS.Request

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

putTelemetryRecords(params = {}, callback) ⇒ AWS.Request

Used by the Amazon Web Services X-Ray daemon to upload telemetry.

putTraceSegments(params = {}, callback) ⇒ AWS.Request

Uploads 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

A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes:

Trace ID Format

tagResource(params = {}, callback) ⇒ AWS.Request

Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.

untagResource(params = {}, callback) ⇒ AWS.Request

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

updateGroup(params = {}, callback) ⇒ AWS.Request

Updates a group resource.

updateSamplingRule(params = {}, callback) ⇒ AWS.Request

Modifies a sampling rule's configuration.