Add more settings for Indices Request Cache (#7160)

* formatting changes recommended by IDE Signed-off-by: Kiran Prakash <[email protected]> * bug fix Signed-off-by: Kiran Prakash <[email protected]> * cleanup related entries Signed-off-by: Kiran Prakash <[email protected]> * formatting changes recommended by IDE Signed-off-by: Kiran Prakash <[email protected]> * cleanup related entries Signed-off-by: Kiran Prakash <[email protected]> * Update tiered-cache.md Signed-off-by: Kiran Prakash <[email protected]> * revert table settings Signed-off-by: Kiran Prakash <[email protected]> * cleanup settings Signed-off-by: Kiran Prakash <[email protected]> * Update _search-plugins/caching/tiered-cache.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Kiran Prakash <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Kiran Prakash <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]>
opensearch-project · May 17, 2024 · fdf6967 · fdf6967
1 parent 30eb857
commit fdf6967
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/_search-plugins/caching/tiered-cache.md b/_search-plugins/caching/tiered-cache.md
@@ -44,7 +44,7 @@ In OpenSearch 2.14, a request cache can be used in a tiered cache. To begin, con
 To use the OpenSearch-provided tiered spillover cache implementation, set the cache store name to `tiered_spillover`, as shown in the following example:
 
 ```yaml
-indices.request.cache.store.name: tiered_spillover: true
+indices.request.cache.store.name: tiered_spillover
 ```
 {% include copy.html %}
 
@@ -90,3 +90,12 @@ Setting | Data type | Default | Description
 :--- | :--- | :--- | :---
 `indices.request.cache.tiered_spillover.disk.store.policies.took_time.threshold` | Time unit | `10ms` | A policy used to determine whether to cache a query into a disk cache based on its took time. This is a dynamic setting. Optional.
 `indices.request.cache.tiered_spillover.disk.store.enabled` | Boolean | `True` | Enables or disables the disk cache dynamically within a tiered spillover cache. Note: After disabling a disk cache, entries are not removed automatically and requires the cache to be manually cleared. Optional.
+
+### Delete stale entries settings
+
+The following table lists the settings related to the deletion of stale entries from the cache.
+
+Setting | Data type | Default | Description
+:--- | :--- |:--------| :---
+`indices.requests.cache.cleanup.staleness_threshold` | String | `0%`    | Defines the percentage of stale keys in the cache post. After identification, all stale cache entries are deleted. Optional.
+`indices.requests.cache.cleanup.interval` | Time unit | `1m`  | Defines the frequency at which the request cache's stale entries are deleted. Optional.