From 6cb415b63fd58ab253f8519f725a581a0e15044e Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Wed, 13 Feb 2019 16:14:37 +0000
Subject: [PATCH] Fixup comments and add warning

---
 changelog.d/4632.feature  | 2 +-
 synapse/app/_base.py      | 6 +++---
 synapse/config/metrics.py | 9 +++++++--
 3 files changed, 11 insertions(+), 6 deletions(-)

diff --git a/changelog.d/4632.feature b/changelog.d/4632.feature
index 0bdeb3738a..d053ab5a25 100644
--- a/changelog.d/4632.feature
+++ b/changelog.d/4632.feature
@@ -1 +1 @@
-Add basic optional sentry.io integration
+Add basic optional sentry integration
diff --git a/synapse/app/_base.py b/synapse/app/_base.py
index 482f0e22ea..0284151d0f 100644
--- a/synapse/app/_base.py
+++ b/synapse/app/_base.py
@@ -269,7 +269,7 @@ def start(hs, listeners=None):
         hs.start_listening(listeners)
         hs.get_datastore().start_profiling()
 
-        setup_sentry_io(hs)
+        setup_sentry(hs)
     except Exception:
         traceback.print_exc(file=sys.stderr)
         reactor = hs.get_reactor()
@@ -278,8 +278,8 @@ def start(hs, listeners=None):
         sys.exit(1)
 
 
-def setup_sentry_io(hs):
-    """Enable sentry.io integration, if enabled in configuration
+def setup_sentry(hs):
+    """Enable sentry integration, if enabled in configuration
 
     Args:
         hs (synapse.server.HomeServer)
diff --git a/synapse/config/metrics.py b/synapse/config/metrics.py
index 7bab8b0b2b..185b895a24 100644
--- a/synapse/config/metrics.py
+++ b/synapse/config/metrics.py
@@ -16,7 +16,7 @@
 from ._base import Config, ConfigError
 
 MISSING_SENTRY = (
-    """Missing sentry_sdk library. This is required for enable sentry.io
+    """Missing sentry_sdk library. This is required for enable sentry
     integration.
 
     Install by running:
@@ -48,7 +48,12 @@ class MetricsConfig(Config):
         # Enable collection and rendering of performance metrics
         enable_metrics: False
 
-        # Enable sentry.io integration
+        # Enable sentry integration
+        # NOTE: While attempts are made to ensure that the logs don't contain
+        # any sensitive information, this cannot be guaranteed. By enabling
+        # this option the sentry server may therefore receive sensitive
+        # information, and it in turn may then diseminate sensitive information
+        # through insecure notification channels if so configured.
         #sentry:
         #    dsn: "..."
         """