Matrix-Mirrors/synapse-product
1
0
Fork 0
mirror of https://git.anonymousland.org/anonymousland/synapse-product.git synced 2024-10-01 08:25:44 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1990 from matrix-org/rav/log_config_comments

Browse Source 
Add helpful texts to logger config options
This commit is contained in:
Richard van der Hoff 2017-03-13 16:42:12 +00:00 committed by GitHub
commit 31f3ca1b2b
2 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
contrib/example_log_config.yaml
View File

@ -39,7 +39,9 @@ loggers:
synapse: synapse:
level: INFO level: INFO
synapse.storage: synapse.storage.SQL:
# beware: increasing this to DEBUG will make synapse log sensitive
# information such as access tokens.
level: INFO level: INFO
# example of enabling debugging for a component: # example of enabling debugging for a component:

12
synapse/config/logger.py
View File

@ -45,7 +45,6 @@ handlers:
maxBytes: 104857600 maxBytes: 104857600
backupCount: 10 backupCount: 10
filters: [context] filters: [context]
level: INFO
console: console:
class: logging.StreamHandler class: logging.StreamHandler
formatter: precise formatter: precise
@ -56,6 +55,8 @@ loggers:
level: INFO level: INFO
synapse.storage.SQL: synapse.storage.SQL:
# beware: increasing this to DEBUG will make synapse log sensitive
# information such as access tokens.
level: INFO level: INFO
root: root:
@ -78,10 +79,10 @@ class LoggingConfig(Config):
os.path.join(config_dir_path, server_name + ".log.config") os.path.join(config_dir_path, server_name + ".log.config")
) )
return """ return """
# Logging verbosity level. # Logging verbosity level. Ignored if log_config is specified.
verbose: 0 verbose: 0
# File to write logging to # File to write logging to. Ignored if log_config is specified.
log_file: "%(log_file)s" log_file: "%(log_file)s"
# A yaml python logging config file # A yaml python logging config file
@ -102,11 +103,12 @@ class LoggingConfig(Config):
logging_group = parser.add_argument_group("logging") logging_group = parser.add_argument_group("logging")
logging_group.add_argument( logging_group.add_argument(
'-v', '--verbose', dest="verbose", action='count', '-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( logging_group.add_argument(
'-f', '--log-file', dest="log_file", '-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( logging_group.add_argument(
'--log-config', dest="log_config", default=None, '--log-config', dest="log_config", default=None,