Fixup autotuning sample config #12760
Conversation
| # `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 |
There was a problem hiding this comment.
to me, "flag" is a boolean. None of these things are flags? Not a major problem though.
There was a problem hiding this comment.
s/flag/setting/ would be better, I think
| # 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 |
There was a problem hiding this comment.
what are the defaults for these things? (what happens if they are not set?) (also needs adding to the config manual I think)
| # 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 |
There was a problem hiding this comment.
please could you document, here and in the config manual, what the valid suffixes are, and what they mean? (is M 1000000 or 1048576 ?)
|
I can fix all this in the config manual, as it was on my agenda to rip out the config comments today anyway. |
|
The issues have hopefully been addressed here: #12776 I would say that this should be closed as I am in the process of deleting all comments from the config file as we speak. |
This was added in #12701