summary refs log tree commit diff
path: root/UPGRADE.rst
diff options
context:
space:
mode:
authorMichael Kaye <1917473+michaelkaye@users.noreply.github.com>2018-03-27 14:12:22 +0100
committerMichael Kaye <1917473+michaelkaye@users.noreply.github.com>2018-03-27 17:56:03 +0100
commitef520d8d0e152a24fb6660fdd2def214b6e9caae (patch)
treebf27621fe0f02d2f4606946d6d6d8ec061b26021 /UPGRADE.rst
parentMerge pull request #3017 from matrix-org/erikj/add_cache_control_headers (diff)
downloadsynapse-ef520d8d0e152a24fb6660fdd2def214b6e9caae.tar.xz
Include coarse CPU and Memory use in stats callbacks.
This requires the psutil module, and is still opt-in based on the report_stats
config option.
Diffstat (limited to 'UPGRADE.rst')
-rw-r--r--UPGRADE.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/UPGRADE.rst b/UPGRADE.rst
index 2efe7ea60f..f6bb1070b1 100644
--- a/UPGRADE.rst
+++ b/UPGRADE.rst
@@ -48,6 +48,18 @@ returned by the Client-Server API:
     # configured on port 443.
     curl -kv https://<host.name>/_matrix/client/versions 2>&1 | grep "Server:"
 
+Upgrading to $NEXT_VERSION
+====================
+
+This release expands the anonymous usage stats sent if the opt-in
+``report_stats`` configuration is set to ``true``. We now capture RSS memory 
+and cpu use at a very coarse level. This requires administrators to install
+the optional ``psutil`` python module.
+
+We would appreciate it if you could assist by ensuring this module is available
+and ``report_stats`` is enabled. This will let us see if performance changes to
+synapse are having an impact to the general community.
+
 Upgrading to v0.15.0
 ====================