SOLR-12835: Document statistics exposed by the Query Result Cache when maxRamMB is configured

This commit is contained in:
Shalin Shekhar Mangar 2018-10-05 08:20:31 +05:30
parent 14e6eb2c24
commit ace0db7a0a
2 changed files with 13 additions and 1 deletions

View File

@ -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
----------------------

View File

@ -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 <<query-settings-in-solrconfig.adoc#query-settings-in-solrconfig,Query Settings in SolrConfig>>.