diff options
| author | Richard van der Hoff <github@rvanderhoff.org.uk> | 2017-03-13 16:42:12 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-03-13 16:42:12 +0000 |
| commit | 31f3ca1b2b011b1b0920a3e8e2fe10bcdf6c7ca3 (patch) | |
| tree | 1e30c5fee781d04349010ce00775937d3fe78997 | |
| parent | Merge pull request #1978 from matrix-org/rav/refactor_received_pdu (diff) | |
| parent | Bring example log config into line with default (diff) | |
| download | synapse-31f3ca1b2b011b1b0920a3e8e2fe10bcdf6c7ca3.tar.xz | |
Merge pull request #1990 from matrix-org/rav/log_config_comments
Add helpful texts to logger config options
| -rw-r--r-- | contrib/example_log_config.yaml | 6 | ||||
| -rw-r--r-- | synapse/config/logger.py | 12 |
2 files changed, 11 insertions, 7 deletions
diff --git a/contrib/example_log_config.yaml b/contrib/example_log_config.yaml index 7f7c8ba588..c7aa68abf2 100644 --- a/contrib/example_log_config.yaml +++ b/contrib/example_log_config.yaml @@ -39,9 +39,11 @@ loggers: synapse: level: INFO - synapse.storage: + synapse.storage.SQL: + # beware: increasing this to DEBUG will make synapse log sensitive + # information such as access tokens. level: INFO - + # example of enabling debugging for a component: # # synapse.federation.transport.server: diff --git a/synapse/config/logger.py b/synapse/config/logger.py index e5d945e5b8..2dbeafa9dd 100644 --- a/synapse/config/logger.py +++ b/synapse/config/logger.py @@ -45,7 +45,6 @@ handlers: maxBytes: 104857600 backupCount: 10 filters: [context] - level: INFO console: class: logging.StreamHandler formatter: precise @@ -56,6 +55,8 @@ loggers: level: INFO synapse.storage.SQL: + # beware: increasing this to DEBUG will make synapse log sensitive + # information such as access tokens. level: INFO root: @@ -78,10 +79,10 @@ class LoggingConfig(Config): os.path.join(config_dir_path, server_name + ".log.config") ) return """ - # Logging verbosity level. + # Logging verbosity level. Ignored if log_config is specified. verbose: 0 - # File to write logging to + # File to write logging to. Ignored if log_config is specified. log_file: "%(log_file)s" # A yaml python logging config file @@ -102,11 +103,12 @@ class LoggingConfig(Config): logging_group = parser.add_argument_group("logging") logging_group.add_argument( '-v', '--verbose', dest="verbose", action='count', - help="The verbosity level." + help="The verbosity level. Specify multiple times to increase " + "verbosity. (Ignored if --log-config is specified.)" ) logging_group.add_argument( '-f', '--log-file', dest="log_file", - help="File to log to." + help="File to log to. (Ignored if --log-config is specified.)" ) logging_group.add_argument( '--log-config', dest="log_config", default=None, |