Skip to content

Things to consider while writing logs #2

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

Open
loveshjain wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Things to consider while writing logs #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,16 @@ A good example of a log event taken from [timber.io](https://github.com/timberio
```
`Note that this JSON content should all be contained on a single line. It is only pretty printed here for readability.`

Debug logs typically report application events that are useful when diagnosing a problem. Investigations into application failures need the "W" words:

Who, What, When, Where and Why:

* Who was using the system when it failed?
* Where in the code did the application fail?
* What was the system doing when it failed?
* When did the failure occur?
* Why did the application fail?

There are many good guides on good logging practices but if you start with the principles above you will go far.

If your logs don't follow these basic principles then talk to your product owner or engineering lead to start to
Expand Down