mirror of
https://github.com/element-hq/synapse
synced 2024-08-19 04:30:53 +00:00
deploy: eb4aaa1b4b
This commit is contained in:
parent
6dc76bc008
commit
f7a4802bea
4 changed files with 20 additions and 10 deletions
|
@ -3994,15 +3994,20 @@ at all.</p>
|
||||||
<p><code>cache_autotuning</code> and its sub-options <code>max_cache_memory_usage</code>, <code>target_cache_memory_usage</code>, and
|
<p><code>cache_autotuning</code> and its sub-options <code>max_cache_memory_usage</code>, <code>target_cache_memory_usage</code>, and
|
||||||
<code>min_cache_ttl</code> work in conjunction with each other to maintain a balance between cache memory
|
<code>min_cache_ttl</code> work in conjunction with each other to maintain a balance between cache memory
|
||||||
usage and cache entry availability. You must be using <a href="https://github.com/matrix-org/synapse#help-synapse-is-slow-and-eats-all-my-ramcpu">jemalloc</a>
|
usage and cache entry availability. You must be using <a href="https://github.com/matrix-org/synapse#help-synapse-is-slow-and-eats-all-my-ramcpu">jemalloc</a>
|
||||||
to utilize this option, and all three of the options must be specified for this feature to work.</p>
|
to utilize this option, and all three of the options must be specified for this feature to work. This option
|
||||||
|
defaults to off, enable it by providing values for the sub-options listed below. Please note that the feature will not work
|
||||||
|
and may cause unstable behavior (such as excessive emptying of caches or exceptions) if all of the values are not provided.
|
||||||
|
Please see the <a href="usage/configuration/config_documentation.html#config-conventions">Config Conventions</a> for information on how to specify memory size and cache expiry
|
||||||
|
durations.</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li><code>max_cache_memory_usage</code> sets a ceiling on how much memory the cache can use before caches begin to be continuously evicted.
|
<li><code>max_cache_memory_usage</code> sets a ceiling on how much memory the cache can use before caches begin to be continuously evicted.
|
||||||
They will continue to be evicted until the memory usage drops below the <code>target_memory_usage</code>, set in
|
They will continue to be evicted until the memory usage drops below the <code>target_memory_usage</code>, set in
|
||||||
the flag below, or until the <code>min_cache_ttl</code> is hit.</li>
|
the setting below, or until the <code>min_cache_ttl</code> is hit. There is no default value for this option.</li>
|
||||||
<li><code>target_memory_usage</code> sets a rough target for the desired memory usage of the caches.</li>
|
<li><code>target_memory_usage</code> sets a rough target for the desired memory usage of the caches. There is no default value
|
||||||
|
for this option.</li>
|
||||||
<li><code>min_cache_ttl</code> sets a limit under which newer cache entries are not evicted and is only applied when
|
<li><code>min_cache_ttl</code> sets a limit under which newer cache entries are not evicted and is only applied when
|
||||||
caches are actively being evicted/<code>max_cache_memory_usage</code> has been exceeded. This is to protect hot caches
|
caches are actively being evicted/<code>max_cache_memory_usage</code> has been exceeded. This is to protect hot caches
|
||||||
from being emptied while Synapse is evicting due to memory.</li>
|
from being emptied while Synapse is evicting due to memory. There is no default value for this option. </li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
@ -1060,15 +1060,20 @@ at all.</p>
|
||||||
<p><code>cache_autotuning</code> and its sub-options <code>max_cache_memory_usage</code>, <code>target_cache_memory_usage</code>, and
|
<p><code>cache_autotuning</code> and its sub-options <code>max_cache_memory_usage</code>, <code>target_cache_memory_usage</code>, and
|
||||||
<code>min_cache_ttl</code> work in conjunction with each other to maintain a balance between cache memory
|
<code>min_cache_ttl</code> work in conjunction with each other to maintain a balance between cache memory
|
||||||
usage and cache entry availability. You must be using <a href="https://github.com/matrix-org/synapse#help-synapse-is-slow-and-eats-all-my-ramcpu">jemalloc</a>
|
usage and cache entry availability. You must be using <a href="https://github.com/matrix-org/synapse#help-synapse-is-slow-and-eats-all-my-ramcpu">jemalloc</a>
|
||||||
to utilize this option, and all three of the options must be specified for this feature to work.</p>
|
to utilize this option, and all three of the options must be specified for this feature to work. This option
|
||||||
|
defaults to off, enable it by providing values for the sub-options listed below. Please note that the feature will not work
|
||||||
|
and may cause unstable behavior (such as excessive emptying of caches or exceptions) if all of the values are not provided.
|
||||||
|
Please see the <a href="#config-conventions">Config Conventions</a> for information on how to specify memory size and cache expiry
|
||||||
|
durations.</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li><code>max_cache_memory_usage</code> sets a ceiling on how much memory the cache can use before caches begin to be continuously evicted.
|
<li><code>max_cache_memory_usage</code> sets a ceiling on how much memory the cache can use before caches begin to be continuously evicted.
|
||||||
They will continue to be evicted until the memory usage drops below the <code>target_memory_usage</code>, set in
|
They will continue to be evicted until the memory usage drops below the <code>target_memory_usage</code>, set in
|
||||||
the flag below, or until the <code>min_cache_ttl</code> is hit.</li>
|
the setting below, or until the <code>min_cache_ttl</code> is hit. There is no default value for this option.</li>
|
||||||
<li><code>target_memory_usage</code> sets a rough target for the desired memory usage of the caches.</li>
|
<li><code>target_memory_usage</code> sets a rough target for the desired memory usage of the caches. There is no default value
|
||||||
|
for this option.</li>
|
||||||
<li><code>min_cache_ttl</code> sets a limit under which newer cache entries are not evicted and is only applied when
|
<li><code>min_cache_ttl</code> sets a limit under which newer cache entries are not evicted and is only applied when
|
||||||
caches are actively being evicted/<code>max_cache_memory_usage</code> has been exceeded. This is to protect hot caches
|
caches are actively being evicted/<code>max_cache_memory_usage</code> has been exceeded. This is to protect hot caches
|
||||||
from being emptied while Synapse is evicting due to memory.</li>
|
from being emptied while Synapse is evicting due to memory. There is no default value for this option. </li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
Loading…
Reference in a new issue