From bce165f24756b6129d809262157652aa17bf34db Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Tue, 6 Aug 2019 07:14:52 +0300 Subject: [PATCH] Do not suggest DEBUG logging when submitting issues It's been pointed out that DEBUG logs could contain sensitive information (access tokens, etc.), which makes them unsuitable for sharing with others. INFO should be enough. --- docs/maintenance-and-troubleshooting.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/maintenance-and-troubleshooting.md b/docs/maintenance-and-troubleshooting.md index ff1f9e49e..18bfdd837 100644 --- a/docs/maintenance-and-troubleshooting.md +++ b/docs/maintenance-and-troubleshooting.md @@ -21,14 +21,14 @@ sudo journalctl -fu matrix-synapse Because the [Synapse](https://github.com/matrix-org/synapse) Matrix server is originally very chatty when it comes to logging, we intentionally reduce its [logging level](https://docs.python.org/3/library/logging.html#logging-levels) from `INFO` to `WARNING`. -If you'd like to debug an issue or [report a Synapse bug](https://github.com/matrix-org/synapse/issues/new/choose) to the developers, it'd be better if you temporarily increasing the logging level to `INFO` or even `DEBUG`. +If you'd like to debug an issue or [report a Synapse bug](https://github.com/matrix-org/synapse/issues/new/choose) to the developers, it'd be better if you temporarily increasing the logging level to `INFO`. Example configuration (`inventory/host_vars/matrix.DOMAIN/vars.yml`): ```yaml -matrix_synapse_log_level: "DEBUG" -matrix_synapse_storage_sql_log_level: "DEBUG" -matrix_synapse_root_log_level: "DEBUG" +matrix_synapse_log_level: "INFO" +matrix_synapse_storage_sql_log_level: "INFO" +matrix_synapse_root_log_level: "INFO" ``` Re-run the playbook after making these configuration changes.