summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--changelog.d/17071.doc1
-rw-r--r--docs/usage/configuration/config_documentation.md8
2 files changed, 9 insertions, 0 deletions
diff --git a/changelog.d/17071.doc b/changelog.d/17071.doc
new file mode 100644
index 0000000000..28773414d8
--- /dev/null
+++ b/changelog.d/17071.doc
@@ -0,0 +1 @@
+Update event_cache_size and global_factor configurations documentation.
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 985f90c8a1..bcd53145f1 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -1317,6 +1317,12 @@ Options related to caching.
 The number of events to cache in memory. Defaults to 10K. Like other caches,
 this is affected by `caches.global_factor` (see below).
 
+For example, the default is 10K and the global_factor default is 0.5.
+
+Since 10K * 0.5 is 5K then the event cache size will be 5K.
+
+The cache affected by this configuration is named as "*getEvent*".
+
 Note that this option is not part of the `caches` section.
 
 Example configuration:
@@ -1342,6 +1348,8 @@ number of entries that can be stored.
 
   Defaults to 0.5, which will halve the size of all caches.
 
+  Note that changing this value also affects the HTTP connection pool.
+
 * `per_cache_factors`: A dictionary of cache name to cache factor for that individual
    cache. Overrides the global cache factor for a given cache.