docs: added note about active tracing #1011
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
dreamorosi
added
documentation
📊 Package size report No changes
🤖 This report was automatically generated by pkg-size-action |
flochaz
reviewed
Jul 4, 2022
docs/core/tracer.md
Outdated
| @@ -61,7 +61,12 @@ Setting | Description | |||
| For a **complete list** of supported environment variables, refer to [this section](./../index.md#environment-variables). | |||
|
|
|||
| !!! note | |||
| Before your use this utility, your AWS Lambda function [must have permissions](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html#services-xray-permissions) to send traces to AWS X-Ray. | |||
| Before your use this utility, your AWS Lambda function must have | |||
| [Active Tracing | |||
There was a problem hiding this comment.
Good catch, fixed in the latest commit
flochaz
approved these changes
Jul 4, 2022
📊 Package size report No changes
🤖 This report was automatically generated by pkg-size-action |
ijemmy
approved these changes
Jul 5, 2022
dreamorosi
added a commit
that referenced
this pull request
Aug 2, 2022
* docs: added note about active tracing * fix: extra lines
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
After some feedback raised by a user we have realised that it's not exactly explicit that Active Tracing should be enabled in your Lambda function in order to see traces in X-Ray. This PR adds a sentence to the already existing note about permission to make this detail explicit in an effort to reduce confusion for future users who might not be familiar with the service.
How to verify this change
See the diff, only added a sentence.
Related issues, RFCs
N/A
PR status
Is this ready for review?: YES
Is it a breaking change?: NO
Checklist
Breaking change checklist
N/A
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.