Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Update documentation to reflect that run_background_tasks_on is no longer experimental. #12451

Merged
merged 3 commits into from
Apr 14, 2022
Merged

Update documentation to reflect that run_background_tasks_on is no longer experimental. #12451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c67a07
Background workers aren't experimental anymore
reivilibre Apr 12, 2022
703f142
Newsfile
reivilibre Apr 12, 2022
a74ad9d
Stream writers aren't experimental either
reivilibre Apr 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/12451.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
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.
8 changes: 4 additions & 4 deletions docs/workers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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).
Expand Down