From 37933a3bf88b6ddf0a01cb4b86e8645aca93ae0f Mon Sep 17 00:00:00 2001
From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Date: Fri, 21 Jun 2019 17:14:56 +0100
Subject: [PATCH] Improve logging when generating config files (#5510)

Make it a bit clearer what's going on.
---
 changelog.d/5510.misc    | 1 +
 synapse/config/_base.py  | 3 ++-
 synapse/config/key.py    | 1 +
 synapse/config/logger.py | 4 ++++
 4 files changed, 8 insertions(+), 1 deletion(-)
 create mode 100644 changelog.d/5510.misc

diff --git a/changelog.d/5510.misc b/changelog.d/5510.misc
new file mode 100644
index 000000000..4591a63d9
--- /dev/null
+++ b/changelog.d/5510.misc
@@ -0,0 +1 @@
+Improve logging when generating config files.
diff --git a/synapse/config/_base.py b/synapse/config/_base.py
index 8284aa4c6..4c6a684cb 100644
--- a/synapse/config/_base.py
+++ b/synapse/config/_base.py
@@ -289,6 +289,7 @@ class Config(object):
                 )
             (config_path,) = config_files
             if not cls.path_exists(config_path):
+                print("Generating config file %s" % (config_path,))
                 if config_args.keys_directory:
                     config_dir_path = config_args.keys_directory
                 else:
@@ -331,7 +332,7 @@ class Config(object):
             else:
                 print(
                     (
-                        "Config file %r already exists. Generating any missing key"
+                        "Config file %r already exists. Generating any missing config"
                         " files."
                     )
                     % (config_path,)
diff --git a/synapse/config/key.py b/synapse/config/key.py
index 94a0f47ea..21c4f5c51 100644
--- a/synapse/config/key.py
+++ b/synapse/config/key.py
@@ -241,6 +241,7 @@ class KeyConfig(Config):
         signing_key_path = config["signing_key_path"]
 
         if not self.path_exists(signing_key_path):
+            print("Generating signing key file %s" % (signing_key_path,))
             with open(signing_key_path, "w") as signing_key_file:
                 key_id = "a_" + random_string(4)
                 write_signing_keys(signing_key_file, (generate_signing_key(key_id),))
diff --git a/synapse/config/logger.py b/synapse/config/logger.py
index a22655b12..9db2e087e 100644
--- a/synapse/config/logger.py
+++ b/synapse/config/logger.py
@@ -137,6 +137,10 @@ class LoggingConfig(Config):
         log_config = config.get("log_config")
         if log_config and not os.path.exists(log_config):
             log_file = self.abspath("homeserver.log")
+            print(
+                "Generating log config file %s which will log to %s"
+                % (log_config, log_file)
+            )
             with open(log_config, "w") as log_config_file:
                 log_config_file.write(DEFAULT_LOG_CONFIG.substitute(log_file=log_file))