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

Document how to set up multiple event persisters #8706

Merged
merged 3 commits into from
Nov 3, 2020
Merged

Document how to set up multiple event persisters #8706

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
536d946
Document how to set up multiple event persisters
erikjohnston Nov 2, 2020
2b57c0a
Newsfile
erikjohnston Nov 2, 2020
f346661
Fixup wording
erikjohnston Nov 3, 2020
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/8706.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document experimental support for running multiple event persisters.
12 changes: 12 additions & 0 deletions docs/workers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,18 @@ stream_writers:
events: event_persister1
```

The `events` stream also experimentally supports having multiple writers, where
work is sharded between them by room ID. Note that you *must* restart all
instances when adding or removing event persisters. An example `stream_writers`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
work is sharded between them by room ID. Note that you *must* restart all
instances when adding or removing event persisters. An example `stream_writers`
work is sharded between them by room ID. Note that you *must* restart all
even persister instances when adding or removing event persisters. An example `stream_writers`

While a little repetitive, I originally wasn't sure whether this meant all event persisters or all workers.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do mean all instances though. Will try and reword

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, just say "restart all worker instances" perhaps?

configuration with multiple writers:

```yaml
stream_writers:
events:
- event_persister1
- event_persister2
```

#### Background tasks

There is also *experimental* support for moving background tasks to a separate
Expand Down