summary refs log tree commit diff
path: root/docs/usage/configuration
diff options
context:
space:
mode:
authorAmanda H. L. de Andrade Katz <amanda.katz@canonical.com>2024-04-26 05:44:54 -0300
committerGitHub <noreply@github.com>2024-04-26 09:44:54 +0100
commit0ef2315a99859217e319e4cb5a29d88a054952ff (patch)
treefee028a65ed360b518f248d04b122d2aef8d7c0d /docs/usage/configuration
parentReturn the search terms as search highlights for SQLite instead of nothing (#... (diff)
downloadsynapse-0ef2315a99859217e319e4cb5a29d88a054952ff.tar.xz
Update event_cache_size and global_factor configurations documentation (#17071)
### Pull Request Checklist

<!-- Please read
https://element-hq.github.io/synapse/latest/development/contributing_guide.html
before submitting your pull request -->

* [x] Pull request is based on the develop branch
* [x] Pull request includes a [changelog
file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog).
The entry should:
- Be a short description of your change which makes sense to users.
"Fixed a bug that prevented receiving messages from other servers."
instead of "Moved X method from `EventStore` to `EventWorkerStore`.".
  - Use markdown where necessary, mostly for `code blocks`.
  - End with either a period (.) or an exclamation mark (!).
  - Start with a capital letter.
- Feel free to credit yourself, by adding a sentence "Contributed by
@github_username." or "Contributed by [Your Name]." to the end of the
entry.
* [x] [Code
style](https://element-hq.github.io/synapse/latest/code_style.html) is
correct
(run the
[linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters))
Diffstat (limited to 'docs/usage/configuration')
-rw-r--r--docs/usage/configuration/config_documentation.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 985f90c8a1..bcd53145f1 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -1317,6 +1317,12 @@ Options related to caching.
 The number of events to cache in memory. Defaults to 10K. Like other caches,
 this is affected by `caches.global_factor` (see below).
 
+For example, the default is 10K and the global_factor default is 0.5.
+
+Since 10K * 0.5 is 5K then the event cache size will be 5K.
+
+The cache affected by this configuration is named as "*getEvent*".
+
 Note that this option is not part of the `caches` section.
 
 Example configuration:
@@ -1342,6 +1348,8 @@ number of entries that can be stored.
 
   Defaults to 0.5, which will halve the size of all caches.
 
+  Note that changing this value also affects the HTTP connection pool.
+
 * `per_cache_factors`: A dictionary of cache name to cache factor for that individual
    cache. Overrides the global cache factor for a given cache.