docs: eport logs (#265)

zwave-js · Jan 19, 2021 · d198a49 · d198a49
1 parent 9c90905
commit d198a49
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -28,6 +28,7 @@
 - Troubleshooting
 
   - [Exporting Node Json](troubleshooting/node_export.md)
+  - [Exporting Logs](troubleshooting/logs_export.md)
 
 - [Screenshots](screenshots.md)
 - [Thanks](thanks.md)

diff --git a/docs/troubleshooting/logs_export.md b/docs/troubleshooting/logs_export.md
@@ -0,0 +1,14 @@
+# Logs export
+
+The are two main loggers, one for zwavejs2mqtt and one for zwave-js module.
+
+To help us finding what's going on, when reporting a bug, you should attach the logs coming from both loggers.
+
+Both loggers options are configurable from the UI in `Settings`:
+
+1. The ZwaveJS logger can be confgured in `Zwave` section, enable `Log enabled` switch and `Log To File` and set `Log Level` to `silly`
+2. The zwavejs2mqtt logger can be confgured in `General` section, enable `Log enabled` switch and `Log To File` and set `Log Level` to `silly`
+
+Now press on `SAVE` button to store the new settings and your logs will be stored in separeted files inside `store` folder. The zwavejs2mqtt log output file will be named `zwavejs2mqtt.log` and the zwavejs one `zwavejs_<processid>.log`
+
+If you are using docker you can ssh inside the running container and/or use the `docker cp` command to download the files in the local filesystem.