docs(tracer): update annotation & metadata docs to include full code #1704
Conversation
This file contains hidden or 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
<!--- Instructions: 1. Make sure you follow our Contributing Guidelines: https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/CONTRIBUTING.md 2. Please follow the template, and do not remove any section/item. If something is not applicable leave it empty, but leave it in the PR. 3. --> ## Description of your changes <!--- Include here a summary of the change. Please include also relevant motivation and context. Add any applicable code snippets, links, screenshots, or other resources that can help us verify your changes. --> This PR introduces changes to the code snippets found in the Tracer documentation and related to adding annotations and metadata to a segment. The original snippets were mistakenly not handling the opening and closing of a custom subsegment and were instead suggesting to attempt annotating the `facade` segment. This is a mistake because that segment is managed by the service and cannot be modified, resulting in an error. The PR fixes this and shows the full code snippet. ### Related issues, RFCs <!--- Add here the number (i.e. #42) to the Github Issue or RFC that is related to this PR. Don't include any other text, otherwise the Github Issue will not be detected. Note: If no issue is present the PR might get blocked and not be reviewed. --> **Issue number:** #1699 ## Checklist - [x] [My changes meet the tenets criteria](https://docs.powertools.aws.dev/lambda-typescript/#tenets) - [x] I have performed a *self-review* of my own code - [x] I have *commented* my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas - [x] I have made corresponding changes to the *documentation* - [x] My changes generate *no new warnings* - [ ] I have *added tests* that prove my change is effective and works - [x] The PR title follows the [conventional commit semantics](https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/.github/semantic.yml#L2) ### Breaking change checklist ***Is it a breaking change?:*** NO - [ ] I have documented the migration process - [ ] I have added, implemented necessary warnings (if it can live side by side) --- By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice. **Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
1 task
boring-cyborg
bot
added
the
documentation
|
Kudos, SonarCloud Quality Gate passed!
|
am29d
approved these changes
Sep 21, 2023
am29d
deleted the
1699-docs-tracer-examples-for-addmetadata-and-addannotation-dont-work
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 of your changes
This PR introduces changes to the code snippets found in the Tracer documentation and related to adding annotations and metadata to a segment.
The original snippets were mistakenly not handling the opening and closing of a custom subsegment and were instead suggesting to attempt annotating the
facadesegment.This is a mistake because that segment is managed by the service and cannot be modified, resulting in an error.
The PR fixes this and shows the full code snippet.
Related issues, RFCs
Issue number: #1699
Checklist
Breaking change checklist
Is it a breaking change?: NO
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.