summary refs log tree commit diff
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2022-05-17 12:00:27 +0100
committerErik Johnston <erik@matrix.org>2022-05-17 12:00:27 +0100
commit3fc49255ba9e909aa74ce507868617bb1643f8b7 (patch)
tree0ec34ccde0ba9909f5abe2258073b548ba58bb86
parentAdd a new room version for MSC3787's knock+restricted join rule (#12623) (diff)
downloadsynapse-3fc49255ba9e909aa74ce507868617bb1643f8b7.tar.xz
Fixup autotuning sample config
-rw-r--r--synapse/config/cache.py33
1 files changed, 22 insertions, 11 deletions
diff --git a/synapse/config/cache.py b/synapse/config/cache.py
index d2f55534d7..07f171e572 100644
--- a/synapse/config/cache.py
+++ b/synapse/config/cache.py
@@ -176,22 +176,33 @@ class CacheConfig(Config):
           #
           #cache_entry_ttl: 30m
 
-          # This flag enables cache autotuning, and is further specified by the sub-options `max_cache_memory_usage`,
-          # `target_cache_memory_usage`, `min_cache_ttl`. These flags work in conjunction with each other to maintain
-          # a balance between cache memory usage and cache entry availability. You must be using jemalloc to utilize
-          # this option, and all three of the options must be specified for this feature to work.
+          # This flag enables cache autotuning, and is further specified by the
+          # sub-options `max_cache_memory_usage`, `target_cache_memory_usage`,
+          # `min_cache_ttl`. These flags work in conjunction with each other to
+          # maintain a balance between cache memory usage and cache entry
+          # availability. You must be using jemalloc to utilize this option, and
+          # all three of the options must be specified for this feature to work.
+          #
           #cache_autotuning:
-            # This flag sets a ceiling on 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 `target_memory_usage`, set in
-            # the flag below, or until the `min_cache_ttl` is hit.
+            # This flag sets a ceiling on 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
+            # `target_memory_usage`, set in the flag below, or until the
+            # `min_cache_ttl` is hit.
+            #
             #max_cache_memory_usage: 1024M
 
-            # This flag sets a rough target for the desired memory usage of the caches.
+            # This flag sets a rough target for the desired memory usage of the
+            # caches.
+            #
             #target_cache_memory_usage: 758M
 
-            # 'min_cache_ttl` sets a limit under which newer cache entries are not evicted and is only applied when
-            # caches are actively being evicted/`max_cache_memory_usage` has been exceeded. This is to protect hot caches
-            # from being emptied while Synapse is evicting due to memory.
+            # 'min_cache_ttl` sets a limit under which newer cache entries are not
+            # evicted and is only applied when caches are actively being
+            # evicted/`max_cache_memory_usage` has been exceeded. This is to
+            # protect hot caches from being emptied while Synapse is evicting due
+            # to memory.
+            #
             #min_cache_ttl: 5m
 
           # Controls how long the results of a /sync request are cached for after