From 4c67a07e5a71824021cd75fc3e03be02a5554529 Mon Sep 17 00:00:00 2001 From: "Olivier Wilkinson (reivilibre)" Date: Tue, 12 Apr 2022 16:40:39 +0100 Subject: [PATCH 1/3] Background workers aren't experimental anymore --- docs/workers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/workers.md b/docs/workers.md index caef44b614de..82c6b679d999 100644 --- a/docs/workers.md +++ b/docs/workers.md @@ -422,7 +422,7 @@ the stream writer for the `presence` stream: #### Background tasks -There is also *experimental* support for moving background tasks to a separate +There is also support for moving background tasks to a separate worker. Background tasks are run periodically or started via replication. Exactly which tasks are configured to run depends on your Synapse configuration (e.g. if stats is enabled). From 703f142cf7656bd4f468068157a6bed3596be377 Mon Sep 17 00:00:00 2001 From: "Olivier Wilkinson (reivilibre)" Date: Tue, 12 Apr 2022 16:41:32 +0100 Subject: [PATCH 2/3] Newsfile Signed-off-by: Olivier Wilkinson (reivilibre) --- changelog.d/12451.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/12451.doc diff --git a/changelog.d/12451.doc b/changelog.d/12451.doc new file mode 100644 index 000000000000..80b690b88bf0 --- /dev/null +++ b/changelog.d/12451.doc @@ -0,0 +1 @@ +Update documentation to reflect that `run_background_tasks_on` is no longer experimental. \ No newline at end of file From a74ad9d8d70329c8945f3b2627127ae8b0d7619e Mon Sep 17 00:00:00 2001 From: "Olivier Wilkinson (reivilibre)" Date: Thu, 14 Apr 2022 13:48:23 +0100 Subject: [PATCH 3/3] Stream writers aren't experimental either --- changelog.d/12451.doc | 2 +- docs/workers.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/changelog.d/12451.doc b/changelog.d/12451.doc index 80b690b88bf0..c8b23c128539 100644 --- a/changelog.d/12451.doc +++ b/changelog.d/12451.doc @@ -1 +1 @@ -Update documentation to reflect that `run_background_tasks_on` is no longer experimental. \ No newline at end of file +Update documentation to reflect that both the `run_background_tasks_on` option and the options for moving stream writers off of the main process are no longer experimental. diff --git a/docs/workers.md b/docs/workers.md index 82c6b679d999..986695f82d22 100644 --- a/docs/workers.md +++ b/docs/workers.md @@ -343,9 +343,9 @@ effects of bursts of events from that bridge on events sent by normal users. #### Stream writers -Additionally, there is *experimental* support for moving writing of specific -streams (such as events) off of the main process to a particular worker. (This -is only supported with Redis-based replication.) +Additionally, the writing of specific streams (such as events) can be moved off +of the main process to a particular worker. +(This is only supported with Redis-based replication.) To enable this, the worker must have a HTTP replication listener configured, have a `worker_name` and be listed in the `instance_map` config. The same worker