Matrix-Mirrors/synapse-product
1
0
Fork 0
mirror of https://git.anonymousland.org/anonymousland/synapse-product.git synced 2024-12-16 05:44:21 -05:00
Code Issues Packages Projects Releases Wiki Activity

Make the configuration for the cache clearer (#13481)

Browse Source
This commit is contained in:
Dirk Klimpel 2022-08-09 12:30:22 +02:00 committed by GitHub
parent 0f954466c4
commit 70d3e70009
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/13481.doc Normal file
View File

@ -0,0 +1 @@
Make the configuration for the cache clearer.

9
docs/usage/configuration/config_documentation.md
View File

@ -1056,26 +1056,26 @@ allow_device_name_lookup_over_federation: true
--- ---
## Caching ## ## Caching ##
Options related to caching Options related to caching.
--- ---
### `event_cache_size` ### `event_cache_size`
The number of events to cache in memory. Not affected by 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: Example configuration:
```yaml ```yaml
event_cache_size: 15K 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 A cache 'factor' is a multiplier that can be applied to each of
Synapse's caches in order to increase or decrease the maximum Synapse's caches in order to increase or decrease the maximum
number of entries that can be stored. 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 * `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 for all caches if a specific factor for that cache is not otherwise
@ -1137,6 +1137,7 @@ Caching can be configured through the following sub-options:
Example configuration: Example configuration:
```yaml ```yaml
event_cache_size: 15K
caches: caches:
global_factor: 1.0 global_factor: 1.0
per_cache_factors: per_cache_factors: