From 49cee31127431c23afd97657414a5c2a44c5c755 Mon Sep 17 00:00:00 2001 From: Arun Annamalai <36392755+arun-annamalai@users.noreply.github.com> Date: Fri, 26 Jul 2024 06:08:28 -0700 Subject: [PATCH] Update xrayexporter documentation on indexing attributes (#34183) **Description:** Adding Xray Exporter Documentation - Shows users how to use dynamically indexed attributes within the SDK with Xray **Link to tracking Issue:** https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/34182 **Testing:** N/A **Documentation:** Update xrayexporter documentation on indexing attributes --- exporter/awsxrayexporter/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/exporter/awsxrayexporter/README.md b/exporter/awsxrayexporter/README.md index ccdf9175f711..cd9174c5a9bd 100644 --- a/exporter/awsxrayexporter/README.md +++ b/exporter/awsxrayexporter/README.md @@ -43,6 +43,7 @@ defined in the OpenTelemetry Semantic Conventions. | `aws.request_id` | AWS-generated unique identifier for the request. | No | | `aws.queue_url` | For operations on an Amazon SQS queue, the queue's URL. | No | | `aws.table_name` | For operations on a DynamoDB table, the name of the table. | No | +| `aws.xray.annotations` | The attribute is a slice(list) attribute that contains each of the string keys. If found on the span, the `awsxrayexporter` will use them in addition to the `indexed_attributes` configuration field when categorizing which attributes to index. This can be configured with `"aws.xray.annotations"=["key1", "key2"]` (Java example: `span.setAttribute(stringArrayKey("aws.xray.annotations"), List.of("key1", "key2"))`) | No | Any of these values supplied are used to populate the `aws` object in addition to any relevant data supplied by the Span Resource object. X-Ray uses this data to generate inferred segments for the remote APIs.