add report_stats_endpoint config option

changelog.d/6012.feature

@@ -0,0 +1 @@
+Add report_stats_endpoint option to configure where stats are reported to, if enabled. Contributed by @Sorunome.

docs/sample_config.yaml

@@ -978,6 +978,11 @@ metrics_flags:
 # Whether or not to report anonymized homeserver usage statistics.
 # report_stats: true|false
 
+# The endpoint to report the anonymized homeserver usage statistics to.
+# Defaults to https://matrix.org/report-usage-stats/push
+#
+#report_stats_endpoint: https://example.com/report-usage-stats/push
+
 
 ## API Configuration ##
 

synapse/app/homeserver.py

@@ -561,10 +561,12 @@ def phone_stats_home():
 
  stats["database_engine"] = hs.get_datastore().database_engine_name
  stats["database_server_version"] = hs.get_datastore().get_server_version()
- logger.info("Reporting stats to matrix.org: %s" % (stats,))
+ logger.info(
+ "Reporting stats to %s: %s" % (hs.config.report_stats_endpoint, stats)
+ )
  try:
  yield hs.get_simple_http_client().put_json(
- "https://matrix.org/report-usage-stats/push", stats
+ hs.config.report_stats_endpoint, stats
  )
  except Exception as e:
  logger.warn("Error reporting stats: %s", e)

synapse/config/metrics.py

@@ -39,6 +39,9 @@ class MetricsConfig(Config):
  def read_config(self, config, **kwargs):
  self.enable_metrics = config.get("enable_metrics", False)
  self.report_stats = config.get("report_stats", None)
+ self.report_stats_endpoint = config.get(
+ "report_stats_endpoint", "https://matrix.org/report-usage-stats/push"
+ )
  self.metrics_port = config.get("metrics_port")
  self.metrics_bind_host = config.get("metrics_bind_host", "127.0.0.1")
 
@@ -97,4 +100,10 @@ def generate_config_section(self, report_stats=None, **kwargs):
  else:
  res += "report_stats: %s\n" % ("true" if report_stats else "false")
 
+ res += """
+ # The endpoint to report the anonymized homeserver usage statistics to.
+ # Defaults to https://matrix.org/report-usage-stats/push
+ #
+ #report_stats_endpoint: https://example.com/report-usage-stats/push
+ """
  return res