-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
songy23
approved these changes
Jul 22, 2024
songy23
added
documentation
Improvements or additions to documentation
Skip Changelog
PRs that do not require a CHANGELOG.md entry
labels
Jul 22, 2024
wangzlei
approved these changes
Jul 22, 2024
srprash
reviewed
Jul 22, 2024
exporter/awsxrayexporter/README.md
Outdated
@@ -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 | |
There was a problem hiding this comment.
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 | |
There was a problem hiding this comment.
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?
srprash
approved these changes
Jul 23, 2024
mwear
approved these changes
Jul 23, 2024
Could someone please merge this in? |
songy23
added
the
ready to merge
Code review completed; ready to merge by maintainers
label
Jul 25, 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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