Skip to content

Better description of different levels #18

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

Merged
erickhun merged 6 commits into from
Mar 3, 2020
Merged

Better description of different levels #18

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7009013
update readme for level description
erickhun Mar 3, 2020
55f2214
update readme for level description
erickhun Mar 3, 2020
adbf4f6
update readme for level description
erickhun Mar 3, 2020
cf6a629
update readme for level description
erickhun Mar 3, 2020
071b716
update readme for level description
erickhun Mar 3, 2020
17ffed3
update readme for level description
erickhun Mar 3, 2020
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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@ If you wish to see more logs, simply set the `LOG_LEVEL` to the desired level. H

| Levels | Use case | Examples |
|:-:|---|---|
| DEBUG | Logs that are used for interactive investigation during development. These logs should primarily contain information useful for debugging and have no long-term value. | |
| INFO | Informational messages | |
| NOTICE | Logs that track the general flow of the application. This is the default level | |
| WARNING | Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the application execution to stop. | |
| ERROR | Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a failure in the current activity, not an application-wide failure. | |
| CRITICAL | Logs that describe an unrecoverable application or system crash, or a catastrophic failure that requires immediate attention. | |
| DEBUG | Information used for interactive investigation, with no long-term value.| Printing function names, steps inside a function. |
| INFO | Interesting events. Track the general flow of the application. | User logs in, SQL logs, worker process/delete a message... |
| NOTICE | Uncommon events. **This is the default verbosity level**. | Missing environment variables, page redirection, pod starting/restarting/terminating, retrying to query an API... |
| WARNING | Exceptional occurrences that are not errors. Undesirable things that are not necessarily wrong. | Use of deprecated APIs, poor use of an API, unauthorized access, pod restart because of memory limit ... |
| ERROR | Runtime errors. Highlight when the current flow of execution is stopped due to a failure. | Exceptions messages, incorect credentials or permissions... |
| CRITICAL | Critical conditions. Describe an unrecoverable application, system crash, or a catastrophic failure that requires immediate attention. | Application component unavailable, unexpected exception. entire website down, database unavailable ...|