Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Provide guidance on what to log outside of errors #267

Open
rowanmanning opened this issue Oct 25, 2022 · 0 comments
Open

Provide guidance on what to log outside of errors #267

rowanmanning opened this issue Oct 25, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request requested Used to indicate that a team outside of the maintainers of this repo has requested this work

Comments

@rowanmanning
Copy link
Member

We currently document how to log errors. We should also provide guidance on the kinds of things that are useful to log outside of an error case.

What problem does this feature solve?

@apaleslimghost asked if we have any guidance when setting up a new project to do some logging. It would prevent her from having to think about this problem as much, and eventually result in more consistent logging across Customer Products apps.

Ideal solution

Another guide in docs folder.

Alternatives

We could do nothing, but then we miss out on a chance to nudge us towards more consistent logs.
@rowanmanning rowanmanning added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 25, 2022
@rowanmanning rowanmanning moved this to 📥 Inbox in Reliability Kit Roadmap Oct 25, 2022
@rowanmanning rowanmanning added the requested Used to indicate that a team outside of the maintainers of this repo has requested this work label Oct 25, 2022
@rowanmanning rowanmanning moved this from 📥 Inbox to 📝 Planned (future) in Reliability Kit Roadmap Oct 25, 2022
@rowanmanning rowanmanning moved this from 📝 Planned (future) to 📥 Inbox in Reliability Kit Roadmap Oct 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request requested Used to indicate that a team outside of the maintainers of this repo has requested this work
Projects
Reliability Kit Roadmap
Status: 📥 Inbox
Milestone
No milestone
Development

No branches or pull requests
1 participant
@rowanmanning