summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorRichard van der Hoff <1389908+richvdh@users.noreply.github.com>2021-03-16 10:57:54 +0000
committerGitHub <noreply@github.com>2021-03-16 10:57:54 +0000
commit5b5bc188cfc3c31be83058ccbe5a17bfde1b0021 (patch)
tree6749e4a449223e192c03d2fa1d5c61573e28b9a0 /docs
parentPrevent bundling aggregations for state events (#9619) (diff)
downloadsynapse-5b5bc188cfc3c31be83058ccbe5a17bfde1b0021.tar.xz
Clean up config settings for stats (#9604)
... and complain if people try to turn it off.
Diffstat (limited to 'docs')
-rw-r--r--docs/sample_config.yaml25
1 files changed, 13 insertions, 12 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index c32ee4a897..41ab35595b 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -2645,19 +2645,20 @@ user_directory:
 
 
 
-# Local statistics collection. Used in populating the room directory.
+# Settings for local room and user statistics collection. See
+# docs/room_and_user_statistics.md.
 #
-# 'bucket_size' controls how large each statistics timeslice is. It can
-# be defined in a human readable short form -- e.g. "1d", "1y".
-#
-# 'retention' controls how long historical statistics will be kept for.
-# It can be defined in a human readable short form -- e.g. "1d", "1y".
-#
-#
-#stats:
-#   enabled: true
-#   bucket_size: 1d
-#   retention: 1y
+stats:
+  # Uncomment the following to disable room and user statistics. Note that doing
+  # so may cause certain features (such as the room directory) not to work
+  # correctly.
+  #
+  #enabled: false
+
+  # The size of each timeslice in the room_stats_historical and
+  # user_stats_historical tables, as a time period. Defaults to "1d".
+  #
+  #bucket_size: 1h
 
 
 # Server Notices room configuration