Skip to content

Commit

Permalink
Update xrayexporter documentation on indexing attributes (#34183)
Browse files Browse the repository at this point in the history
**Description:** <Describe what has changed.>
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
Adding Xray Exporter Documentation - Shows users how to use dynamically
indexed attributes within the SDK with Xray

**Link to tracking Issue:**
#34182

**Testing:** N/A

**Documentation:** Update xrayexporter documentation on indexing
attributes
  • Loading branch information
arun-annamalai authored Jul 26, 2024
1 parent 98ae65b commit 49cee31
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions exporter/awsxrayexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 49cee31

Please sign in to comment.