-
Notifications
You must be signed in to change notification settings - Fork 503
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add cache plugin and tiered cache documentation #6708
Add cache plugin and tiered cache documentation #6708
Conversation
Signed-off-by: Sagar Upadhyaya <[email protected]>
Signed-off-by: Sagar Upadhyaya <[email protected]>
Signed-off-by: Sagar Upadhyaya <[email protected]>
@sgup432 Thanks for writing the docs. I will review shortly and push my edits to the same PR. Do you have a GitHub issue where you'd like to collect users' feedback for this feature? |
@kolchfa-aws |
Signed-off-by: Fanit Kolchina <[email protected]>
Yes! We can point to that page for installation instructions. |
Signed-off-by: Fanit Kolchina <[email protected]>
@sgup432 Please advise on the naming of the section and also provide the name and location of the plugin that the users need to install for ehcache. Thanks! |
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sgup432 @kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!
_search-plugins/caching/index.md
Outdated
|
||
# Caching | ||
|
||
OpenSearch relies heavily on different types of on-heap cache to accelerate data retrieval, providing significant improvement in search latencies. However, cache size is limited by the amount of memory available on a node. If you are processing a larger dataset that can potentially be cached, the cache size limit causes a lot of cache evictions and misses. The increasing number of evictions impacts performance because OpenSearch needs to process the query again, causing high resource consumption. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"on-heap caching"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reworded.
_search-plugins/caching/index.md
Outdated
|
||
In addition to existing OpenSearch custom on-heap cache stores, cache plugins provide the following cache stores: | ||
|
||
- **Disk cache**: This cache stores a precomputed result of a query on disk. You can use disk cache to cache much larger datasets, provided that the disk latencies are acceptable. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"the" precomputed result (if there is only one result for the query)?
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks, @sgup432! Changed the title to "Caching"
Description
Adding a new doc for cache plugins introduced as part of 2.13.
Also adding a doc for tiered cache which is one of the implementation provided via cache plugin.
Note: This is an experimental feature.
Issues Resolved
Closes #6300
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.