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

Make the configuration for the cache clearer #13481

Merged
merged 2 commits into from
Aug 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/13481.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Make the configuration for the cache clearer.
9 changes: 5 additions & 4 deletions docs/usage/configuration/config_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -1056,26 +1056,26 @@ allow_device_name_lookup_over_federation: true
---
## Caching ##

Options related to caching
Options related to caching.

---
### `event_cache_size`

The number of events to cache in memory. Not affected by
`caches.global_factor`. Defaults to 10K.
`caches.global_factor` and is not part of the `caches` section. Defaults to 10K.

Example configuration:
```yaml
event_cache_size: 15K
```
---
### `cache` and associated values
### `caches` and associated values

A cache 'factor' is a multiplier that can be applied to each of
Synapse's caches in order to increase or decrease the maximum
number of entries that can be stored.

Caching can be configured through the following sub-options:
`caches` can be configured through the following sub-options:

* `global_factor`: Controls the global cache factor, which is the default cache factor
for all caches if a specific factor for that cache is not otherwise
Expand Down Expand Up @@ -1137,6 +1137,7 @@ Caching can be configured through the following sub-options:

Example configuration:
```yaml
event_cache_size: 15K
caches:
global_factor: 1.0
per_cache_factors:
Expand Down