summaryrefslogtreecommitdiff
path: root/docs/src/gettingstarted/debugging/logging.md
diff options
context:
space:
mode:
authorjwijenbergh <jeroenwijenbergh@protonmail.com>2022-04-26 11:44:11 +0200
committerjwijenbergh <jeroenwijenbergh@protonmail.com>2022-04-26 11:44:11 +0200
commita5d33f95ba68263e6c0ca758c5b854530332d9ae (patch)
tree798d1ac821262e00e4e44592e788637cd8fa41ab /docs/src/gettingstarted/debugging/logging.md
parentef70ea3c783be09501053469c5b4b5bb51ef2df2 (diff)
Docs: Add more info about debugging (logging and FSM)
Diffstat (limited to 'docs/src/gettingstarted/debugging/logging.md')
-rw-r--r--docs/src/gettingstarted/debugging/logging.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/src/gettingstarted/debugging/logging.md b/docs/src/gettingstarted/debugging/logging.md
new file mode 100644
index 0000000..a1cfc97
--- /dev/null
+++ b/docs/src/gettingstarted/debugging/logging.md
@@ -0,0 +1,8 @@
+# Logging
+As said, logging is used. The logging gets saved in a client-specified directory (see [API](../../api/index.html)). Logging has the following levels:
+
+- `INFO`: Messages purely for info, these do not indicate any errors. They are merely there for debugging purposes
+- `WARNING`: This message indicates a warning, this can be e.g. non-fatal errors
+- `ERROR`: Fatal errors which refuses the app from working
+
+By default only messages below or equal to `WARNING` are logged (`WARNING`, `ERROR`). However, if the debug variable is set to `True`, all messages will be logged into the log file.