From 1cd82cf06823fb7680fb4404b8bfab794cf6c3c3 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Wed, 14 Feb 2024 12:25:34 +0200 Subject: [PATCH] Fix unit inaccuracy in documentation for cache-autotuning-related variables Related to: https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3017 --- CHANGELOG.md | 4 ++-- docs/maintenance-synapse.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 153be11fa..dee6890f8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,8 +9,8 @@ The playbook has always used a very conservative cache factor (`matrix_synapse_c The playbook now uses **a 20x larger cache factor** (currently `10`), adjusts a few other cache-related variables, and **enables cache auto-tuning** via the following variables: -- `matrix_synapse_cache_autotuning_max_cache_memory_usage` - defaults to 1/8 of total RAM with a cap of 2GB; values are specified in bytes -- `matrix_synapse_cache_autotuning_target_cache_memory_usage` - defaults to 1/16 of total RAM with a cap of 1GB; values are specified in bytes +- `matrix_synapse_cache_autotuning_max_cache_memory_usage` - defaults to 1/8 of total RAM with a cap of 2GB; values are specified in KB +- `matrix_synapse_cache_autotuning_target_cache_memory_usage` - defaults to 1/16 of total RAM with a cap of 1GB; values are specified in KB - `matrix_synapse_cache_autotuning_min_cache_ttl` - defaults to `30s` These values should be good defaults for most servers, but may change over time as we experiment further. diff --git a/docs/maintenance-synapse.md b/docs/maintenance-synapse.md index 93c150022..d620e2758 100644 --- a/docs/maintenance-synapse.md +++ b/docs/maintenance-synapse.md @@ -86,8 +86,8 @@ Tuning the cache factor is useful only to a limited degree (as its crude to do i Cache autotuning is **enabled by default** and controlled via the following variables: -- `matrix_synapse_cache_autotuning_max_cache_memory_usage` - defaults to 1/8 of total RAM with a cap of 2GB; values are specified in bytes -- `matrix_synapse_cache_autotuning_target_cache_memory_usage` - defaults to 1/16 of total RAM with a cap of 1GB; values are specified in bytes +- `matrix_synapse_cache_autotuning_max_cache_memory_usage` - defaults to 1/8 of total RAM with a cap of 2GB; values are specified in KB +- `matrix_synapse_cache_autotuning_target_cache_memory_usage` - defaults to 1/16 of total RAM with a cap of 1GB; values are specified in KB - `matrix_synapse_cache_autotuning_min_cache_ttl` - defaults to `30s` You can **learn more about cache-autotuning and the global cache factor settings** in the [Synapse's documentation on caches and associated values](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#caches-and-associated-values).