docs(tracer): clarify escape hatch mechanism #3056
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
boring-cyborg
bot
added
documentation
leandrodamascena
requested changes
Sep 12, 2024
There was a problem hiding this comment.
Hi @dreamorosi! I left some suggestions to improve the documentation and make it clearer.
Co-authored-by: Leandro Damascena <leandro.damascena@gmail.com>
…powertools-lambda-typescript into docs/tracer_escape_hatch
leandrodamascena
approved these changes
Sep 12, 2024
|
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.
Summary
Changes
This PR fixes the documentation around the escape hatch mechanism exposed by the Tracer utility.
In the previous version of the docs we were stating that we expose all the methods from the underlying AWS X-Ray SDK for Node.js - which is not true.
I have updated the docs to clarify that we only expose some of the methods and shared a brief explanation of why this is the case, and what to expect from using other methods directly.
To give more visibility over which methods are exposed, I have also added the
ProviderServiceclass from the Tracer package to the API docs.Issue number: closes #2943
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.