Add a link to python's logging config schema (#5926)

matrix-org · Feb 24, 2020 · 88c5b43 · 88c5b43
2 parents 3d5f1eb + 92c1550
commit 88c5b43
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/changelog.d/5926.misc b/changelog.d/5926.misc
@@ -0,0 +1 @@
+Add link in sample config to the logging config schema.
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
@@ -560,7 +560,8 @@ database:
 
 ## Logging ##
 
-# A yaml python logging config file
+# A yaml python logging config file as described by
+# https://docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema
 #
 log_config: "CONFDIR/SERVERNAME.log.config"
 

diff --git a/synapse/config/logger.py b/synapse/config/logger.py
@@ -89,7 +89,8 @@ def generate_config_section(self, config_dir_path, server_name, **kwargs):
             """\
         ## Logging ##
 
-        # A yaml python logging config file
+        # A yaml python logging config file as described by
+        # https://docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema
         #
         log_config: "%(log_config)s"
         """