Added logging information to development

Mark McDowall 2014-03-13 13:32:02 -07:00
parent bfde233bfb
commit 5290e3c33c
4 changed files with 38 additions and 1 deletions

34
Development/Log Levels.md Normal file

@ -0,0 +1,34 @@
These are guidelines that should help determine the appropriate log level and method when logging events.
## Levels ##
### Fatal ###
NzbDrone has failed completely, or will be operating in a diminished state.
### Error ###
NzbDrone was preventing from doing something and the user may need to take action to correct it (Unable to connect to an external service), NzbDrone will be unable to operate normally.
### Warning ###
NzbDrone was unable to perform an action, but the result doesn't prevent NzbDrone from operating normally.
### Info ###
Informational messages, to let the user know something normal/good has happened.
### Debug ###
Use for debugging purposes, more information than most users will be con concerned with.
### Trace ###
System level messages, or when logged information is not required for normal debugging.
## Progress ##
Sends logging messages to the UI when jobs are running (searching, updating information, etc), used to tell the user something is happening in the background, without having to look at log files.
## Cleansed ##
Use to clean log messages before logging, currently it will clean API keys from messages before the message is saved.

3
Development/_Sidebar.md Normal file

@ -0,0 +1,3 @@
### [[Development]] ###
- [[Contributing]]
- [[Log Levels]]

@ -22,7 +22,7 @@
- [[Recovering from a Failed Update]]
- [[Log Files]]
### Contributing ###
### Development ###
- [[Contributing]]
### API ###