docs: update logger.md#1048
Merged
Merged
Conversation
saragerion
approved these changes
Aug 10, 2022
Contributor
saragerion
left a comment
There was a problem hiding this comment.
Thanks so much @tsop14 for your kind words and taking the time to make this library better ❤️
Glad to have you as new first time contributor! 🚀
dreamorosi
approved these changes
Aug 10, 2022
Contributor
dreamorosi
left a comment
There was a problem hiding this comment.
Hi @tsop14 thank you for taking the time to open a PR in this repo, appreciate your time.
Leaving here the screenshots of the rendered docs for future reference of the changes:



Contributor
|
Note, the preview of the changes is visible here: It will be available in the "latest" version with the next release. |
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
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
Logger documentation update. Reading docs for the first time, this library looks great (looking forward to trying it out) but I believe a few of the log output examples are out of sync with the
handler.tscode."aws_account_id"to highlighted text as this is also set inpersistentLogAttributes"extra"property instead of"xray_trace_id"messageas value passed tologger.error()and set error objectmessagetoErrormessageHow to verify this change
Run code in
handler.tsand verify log output matches updatedExample CloudWatch Logs excerptRelated issues, RFCs
Issue number: #1049
PR status
Is this ready for review?: YES
Is it a breaking change?: NO
Checklist
Breaking change checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.