Skip to content

Documentation: examples/outputs need updating #1049

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

Closed
dreamorosi opened this issue Aug 10, 2022 · 2 comments · Fixed by #1048
Closed

Documentation: examples/outputs need updating #1049

dreamorosi opened this issue Aug 10, 2022 · 2 comments · Fixed by #1048
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation logger This item relates to the Logger Utility

Comments

@dreamorosi
Copy link
Contributor

Description of the improvement

Summary of the proposal
With the newer features being released some of the CloudWatch excerpts for Logger in the docs have fallen out of sync either in terms of content/keys or lines highlighted.

How, where did you look for information
Logger documentation.

Missing or unclear documentation

Some of the examples in the Logger docs are out of sync with the library.

Improvement
Appending persistent additional log keys and values
example logs: add "aws_account_id" to highlighted text as this is also set in persistentLogAttributes
Appending additional data to a single log item
example log 2: update message
example log 3 highlight "extra" property instead of "xray_trace_id"
Logging errors
set log message as value passed to logger.error() and set error object message to Error message

Related existing documentation

See point above.

Related issues, RFCs

N/A

@dreamorosi dreamorosi added documentation Improvements or additions to documentation logger This item relates to the Logger Utility labels Aug 10, 2022
@dreamorosi dreamorosi linked a pull request Aug 10, 2022 that will close this issue
13 tasks
@dreamorosi dreamorosi mentioned this issue Aug 10, 2022
13 tasks
@github-actions
Copy link
Contributor

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@github-actions github-actions bot added the pending-release This item has been merged and will be released soon label Aug 10, 2022
@dreamorosi
Copy link
Contributor Author

Released as a part of v1.1.0

@dreamorosi dreamorosi removed the pending-release This item has been merged and will be released soon label Aug 12, 2022
@dreamorosi dreamorosi changed the title Documentation (logger): Documentation examples/outputs need updating Documentation: Documentation examples/outputs need updating Nov 14, 2022
@dreamorosi dreamorosi changed the title Documentation: Documentation examples/outputs need updating Documentation: examples/outputs need updating Nov 14, 2022
@dreamorosi dreamorosi added the completed This item is complete and has been merged/shipped label Nov 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation logger This item relates to the Logger Utility
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant