LOG_LEVEL docs and changelog entry

CHANGELOG.md

@@ -76,6 +76,7 @@ v1.6.0 - unreleased
 - Enhancement: Move Mailu Docker network to a fixed subnet ([#727](https://github.com/Mailu/Mailu/issues/727))
 - Enhancement: Added regex validation for alias username ([#764](https://github.com/Mailu/Mailu/issues/764))
 - Enhancement: Update documentation
+- Enhancement: Add logging at critical places in python start.py scripts. Implement LOG_LEVEL to controll verbosity ([#588](https://github.com/Mailu/Mailu/issues/588))
 - Upstream: Update Roundcube
 - Upstream: Update Rainloop
 - Bug: Rainloop fails with "domain not allowed" ([#93](https://github.com/Mailu/Mailu/issues/93))

core/dovecot/start.py

@@ -12,7 +12,7 @@ import sys
 from tenacity import retry
 from podop import run_server
 
-log.basicConfig(stream=sys.stderr, level=os.environ["LOG_LEVEL"] if "LOG_LEVEL" in os.environ else "WARN")
+log.basicConfig(stream=sys.stderr, level=os.environ["LOG_LEVEL"] if "LOG_LEVEL" in os.environ else "WARNING")
 
 def start_podop():
     os.setuid(8)

core/nginx/config.py

@@ -7,7 +7,7 @@ import sys
 
 args = os.environ.copy()
 
-log.basicConfig(stream=sys.stderr, level=args["LOG_LEVEL"] if "LOG_LEVEL" in args else "WARN")
+log.basicConfig(stream=sys.stderr, level=args["LOG_LEVEL"] if "LOG_LEVEL" in args else "WARNING")
 
 def convert(src, dst, args):
     logger = log.getLogger("convert()")

core/postfix/start.py

@@ -13,7 +13,7 @@ import sys
 from tenacity import retry
 from podop import run_server
 
-log.basicConfig(stream=sys.stderr, level=os.environ["LOG_LEVEL"] if "LOG_LEVEL" in os.environ else "WARN")
+log.basicConfig(stream=sys.stderr, level=os.environ["LOG_LEVEL"] if "LOG_LEVEL" in os.environ else "WARNING")
 
 def start_podop():
     os.setuid(100)

docs/compose/.env

@@ -151,3 +151,6 @@ REAL_IP_FROM=
 
 # choose wether mailu bounces (no) or rejects (yes) mail when recipient is unknown (value: yes, no)
 REJECT_UNLISTED_RECIPIENT=
+
+# Log level threshold in start.py (value: CRITICAL, ERROR, WARNING, INFO, DEBUG, NOTSET)
+LOG_LEVEL=WARNING

docs/configuration.rst

@@ -83,6 +83,13 @@ The ``PASSWORD_SCHEME`` is the password encryption scheme. You should use the
 default value, unless you are importing password from a separate system and
 want to keep using the old password encryption scheme.
 
+The ``LOG_LEVEL`` setting is used by the python start-up scripts as a logging threshold.
+Log messages equal or higher than this priority will be printed.
+Can be one of: CRITICAL, ERROR, WARNING, INFO, DEBUG or NOTSET.
+See the `python docs`_ for more information.
+
+.. _`python docs`: https://docs.python.org/3.6/library/logging.html#logging-levels
+
 Infrastructure settings
 -----------------------
 

optional/clamav/start.py

@@ -4,7 +4,7 @@ import os
 import logging as log
 import sys
 
-log.basicConfig(stream=sys.stderr, level=os.environ["LOG_LEVEL"] if "LOG_LEVEL" in os.environ else "WARN")
+log.basicConfig(stream=sys.stderr, level=os.environ["LOG_LEVEL"] if "LOG_LEVEL" in os.environ else "WARNING")
 logger=log.getLogger(__name__)
 
 # Bootstrap the database if clamav is running for the first time

services/rspamd/start.py

@@ -10,7 +10,7 @@ import sys
 
 from tenacity import retry
 
-log.basicConfig(stream=sys.stderr, level=os.environ["LOG_LEVEL"] if "LOG_LEVEL" in os.environ else "WARN")
+log.basicConfig(stream=sys.stderr, level=os.environ["LOG_LEVEL"] if "LOG_LEVEL" in os.environ else "WARNING")
 
 def convert(src, dst):
     logger = log.getLogger("convert()")

services/unbound/start.py

@@ -5,7 +5,7 @@ import os
 import logging as log
 import sys
 
-log.basicConfig(stream=sys.stderr, level=os.environ["LOG_LEVEL"] if "LOG_LEVEL" in os.environ else "WARN")
+log.basicConfig(stream=sys.stderr, level=os.environ["LOG_LEVEL"] if "LOG_LEVEL" in os.environ else "WARNING")
 
 def convert(src, dst):
     logger = log.getLogger("convert()")

setup/flavors/compose/mailu.env

@@ -160,3 +160,6 @@ REAL_IP_FROM={{ real_ip_from }}
 
 # choose wether mailu bounces (no) or rejects (yes) mail when recipient is unknown (value: yes, no)
 REJECT_UNLISTED_RECIPIENT={{ reject_unlisted_recipient }}
+
+# Log level threshold in start.py (value: CRITICAL, ERROR, WARNING, INFO, DEBUG, NOTSET)
+LOG_LEVEL=WARNING

webmails/rainloop/start.py

@@ -6,7 +6,7 @@ import shutil
 import logging as log
 import sys
 
-log.basicConfig(stream=sys.stderr, level=os.environ["LOG_LEVEL"] if "LOG_LEVEL" in os.environ else "WARN")
+log.basicConfig(stream=sys.stderr, level=os.environ["LOG_LEVEL"] if "LOG_LEVEL" in os.environ else "WARNING")
 
 def convert(src, dst):
     logger = log.getLogger("convert()")

webmails/roundcube/start.py

@@ -5,7 +5,7 @@ import jinja2
 import logging as log
 import sys
 
-log.basicConfig(stream=sys.stderr, level=os.environ["LOG_LEVEL"] if "LOG_LEVEL" in os.environ else "WARN")
+log.basicConfig(stream=sys.stderr, level=os.environ["LOG_LEVEL"] if "LOG_LEVEL" in os.environ else "WARNING")
 
 def convert(src, dst):
     logger = log.getLogger("convert()")