From 5290e3c33c761b49927fce8cbbb6a1ac35d2732a Mon Sep 17 00:00:00 2001 From: Mark McDowall Date: Thu, 13 Mar 2014 13:32:02 -0700 Subject: [PATCH] Added logging information to development --- .../Contributing.md | 0 Development/Log Levels.md | 34 +++++++++++++++++++ Development/_Sidebar.md | 3 ++ Home.md | 2 +- 4 files changed, 38 insertions(+), 1 deletion(-) rename Contributing.md => Development/Contributing.md (100%) create mode 100644 Development/Log Levels.md create mode 100644 Development/_Sidebar.md diff --git a/Contributing.md b/Development/Contributing.md similarity index 100% rename from Contributing.md rename to Development/Contributing.md diff --git a/Development/Log Levels.md b/Development/Log Levels.md new file mode 100644 index 0000000..0586808 --- /dev/null +++ b/Development/Log Levels.md @@ -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. \ No newline at end of file diff --git a/Development/_Sidebar.md b/Development/_Sidebar.md new file mode 100644 index 0000000..327f979 --- /dev/null +++ b/Development/_Sidebar.md @@ -0,0 +1,3 @@ +### [[Development]] ### +- [[Contributing]] +- [[Log Levels]] diff --git a/Home.md b/Home.md index 31e3118..3032d5e 100644 --- a/Home.md +++ b/Home.md @@ -22,7 +22,7 @@ - [[Recovering from a Failed Update]] - [[Log Files]] -### Contributing ### +### Development ### - [[Contributing]] ### API ###