|
|
@@ -1642,6 +1642,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="upgrade.html#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
|
|
|
@@ -5265,8 +5275,8 @@ Defaults to false.</p>
|
|
|
<h3 id="enable_legacy_metrics"><a class="header" href="#enable_legacy_metrics"><code>enable_legacy_metrics</code></a></h3>
|
|
|
<p>Set to <code>true</code> to publish both legacy and non-legacy Prometheus metric names,
|
|
|
or to <code>false</code> to only publish non-legacy Prometheus metric names.
|
|
|
-Defaults to <code>true</code>. Has no effect if <code>enable_metrics</code> is <code>false</code>.
|
|
|
-<strong>In Synapse v1.71.0, this will default to <code>false</code> before being removed in Synapse v1.73.0.</strong></p>
|
|
|
+Defaults to <code>false</code>. Has no effect if <code>enable_metrics</code> is <code>false</code>.
|
|
|
+<strong>In Synapse v1.67.0 up to and including Synapse v1.70.1, this defaulted to <code>true</code>.</strong></p>
|
|
|
<p>Legacy metric names include:</p>
|
|
|
<ul>
|
|
|
<li>metrics containing colons in the name, such as <code>synapse_util_caches_response_cache:hits</code>, because colons are supposed to be reserved for user-defined recording rules;</li>
|
reivilibre