summary refs log tree commit diff
path: root/develop/upgrade.html
diff options
context:
space:
mode:
authorsquahtx <squahtx@users.noreply.github.com>2022-11-04 15:23:09 +0000
committersquahtx <squahtx@users.noreply.github.com>2022-11-04 15:23:09 +0000
commitcc0c84570cd0d0d7c7383760a98d60a33987498a (patch)
treefc11b620ffb5da7d182c702fb98398e8c66cc465 /develop/upgrade.html
parentdeploy: 78909f50286a857205269103b149be13e6cb95d1 (diff)
downloadsynapse-cc0c84570cd0d0d7c7383760a98d60a33987498a.tar.xz
deploy: e5d18956b9e58ec15f1c89b8b625065611ed413d
Diffstat (limited to 'develop/upgrade.html')
-rw-r--r--develop/upgrade.html10
1 files changed, 10 insertions, 0 deletions
diff --git a/develop/upgrade.html b/develop/upgrade.html
index 2fd643a761..c1fbadfd57 100644
--- a/develop/upgrade.html
+++ b/develop/upgrade.html
@@ -249,6 +249,16 @@ room to be interesting to the application service.</p>
 this will no longer match as you expect. The behavioral mismatch between matching all
 local users and some remote users is why the spec was changed/clarified and this
 caveat is no longer supported.</p>
+<h2 id="legacy-prometheus-metric-names-are-now-disabled-by-default"><a class="header" href="#legacy-prometheus-metric-names-are-now-disabled-by-default">Legacy Prometheus metric names are now disabled by default</a></h2>
+<p>Synapse v1.71.0 disables legacy Prometheus metric names by default.
+For administrators that still rely on them and have not yet had chance to update their
+uses of the metrics, it's still possible to specify <code>enable_legacy_metrics: true</code> in
+the configuration to re-enable them temporarily.</p>
+<p>Synapse v1.73.0 will <strong>remove legacy metric names altogether</strong> and at that point,
+it will no longer be possible to re-enable them.</p>
+<p>If you do not use metrics or you have already updated your Grafana dashboard(s),
+Prometheus console(s) and alerting rule(s), there is no action needed.</p>
+<p>See <a href="#deprecation-of-legacy-prometheus-metric-names">v1.69.0: Deprecation of legacy Prometheus metric names</a>.</p>
 <h1 id="upgrading-to-v1690"><a class="header" href="#upgrading-to-v1690">Upgrading to v1.69.0</a></h1>
 <h2 id="changes-to-the-receipts-replication-streams"><a class="header" href="#changes-to-the-receipts-replication-streams">Changes to the receipts replication streams</a></h2>
 <p>Synapse now includes information indicating if a receipt applies to a thread when