Merge pull request #337 from mapswipe/docs

Docs

Author: Matthias-Schaub

docs/source/debugging.md

@@ -3,11 +3,13 @@
 ## Logs - MapSwipe Workers
 
 Where can I find logs?
+- `docker logs mapswipe_workers`
+- or
+- `cat mapswipe-data/mapswipe_workers.log`
 
-Logs are written to directly to console and also to `/var/log/mapswipe_workers.log`:
+Logs are written to directly to the terminal (stdout). The easiest way is therefore is to run `docker logs mapswipe_workers` to see the logs.
 
-- `docker exec -t mapswipe_workers cat /var/log/mapswipe_workers/mapswipe_workers.log` (if container is running)
-- `docker logs container_name` (also if container is not running)
+Logs are also writing to file inside the Docker container (`~/.local/share/mapswipe_workers/mapswipe_workers.log`). The parent directory of the file is the data directory of MapSwipe Workers. This directory is mounted (as a Docker volume) locally to disk (`mapswipe-data/`). Logs can therefore be accessed as text file as well: `cat mapswipe-data/mapswipe_workers.log`
 
 
 ## Common Errors

docs/source/dev_setup.md

@@ -89,12 +89,12 @@ mapswipe_workers --help
 
 ## Logging
 
-Mapswipe workers logs are generated using the Python logging module of the standard library (See [Official docs](https://docs.python.org/3/library/logging.html) or this [Tutorial](https://realpython.com/python-logging/#the-logging-module). The logging configuration is defined in the `logging.cfg` file (`mapswipe_workers/logging.cfg`). To use the logger object import the it from the `definitions` module:
+Mapswipe workers logs are generated using the Python logging module of the standard library (See [Official docs](https://docs.python.org/3/library/logging.html) or this [Tutorial](https://realpython.com/python-logging/#the-logging-module). To use the logger object import the it from the `definitions` module:
 
 ```python
 from mapswipe_workers.definitions import logger
-logger.info('information')
-logger.waring('warning')
+logger.info('information messages')
+logger.waring('warning messages')
 
 # Include stack trace in the log
 try:
@@ -103,7 +103,7 @@ except Exception:
     logger.exception('Additional information.')
 ```
 
-Default logging level is Info. To change the logging level edit the configuration. Logs are written to STDOUT and `~/.local/share/mapswipe_workers/mapswipe_workers.log`.
+Default logging level is Info. To change the logging level edit the logging configuration which is found in the module `definitions.py`. Logs are written to STDOUT and `~/.local/share/mapswipe_workers/mapswipe_workers.log`.
 
 Per default logging of third-party packages is disabled. To change this edit the definition module (`mapswipe_workers/defintions.py`). Set the `disable_existing_loggers` parameter of the `logging.config.fileConfig()` function to `False`.