Skip to content
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

Merged
merged 10 commits into from
Mar 22, 2024

Conversation

sgup432
Copy link
Contributor

@sgup432 sgup432 commented Mar 18, 2024

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

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@sgup432 sgup432 changed the title Tiered caching doc Cache plugin and tiered cache documentation Mar 18, 2024
@hdhalter hdhalter added release-notes PR: Include this PR in the automated release notes v2.13.0 4 - Doc review PR: Doc review in progress labels Mar 18, 2024
@kolchfa-aws kolchfa-aws self-assigned this Mar 18, 2024
@kolchfa-aws
Copy link
Collaborator

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

@sgup432
Copy link
Contributor Author

sgup432 commented Mar 18, 2024

@kolchfa-aws
This is the one for tiered caching. I mentioned this in the doc as well - opensearch-project/OpenSearch#10024

@hdhalter hdhalter changed the title Cache plugin and tiered cache documentation Add cache plugin and tiered cache documentation Mar 18, 2024
Signed-off-by: Fanit Kolchina <[email protected]>
@kolchfa-aws
Copy link
Collaborator

@sgup432 I rewrote a bit. Please review to verify that the technical accuracy has been preserved. Also, question:

  • How can the users install all the necessary plugins? Where are these plugins located? Can we point the users to this page for installation instructions?

@sgup432
Copy link
Contributor Author

sgup432 commented Mar 19, 2024

@kolchfa-aws

How can the users install all the necessary plugins? Where are these plugins located? Can we point the users to this page for installation instructions?

Yes! We can point to that page for installation instructions.
I will update and review the wording.

_search-plugins/cache-plugins/index.md Outdated Show resolved Hide resolved
_search-plugins/cache-plugins/index.md Outdated Show resolved Hide resolved
_search-plugins/cache-plugins/index.md Outdated Show resolved Hide resolved
_search-plugins/cache-plugins/index.md Outdated Show resolved Hide resolved
Signed-off-by: Fanit Kolchina <[email protected]>
@kolchfa-aws
Copy link
Collaborator

@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]>
Copy link
Collaborator

@natebower natebower left a 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!


# 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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"on-heap caching"?

Copy link
Collaborator

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 Show resolved Hide resolved

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.
Copy link
Collaborator

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)?

_search-plugins/caching/tiered-cache.md Outdated Show resolved Hide resolved
_search-plugins/caching/tiered-cache.md Outdated Show resolved Hide resolved
_search-plugins/caching/tiered-cache.md Outdated Show resolved Hide resolved
_search-plugins/caching/tiered-cache.md Outdated Show resolved Hide resolved
_search-plugins/caching/tiered-cache.md Outdated Show resolved Hide resolved
_search-plugins/caching/tiered-cache.md Outdated Show resolved Hide resolved
_search-plugins/caching/tiered-cache.md Outdated Show resolved Hide resolved
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
kolchfa-aws and others added 2 commits March 22, 2024 10:11
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a 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"

@kolchfa-aws kolchfa-aws merged commit e4daf84 into opensearch-project:main Mar 22, 2024
3 checks passed
@hdhalter hdhalter added 3 - Done Issue is done/complete and removed 4 - Doc review PR: Doc review in progress labels Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Done Issue is done/complete release-notes PR: Include this PR in the automated release notes v2.13.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Tiered caching in OpenSearch
4 participants