Merge branch 'bug28761'

docs/source/examples/sbws.example.ini

@@ -10,3 +10,31 @@ foo = on
 [destinations.foo]
 # the domain and path to the 1GB file.
 url = https://example.com/does/not/exist.bin
+
+
+## The following logging options are set by default.
+## There is no need to change them unless other options are prefered.
+; [logging]
+; # Whether or not to log to a rotating file the directory paths.log_dname
+; to_file = yes
+; # Whether or not to log to stdout
+; to_stdout = yes
+; # Whether or not to log to syslog
+; # NOTE that when sbws is launched by systemd, stdout goes to journal and
+; # syslog.
+; to_syslog = no
+
+; # Level to log at. Debug, info, warning, error, critical.
+; # `level` must be set to the lower of all the handler levels.
+; level = debug
+; to_file_level = debug
+; to_stdout_level = info
+; to_syslog_level = info
+; # Format string to use when logging
+; format = %(module)s[%(process)s]: <%(levelname)s> %(message)s
+; # verbose formatter useful for debugging
+; to_file_format = %(asctime)s %(levelname)s %(threadName)s %(filename)s:%(lineno)s - %(funcName)s - %(message)s
+; # Not adding %(asctime)s to to stdout since it'll go to syslog when using
+; # systemd, and it'll have already the date.
+; to_stdout_format = ${format}
+; to_syslog_format = ${format}
\ No newline at end of file

docs/source/man_sbws.ini.rst

@@ -139,6 +139,8 @@ logging
     Whether or not to log to stdout. (Default: yes)
   to_syslog = {yes, no}
     Whether or not to log to syslog. (Default: no)
+    NOTE that when sbws is launched by systemd, stdout goes to journal and
+    syslog.
   to_file_max_bytes = INT
     If logging to file, how large (in bytes) should the file be allowed to get
     before rotating to a new one. 10485760 is 10 MiB. If zero or number of

sbws/config.default.ini

@@ -94,10 +94,12 @@ min_relays = 50
 
 [logging]
 # Whether or not to log to a rotating file the directory paths.log_dname
-to_file = no
+to_file = yes
 # Whether or not to log to stdout
 to_stdout = yes
 # Whether or not to log to syslog
+# NOTE that when sbws is launched by systemd, stdout goes to journal and
+# syslog.
 to_syslog = no
 # If logging to file, how large (in bytes) should the file be allowed to get
 # before rotating to a new one. 10485760 is 10 MiB. If zero or number of
@@ -107,14 +109,15 @@ to_file_max_bytes = 10485760
 # never rotate the log file.
 to_file_num_backups = 50
 # Level to log at. Debug, info, warning, error, critical.
-level = info
-to_file_level = ${level}
-to_stdout_level = ${level}
-to_syslog_level = ${level}
+# `level` must be set to the lower of all the handler levels.
+level = debug
+to_file_level = debug
+to_stdout_level = info
+to_syslog_level = info
 # Format string to use when logging
 format = %(asctime)s %(module)s[%(process)s]: <%(levelname)s> %(message)s
-to_file_format = ${format}
 to_stdout_format = ${format}
 to_syslog_format = %(module)s[%(process)s]: <%(levelname)s> %(message)s
 # verbose formatter useful for debugging
-#format = %(asctime)s %(levelname)s %(threadName)s %(filename)s:%(lineno)s - %(funcName)s - %(message)s
+to_file_format = %(asctime)s %(levelname)s %(threadName)s %(filename)s:%(lineno)s - %(funcName)s - %(message)s
+