- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
XRayClient
Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
Installation
npm install @aws-sdk/client-xray
yarn add @aws-sdk/client-xray
pnpm add @aws-sdk/client-xray
XRayClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
BatchGetTracesCommand | You cannot find traces through this API if Transaction Search is enabled since trace is not indexed in X-Ray. Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use |
CancelTraceRetrievalCommand | Cancels an ongoing trace retrieval job initiated by |
CreateGroupCommand | Creates a group resource with a name and a filter expression. |
CreateSamplingRuleCommand | 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. |
DeleteGroupCommand | Deletes a group resource. |
DeleteResourcePolicyCommand | Deletes a resource policy from the target Amazon Web Services account. |
DeleteSamplingRuleCommand | Deletes a sampling rule. |
GetEncryptionConfigCommand | Retrieves the current encryption configuration for X-Ray data. |
GetGroupCommand | Retrieves group resource details. |
GetGroupsCommand | Retrieves all active group details. |
GetIndexingRulesCommand | Retrieves all indexing rules. Indexing rules are used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and indexed by X-Ray. For more information, see Transaction Search . |
GetInsightCommand | 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. |
GetInsightEventsCommand | 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. |
GetInsightImpactGraphCommand | 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. |
GetInsightSummariesCommand | Retrieves the summaries of all insights in the specified group matching the provided filter values. |
GetRetrievedTracesGraphCommand | Retrieves a service graph for traces based on the specified The trace graph describes services that process incoming requests and any downstream services they call, which may include Amazon Web Services resources, external APIs, or databases. The response is empty until the When CloudWatch log is the destination, this API can support cross-account observability and service graph retrieval across linked accounts. For retrieving graphs from X-Ray directly as opposed to the Transaction-Search Log group, see GetTraceGraph . |
GetSamplingRulesCommand | Retrieves all sampling rules. |
GetSamplingStatisticSummariesCommand | Retrieves information about recent sampling results for all sampling rules. |
GetSamplingTargetsCommand | Requests a sampling quota for rules that the service is using to sample requests. |
GetServiceGraphCommand | 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. |
GetTimeSeriesServiceStatisticsCommand | Get an aggregation of service statistics defined by a specific time range. |
GetTraceGraphCommand | Retrieves a service graph for one or more specific trace IDs. |
GetTraceSegmentDestinationCommand | Retrieves the current destination of data sent to |
GetTraceSummariesCommand | 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 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 This filter expression finds traces that have an annotation named For a full list of indexed fields and keywords that you can use in filter expressions, see Use filter expressions in the Amazon Web Services X-Ray Developer Guide. |
ListResourcePoliciesCommand | Returns the list of resource policies in the target Amazon Web Services account. |
ListRetrievedTracesCommand | Retrieves a list of traces for a given This API does not initiate a retrieval job. To start a trace retrieval, use When the For cross-account observability, this API can retrieve traces from linked accounts when CloudWatch log is the destination across relevant accounts. For more details, see CloudWatch cross-account observability . For retrieving data from X-Ray directly as opposed to the Transaction-Search Log group, see BatchGetTraces . |
ListTagsForResourceCommand | Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule. |
PutEncryptionConfigCommand | Updates the encryption configuration for X-Ray data. |
PutResourcePolicyCommand | 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. |
PutTelemetryRecordsCommand | Used by the Amazon Web Services X-Ray daemon to upload telemetry. |
PutTraceSegmentsCommand | Uploads segment documents to Amazon Web Services X-Ray. 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 Format
Trace IDs created via OpenTelemetry have a different format based on the W3C Trace Context specification . A W3C trace ID must be formatted in the X-Ray trace ID format when sending to X-Ray. For example, a W3C trace ID |
StartTraceRetrievalCommand | Initiates a trace retrieval process using the specified time range and for the give trace IDs on Transaction Search generated by the CloudWatch log group. For more information, see Transaction Search . API returns a If you are using CloudWatch cross-account observability , you can use this operation in a monitoring account to retrieve data from a linked source account, as long as both accounts have transaction search enabled. For retrieving data from X-Ray directly as opposed to the Transaction-Search Log group, see BatchGetTraces . |
TagResourceCommand | Applies tags to an existing Amazon Web Services X-Ray group or sampling rule. |
UntagResourceCommand | Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an |
UpdateGroupCommand | Updates a group resource. |
UpdateIndexingRuleCommand | Modifies an indexing rule’s configuration. Indexing rules are used for determining the sampling rate for spans indexed from CloudWatch Logs. For more information, see Transaction Search . |
UpdateSamplingRuleCommand | Modifies a sampling rule's configuration. |
UpdateTraceSegmentDestinationCommand | Modifies the destination of data sent to |
XRayClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: XRayClientConfig