Matrix/synapse
Matrix/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse synced 2024-06-30 16:03:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Note LoggingContext signature change incompatibility in 1.32.0 (#9859)

Browse source 
1.32.0 also introduced an incompatibility with Synapse modules that make use of `synapse.logging.context.LoggingContext`, such as [synapse-s3-storage-provider](https://github.com/matrix-org/synapse-s3-storage-provider).

This PR adds a note to the 1.32.0 changelog and upgrade notes about it.
This commit is contained in:
Andrew Morgan 2021-04-21 18:16:58 +01:00 committed by GitHub
parent bdb4c20dc1
commit 0c23aa393c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
CHANGES.md
View file

@ -2,10 +2,10 @@ Synapse 1.32.1 (2021-04-21)
=========================== ===========================
This release fixes [a regression](https://github.com/matrix-org/synapse/issues/9853) This release fixes [a regression](https://github.com/matrix-org/synapse/issues/9853)
in Synapse 1.32.0 that caused connected Prometheus instances to become unstable. If you in Synapse 1.32.0 that caused connected Prometheus instances to become unstable.
ran Synapse 1.32.0 with Prometheus metrics, first upgrade to Synapse 1.32.1 and follow
[these instructions](https://github.com/matrix-org/synapse/pull/9854#issuecomment-823472183) However, as this release is still subject to the `LoggingContext` change in 1.32.0,
to clean up any excess writeahead logs. it is recommended to remain on or downgrade to 1.31.0.
Bugfixes Bugfixes
-------- --------
@ -18,7 +18,14 @@ Synapse 1.32.0 (2021-04-20)
**Note:** This release introduces [a regression](https://github.com/matrix-org/synapse/issues/9853) **Note:** This release introduces [a regression](https://github.com/matrix-org/synapse/issues/9853)
that can overwhelm connected Prometheus instances. This issue was not present in that can overwhelm connected Prometheus instances. This issue was not present in
1.32.0rc1, and is fixed in 1.32.1. See the changelog for 1.32.1 above for more information. 1.32.0rc1. If affected, it is recommended to downgrade to 1.31.0 in the meantime, and
follow [these instructions](https://github.com/matrix-org/synapse/pull/9854#issuecomment-823472183)
to clean up any excess writeahead logs.
**Note:** This release also mistakenly included a change that may affected Synapse
modules that import `synapse.logging.context.LoggingContext`, such as
[synapse-s3-storage-provider](https://github.com/matrix-org/synapse-s3-storage-provider).
This will be fixed in a later Synapse version.
**Note:** This release requires Python 3.6+ and Postgres 9.6+ or SQLite 3.22+. **Note:** This release requires Python 3.6+ and Postgres 9.6+ or SQLite 3.22+.

8
UPGRADE.rst
View file

@ -93,11 +93,11 @@ Regression causing connected Prometheus instances to become overwhelmed
This release introduces `a regression <https://github.com/matrix-org/synapse/issues/9853>`_ This release introduces `a regression <https://github.com/matrix-org/synapse/issues/9853>`_
that can overwhelm connected Prometheus instances. This issue is not present in that can overwhelm connected Prometheus instances. This issue is not present in
Synapse v1.32.0rc1, and is fixed in Synapse v1.32.1. Synapse v1.32.0rc1.
If you have been affected, please first upgrade to a more recent Synapse version. If you have been affected, please downgrade to 1.31.0. You then may need to
You then may need to remove excess writeahead logs in order for Prometheus to recover. remove excess writeahead logs in order for Prometheus to recover. Instructions
Instructions for doing so are provided for doing so are provided
`here <https://github.com/matrix-org/synapse/pull/9854#issuecomment-823472183>`_. `here <https://github.com/matrix-org/synapse/pull/9854#issuecomment-823472183>`_.
Dropping support for old Python, Postgres and SQLite versions Dropping support for old Python, Postgres and SQLite versions