mirror of
https://github.com/element-hq/synapse
synced 2024-08-19 09:10:52 +00:00
deploy: 9af2be192a
This commit is contained in:
parent
486019057a
commit
edf8d08a3e
5 changed files with 32 additions and 38 deletions
|
@ -1761,6 +1761,21 @@ dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb
|
||||||
</code></pre>
|
</code></pre>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
<h1 id="upgrading-to-v1730"><a class="header" href="#upgrading-to-v1730">Upgrading to v1.73.0</a></h1>
|
||||||
|
<h2 id="legacy-prometheus-metric-names-have-now-been-removed"><a class="header" href="#legacy-prometheus-metric-names-have-now-been-removed">Legacy Prometheus metric names have now been removed</a></h2>
|
||||||
|
<p>Synapse v1.69.0 included the deprecation of legacy Prometheus metric names
|
||||||
|
and offered an option to disable them.
|
||||||
|
Synapse v1.71.0 disabled legacy Prometheus metric names by default.</p>
|
||||||
|
<p>This version, v1.73.0, removes those legacy Prometheus metric names entirely.
|
||||||
|
This also means that the <code>enable_legacy_metrics</code> configuration option has been
|
||||||
|
removed; it will no longer be possible to re-enable the legacy metric names.</p>
|
||||||
|
<p>If you use metrics and have not yet updated your Grafana dashboard(s),
|
||||||
|
Prometheus console(s) or alerting rule(s), please consider doing so when upgrading
|
||||||
|
to this version.
|
||||||
|
Note that the included Grafana dashboard was updated in v1.72.0 to correct some
|
||||||
|
metric names which were missed when legacy metrics were disabled by default.</p>
|
||||||
|
<p>See <a href="upgrade.html#deprecation-of-legacy-prometheus-metric-names">v1.69.0: Deprecation of legacy Prometheus metric names</a>
|
||||||
|
for more context.</p>
|
||||||
<h1 id="upgrading-to-v1720"><a class="header" href="#upgrading-to-v1720">Upgrading to v1.72.0</a></h1>
|
<h1 id="upgrading-to-v1720"><a class="header" href="#upgrading-to-v1720">Upgrading to v1.72.0</a></h1>
|
||||||
<h2 id="dropping-support-for-postgresql-10"><a class="header" href="#dropping-support-for-postgresql-10">Dropping support for PostgreSQL 10</a></h2>
|
<h2 id="dropping-support-for-postgresql-10"><a class="header" href="#dropping-support-for-postgresql-10">Dropping support for PostgreSQL 10</a></h2>
|
||||||
<p>In line with our <a href="deprecation_policy.html">deprecation policy</a>, we've dropped
|
<p>In line with our <a href="deprecation_policy.html">deprecation policy</a>, we've dropped
|
||||||
|
@ -5414,24 +5429,6 @@ Defaults to false.</p>
|
||||||
<pre><code class="language-yaml">enable_metrics: true
|
<pre><code class="language-yaml">enable_metrics: true
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<hr />
|
<hr />
|
||||||
<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>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>
|
|
||||||
<li>counters that don't end with the <code>_total</code> suffix, such as <code>synapse_federation_client_sent_edus</code>, therefore not adhering to the OpenMetrics standard.</li>
|
|
||||||
</ul>
|
|
||||||
<p>These legacy metric names are unconventional and not compliant with OpenMetrics standards.
|
|
||||||
They are included for backwards compatibility.</p>
|
|
||||||
<p>Example configuration:</p>
|
|
||||||
<pre><code class="language-yaml">enable_legacy_metrics: false
|
|
||||||
</code></pre>
|
|
||||||
<p>See https://github.com/matrix-org/synapse/issues/11106 for context.</p>
|
|
||||||
<p><em>Since v1.67.0.</em></p>
|
|
||||||
<h2 id="will-be-removed-in-v1730"><a class="header" href="#will-be-removed-in-v1730"><strong>Will be removed in v1.73.0.</strong></a></h2>
|
|
||||||
<h3 id="sentry"><a class="header" href="#sentry"><code>sentry</code></a></h3>
|
<h3 id="sentry"><a class="header" href="#sentry"><code>sentry</code></a></h3>
|
||||||
<p>Use this option to enable sentry integration. Provide the DSN assigned to you by sentry
|
<p>Use this option to enable sentry integration. Provide the DSN assigned to you by sentry
|
||||||
with the <code>dsn</code> setting.</p>
|
with the <code>dsn</code> setting.</p>
|
||||||
|
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
@ -231,6 +231,21 @@ dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb
|
||||||
</code></pre>
|
</code></pre>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
<h1 id="upgrading-to-v1730"><a class="header" href="#upgrading-to-v1730">Upgrading to v1.73.0</a></h1>
|
||||||
|
<h2 id="legacy-prometheus-metric-names-have-now-been-removed"><a class="header" href="#legacy-prometheus-metric-names-have-now-been-removed">Legacy Prometheus metric names have now been removed</a></h2>
|
||||||
|
<p>Synapse v1.69.0 included the deprecation of legacy Prometheus metric names
|
||||||
|
and offered an option to disable them.
|
||||||
|
Synapse v1.71.0 disabled legacy Prometheus metric names by default.</p>
|
||||||
|
<p>This version, v1.73.0, removes those legacy Prometheus metric names entirely.
|
||||||
|
This also means that the <code>enable_legacy_metrics</code> configuration option has been
|
||||||
|
removed; it will no longer be possible to re-enable the legacy metric names.</p>
|
||||||
|
<p>If you use metrics and have not yet updated your Grafana dashboard(s),
|
||||||
|
Prometheus console(s) or alerting rule(s), please consider doing so when upgrading
|
||||||
|
to this version.
|
||||||
|
Note that the included Grafana dashboard was updated in v1.72.0 to correct some
|
||||||
|
metric names which were missed when legacy metrics were disabled by default.</p>
|
||||||
|
<p>See <a href="#deprecation-of-legacy-prometheus-metric-names">v1.69.0: Deprecation of legacy Prometheus metric names</a>
|
||||||
|
for more context.</p>
|
||||||
<h1 id="upgrading-to-v1720"><a class="header" href="#upgrading-to-v1720">Upgrading to v1.72.0</a></h1>
|
<h1 id="upgrading-to-v1720"><a class="header" href="#upgrading-to-v1720">Upgrading to v1.72.0</a></h1>
|
||||||
<h2 id="dropping-support-for-postgresql-10"><a class="header" href="#dropping-support-for-postgresql-10">Dropping support for PostgreSQL 10</a></h2>
|
<h2 id="dropping-support-for-postgresql-10"><a class="header" href="#dropping-support-for-postgresql-10">Dropping support for PostgreSQL 10</a></h2>
|
||||||
<p>In line with our <a href="deprecation_policy.html">deprecation policy</a>, we've dropped
|
<p>In line with our <a href="deprecation_policy.html">deprecation policy</a>, we've dropped
|
||||||
|
|
|
@ -2112,24 +2112,6 @@ Defaults to false.</p>
|
||||||
<pre><code class="language-yaml">enable_metrics: true
|
<pre><code class="language-yaml">enable_metrics: true
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<hr />
|
<hr />
|
||||||
<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>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>
|
|
||||||
<li>counters that don't end with the <code>_total</code> suffix, such as <code>synapse_federation_client_sent_edus</code>, therefore not adhering to the OpenMetrics standard.</li>
|
|
||||||
</ul>
|
|
||||||
<p>These legacy metric names are unconventional and not compliant with OpenMetrics standards.
|
|
||||||
They are included for backwards compatibility.</p>
|
|
||||||
<p>Example configuration:</p>
|
|
||||||
<pre><code class="language-yaml">enable_legacy_metrics: false
|
|
||||||
</code></pre>
|
|
||||||
<p>See https://github.com/matrix-org/synapse/issues/11106 for context.</p>
|
|
||||||
<p><em>Since v1.67.0.</em></p>
|
|
||||||
<h2 id="will-be-removed-in-v1730"><a class="header" href="#will-be-removed-in-v1730"><strong>Will be removed in v1.73.0.</strong></a></h2>
|
|
||||||
<h3 id="sentry"><a class="header" href="#sentry"><code>sentry</code></a></h3>
|
<h3 id="sentry"><a class="header" href="#sentry"><code>sentry</code></a></h3>
|
||||||
<p>Use this option to enable sentry integration. Provide the DSN assigned to you by sentry
|
<p>Use this option to enable sentry integration. Provide the DSN assigned to you by sentry
|
||||||
with the <code>dsn</code> setting.</p>
|
with the <code>dsn</code> setting.</p>
|
||||||
|
|
Loading…
Reference in a new issue