diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt index ae20fc30377..93faa36a57e 100644 --- a/solr/CHANGES.txt +++ b/solr/CHANGES.txt @@ -143,6 +143,8 @@ Other Changes changed from {collectionDefaults: {nrtReplicas : 2}} to {defaults : {collection : {nrtReplicas : 2}}}. (ab, shalin) +* SOLR-12835: Document statistics exposed by the Query Result Cache when maxRamMB is configured. (shalin) + Bug Fixes ---------------------- diff --git a/solr/solr-ref-guide/src/performance-statistics-reference.adoc b/solr/solr-ref-guide/src/performance-statistics-reference.adoc index cf948c7c1ad..8b5cbd0e638 100644 --- a/solr/solr-ref-guide/src/performance-statistics-reference.adoc +++ b/solr/solr-ref-guide/src/performance-statistics-reference.adoc @@ -192,8 +192,18 @@ The following statistics are available for each of the caches mentioned above: |hits |Number of hits for the current index searcher. |inserts |Number of inserts into the cache. |lookups |Number of lookups against the cache. -|size |Size of the cache at that particular instance (in KBs). +|size |Number of entries in the cache at that particular instance. |warmupTime |Warm-up time for the registered index searcher. This time is taken in account for the “auto-warming” of caches. |=== +When eviction by heap usage is enabled, the following additional statistics are available for the Query Result Cache: + +[cols="25,75",options="header"] +|=== +|Attribute |Description +|maxRamMB |Maximum heap that should be used by the cache beyond which keys will be evicted. +|ramBytesUsed| Actual heap usage of the cache at that particular instance. +|evictionsRamUsage| Number of cache evictions for the current index searcher because heap usage exceeded maxRamMB. +|=== + More information on Solr caches is available in the section <>.