diff options
| author | Patrick Cloke <clokep@users.noreply.github.com> | 2022-02-17 08:32:18 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-17 13:32:18 +0000 |
| commit | e69f8f0a8e3b3f3b647efc42fe67b6b9270d26e0 (patch) | |
| tree | 38e4e9022feb5393fd614291504bb0da6c65780c /docs | |
| parent | `send_join` response: get create event from `state`, not `auth_chain` (#12005) (diff) | |
| download | synapse-e69f8f0a8e3b3f3b647efc42fe67b6b9270d26e0.tar.xz | |
Remove support for the legacy structured logging configuration. (#12008)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/structured_logging.md | 14 | ||||
| -rw-r--r-- | docs/upgrade.md | 9 |
2 files changed, 15 insertions, 8 deletions
diff --git a/docs/structured_logging.md b/docs/structured_logging.md index 14db85f587..805c867653 100644 --- a/docs/structured_logging.md +++ b/docs/structured_logging.md @@ -81,14 +81,12 @@ remote endpoint at 10.1.2.3:9999. ## Upgrading from legacy structured logging configuration -Versions of Synapse prior to v1.23.0 included a custom structured logging -configuration which is deprecated. It used a `structured: true` flag and -configured `drains` instead of ``handlers`` and `formatters`. - -Synapse currently automatically converts the old configuration to the new -configuration, but this will be removed in a future version of Synapse. The -following reference can be used to update your configuration. Based on the drain -`type`, we can pick a new handler: +Versions of Synapse prior to v1.54.0 automatically converted the legacy +structured logging configuration, which was deprecated in v1.23.0, to the standard +library logging configuration. + +The following reference can be used to update your configuration. Based on the +drain `type`, we can pick a new handler: 1. For a type of `console`, `console_json`, or `console_json_terse`: a handler with a class of `logging.StreamHandler` and a `stream` of `ext://sys.stdout` diff --git a/docs/upgrade.md b/docs/upgrade.md index 477d7d0e81..9860ae97b9 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -85,6 +85,15 @@ process, for example: dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb ``` +# Upgrading to v1.54.0 + +## Legacy structured logging configuration removal + +This release removes support for the `structured: true` logging configuration +which was deprecated in Synapse v1.23.0. If your logging configuration contains +`structured: true` then it should be modified based on the +[structured logging documentation](structured_logging.md). + # Upgrading to v1.53.0 ## Dropping support for `webclient` listeners and non-HTTP(S) `web_client_location` |