From 2f1348f3395ba44cece492205ce7fa87ac519bee Mon Sep 17 00:00:00 2001
From: Mark Haines <mark.haines@matrix.org>
Date: Thu, 30 Apr 2015 16:52:57 +0100
Subject: [PATCH] Write a default log_config when generating config

---
 demo/start.sh            |  4 +--
 synapse/config/_base.py  |  3 ++-
 synapse/config/key.py    |  2 +-
 synapse/config/logger.py | 54 +++++++++++++++++++++++++++++++++++++++-
 synapse/config/tls.py    |  2 +-
 5 files changed, 59 insertions(+), 6 deletions(-)

diff --git a/demo/start.sh b/demo/start.sh
index 75ff9861d8..5b3daef57f 100755
--- a/demo/start.sh
+++ b/demo/start.sh
@@ -26,7 +26,7 @@ for port in 8080 8081 8082; do
 
     https_port=$((port + 400))
     mkdir -p demo/$port
-#    pushd demo/$port
+    pushd demo/$port
 
     #rm $DIR/etc/$port.config
     python -m synapse.app.homeserver \
@@ -39,7 +39,7 @@ for port in 8080 8081 8082; do
         -D \
         -vv \
 
- #   popd
+    popd
 done
 
 cd "$CWD"
diff --git a/synapse/config/_base.py b/synapse/config/_base.py
index e0c203cb1f..d7ccfcd98c 100644
--- a/synapse/config/_base.py
+++ b/synapse/config/_base.py
@@ -171,7 +171,7 @@ class Config(object):
                 config_bytes, config = obj.generate_config(
                     config_dir_path, server_name
                 )
-                obj.invoke_all("generate_keys", config)
+                obj.invoke_all("generate_files", config)
                 config_file.write(config_bytes)
             print (
                 "A config file has been generated in %s for server name"
@@ -192,6 +192,7 @@ class Config(object):
 
         server_name = specified_config["server_name"]
         _, config = obj.generate_config(config_dir_path, server_name)
+        config.pop("log_config")
         config.update(specified_config)
 
         obj.invoke_all("read_config", config)
diff --git a/synapse/config/key.py b/synapse/config/key.py
index 4a18a94775..27e0d2906e 100644
--- a/synapse/config/key.py
+++ b/synapse/config/key.py
@@ -107,7 +107,7 @@ class KeyConfig(Config):
                 )
         return keys
 
-    def generate_keys(self, config):
+    def generate_files(self, config):
         signing_key_path = config["signing_key_path"]
         if not os.path.exists(signing_key_path):
             with open(signing_key_path, "w") as signing_key_file:
diff --git a/synapse/config/logger.py b/synapse/config/logger.py
index 37b3d5342c..fa542623b7 100644
--- a/synapse/config/logger.py
+++ b/synapse/config/logger.py
@@ -19,6 +19,47 @@ from twisted.python.log import PythonLoggingObserver
 import logging
 import logging.config
 import yaml
+from string import Template
+import os
+
+
+DEFAULT_LOG_CONFIG = Template("""
+version: 1
+
+formatters:
+  precise:
+   format: '%(asctime)s - %(name)s - %(lineno)d - %(levelname)s - %(request)s\
+- %(message)s'
+
+filters:
+  context:
+    (): synapse.util.logcontext.LoggingContextFilter
+    request: ""
+
+handlers:
+  file:
+    class: logging.handlers.RotatingFileHandler
+    formatter: precise
+    filename: ${log_file}
+    maxBytes: 104857600
+    backupCount: 10
+    filters: [context]
+    level: INFO
+  console:
+    class: logging.StreamHandler
+    formatter: precise
+
+loggers:
+    synapse:
+        level: INFO
+
+    synapse.storage.SQL:
+        level: INFO
+
+root:
+    level: INFO
+    handlers: [file, console]
+""")
 
 
 class LoggingConfig(Config):
@@ -30,6 +71,9 @@ class LoggingConfig(Config):
 
     def default_config(self, config_dir_path, server_name):
         log_file = self.abspath("homeserver.log")
+        log_config = self.abspath(
+            os.path.join(config_dir_path, server_name + ".log.config")
+        )
         return """
         # Logging verbosity level.
         verbose: 0
@@ -38,7 +82,7 @@ class LoggingConfig(Config):
         log_file: "%(log_file)s"
 
         # A yaml python logging config file
-        #log_config: "your.log.config.yaml"
+        log_config: "%(log_config)s"
         """ % locals()
 
     def read_arguments(self, args):
@@ -64,6 +108,14 @@ class LoggingConfig(Config):
             help="Python logging config file"
         )
 
+    def generate_files(self, config):
+        log_config = config.get("log_config")
+        if log_config and not os.path.exists(log_config):
+            with open(log_config, "wb") as log_config_file:
+                log_config_file.write(
+                    DEFAULT_LOG_CONFIG.substitute(log_file=config["log_file"])
+                )
+
     def setup_logging(self):
         log_format = (
             "%(asctime)s - %(name)s - %(lineno)d - %(levelname)s - %(request)s"
diff --git a/synapse/config/tls.py b/synapse/config/tls.py
index e70bc1cd2c..ecb2d42c1f 100644
--- a/synapse/config/tls.py
+++ b/synapse/config/tls.py
@@ -70,7 +70,7 @@ class TlsConfig(Config):
         private_key_pem = self.read_file(private_key_path, "tls_private_key")
         return crypto.load_privatekey(crypto.FILETYPE_PEM, private_key_pem)
 
-    def generate_keys(self, config):
+    def generate_files(self, config):
         tls_certificate_path = config["tls_certificate_path"]
         tls_private_key_path = config["tls_private_key_path"]
         tls_dh_params_path = config["tls_dh_params_path"]