You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 26, 2024. It is now read-only.
Copy file name to clipboardexpand all lines: docs/usage/configuration/config_documentation.md
+9-4
Original file line number
Diff line number
Diff line change
@@ -1130,14 +1130,19 @@ Caching can be configured through the following sub-options:
1130
1130
* `cache_autotuning` and its sub-options `max_cache_memory_usage`, `target_cache_memory_usage`, and
1131
1131
`min_cache_ttl`work in conjunction with each other to maintain a balance between cache memory
1132
1132
usage and cache entry availability. You must be using [jemalloc](https://github.com/matrix-org/synapse#help-synapse-is-slow-and-eats-all-my-ramcpu)
1133
-
to utilize this option, and all three of the options must be specified for this feature to work.
1133
+
to utilize this option, and all three of the options must be specified for this feature to work. This option
1134
+
defaults to off, enable it by providing values for the sub-options listed below. Please note that the feature will not work
1135
+
and may cause unstable behavior (such as excessive emptying of caches or exceptions) if all of the values are not provided.
1136
+
Please see the [Config Conventions](#config-conventions) for information on how to specify memory size and cache expiry
1137
+
durations.
1134
1138
* `max_cache_memory_usage` sets a ceiling on how much memory the cache can use before caches begin to be continuously evicted.
1135
1139
They will continue to be evicted until the memory usage drops below the `target_memory_usage`, set in
1136
-
the flag below, or until the `min_cache_ttl` is hit.
1137
-
* `target_memory_usage` sets a rough target for the desired memory usage of the caches.
1140
+
the setting below, or until the `min_cache_ttl` is hit. There is no default value for this option.
1141
+
* `target_memory_usage` sets a rough target for the desired memory usage of the caches. There is no default value
1142
+
for this option.
1138
1143
* `min_cache_ttl` sets a limit under which newer cache entries are not evicted and is only applied when
1139
1144
caches are actively being evicted/`max_cache_memory_usage` has been exceeded. This is to protect hot caches
1140
-
from being emptied while Synapse is evicting due to memory.
1145
+
from being emptied while Synapse is evicting due to memory. There is no default value for this option.
0 commit comments