Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update xrayexporter documentation on indexing attributes #34183

Merged
merged 1 commit into from
Jul 26, 2024

Conversation

arun-annamalai
Copy link
Contributor

Description:

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

@songy23 songy23 added documentation Improvements or additions to documentation Skip Changelog PRs that do not require a CHANGELOG.md entry labels Jul 22, 2024
@@ -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. | No |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit:

Suggested change
| `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. | 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. | No |

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, can you include an example to clarify what does the "slice" value of this attribute key would look like?

@arun-annamalai
Copy link
Contributor Author

Could someone please merge this in?

@songy23 songy23 added the ready to merge Code review completed; ready to merge by maintainers label Jul 25, 2024
@mx-psi mx-psi merged commit 49cee31 into open-telemetry:main Jul 26, 2024
147 checks passed
@github-actions github-actions bot added this to the next release milestone Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation exporter/awsxray ready to merge Code review completed; ready to merge by maintainers Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants