(solr) branch main updated: Update caches-warming.adoc (#1238)

[ep...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

epugh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/solr.git


The following commit(s) were added to refs/heads/main by this push:
     new 0679644c382 Update caches-warming.adoc (#1238)
0679644c382 is described below

commit 0679644c382fb4dd1eaa55a2c662af037cf6645e
Author: Ere Maijala <er...@helsinki.fi>
AuthorDate: Fri Feb 16 03:04:58 2024 +0200

    Update caches-warming.adoc (#1238)
    
    Add a note about documentCache not supporting maxRamMB setting properly.
    
    Since Lucene's RamUsageEstimator doesn't understand the Document objects, it will default to 256 bytes. Depending on the real document size this can be wildly inaccurate and cause the cache to use several magnitudes more memory than expected.
---
 .../modules/configuration-guide/pages/caches-warming.adoc              | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/solr/solr-ref-guide/modules/configuration-guide/pages/caches-warming.adoc b/solr/solr-ref-guide/modules/configuration-guide/pages/caches-warming.adoc
index 4a8e584f125..9cab1954eab 100644
--- a/solr/solr-ref-guide/modules/configuration-guide/pages/caches-warming.adoc
+++ b/solr/solr-ref-guide/modules/configuration-guide/pages/caches-warming.adoc
@@ -170,6 +170,9 @@ The more fields you store in your documents, the higher the memory usage of this
                autowarmCount="0"/>
 ----
 
+[NOTE]
+Do not use the `maxRamMB` setting for the `documentCache`. The amount of memory required for the cached documents will not be calculated properly, which can lead to the cache using much more memory than anticipated.
+
 === User Defined Caches
 
 You can also define named caches for your own application code to use.