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.

Sign up for GitHub

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

Jump to bottom

[Tiered Caching] Make Indices Request Cache Stale Key Mgmt Threshold setting dynamic #12975

Closed
wants to merge 7 commits into from
Closed

[Tiered Caching] Make Indices Request Cache Stale Key Mgmt Threshold setting dynamic #12975

wants to merge 7 commits into from

Conversation

kiranprakash154
Copy link
Contributor

@kiranprakash154 kiranprakash154 commented Mar 28, 2024 •
edited
Loading

Description

This PR includes the following changes -
Making Indices Request Cache Stale Key Mgmt Threshold setting dynamic.

#12625 Introduced Stale Key mgmt to Indices Request Cache.
In this we introduced the threshold setting as a static setting.
As an optimization we also stopped keeping track of stale keys when threshold is 0 when by default on-heap implementation of Tiered Cache was being used.

Now that we want to make this a dynamic setting, I have removed that check. That means, we keep track of staleness regardless of the threshold.

When the user updates the threshold setting, it would update the threshold field the cache cleaner looks at to determine if the cleanup is necessary or not.

The reason for going with this approach is because the cost of maintaining stale keys is minimal and this provides a seamless way for the cache cleaner to work when the thresholds are updated.

The memory implication of the map is the Integers being used, rest 2 items (ShardId and ReaderCacheKeyId) are already created and we just use them by reference.

A rough calculation of the memory implication.

We recommend users max of 1k shards, with a default refresh rate of 1 sec and each second having an entry of 4B, and the cache cleaner by default runs every minute, the calculation will turn out to be
1_000 x 60 x 4B = 240KB.

Related Issues

Resolves #12540

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Failing checks are inspected and point to the corresponding known issue(s) (See: Troubleshooting Failing Builds)
  • Commits are signed per the DCO using --signoff
  • Commit changes are listed out in CHANGELOG.md file (See: Changelog)
  • Public documentation issue/PR created

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

@kiranprakash154 kiranprakash154 changed the title Update IndicesRequestCache.java [Tiramisu] Make Indices Request Cache Stale Key Mgmt Threshold setting dynamic Mar 28, 2024
@kiranprakash154 kiranprakash154 changed the title [Tiramisu] Make Indices Request Cache Stale Key Mgmt Threshold setting dynamic [Tiered Caching] Make Indices Request Cache Stale Key Mgmt Threshold setting dynamic Mar 28, 2024
@github-actions github-actions bot added enhancement Enhancement or improvement to existing feature or request Search:Performance labels Mar 28, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Mar 28, 2024 •
edited
Loading

Compatibility status:

Checks if related components are compatible with change bc00536

Incompatible components

Skipped components

Compatible components

Compatible components: [https://github.com/opensearch-project/custom-codecs.git, https://github.com/opensearch-project/asynchronous-search.git, https://github.com/opensearch-project/performance-analyzer-rca.git, https://github.com/opensearch-project/flow-framework.git, https://github.com/opensearch-project/job-scheduler.git, https://github.com/opensearch-project/cross-cluster-replication.git, https://github.com/opensearch-project/reporting.git, https://github.com/opensearch-project/security.git, https://github.com/opensearch-project/opensearch-oci-object-storage.git, https://github.com/opensearch-project/geospatial.git, https://github.com/opensearch-project/k-nn.git, https://github.com/opensearch-project/common-utils.git, https://github.com/opensearch-project/neural-search.git, https://github.com/opensearch-project/anomaly-detection.git, https://github.com/opensearch-project/performance-analyzer.git, https://github.com/opensearch-project/security-analytics.git, https://github.com/opensearch-project/ml-commons.git, https://github.com/opensearch-project/notifications.git, https://github.com/opensearch-project/index-management.git, https://github.com/opensearch-project/observability.git, https://github.com/opensearch-project/alerting.git, https://github.com/opensearch-project/sql.git]

@github-actions GitHub Actions
Copy link
Contributor

❌ Gradle check result for 09ca73a: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

@github-actions GitHub Actions
Copy link
Contributor

❌ Gradle check result for 56386ca: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

@github-actions GitHub Actions
Copy link
Contributor

❌ Gradle check result for 1e4927b: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

@github-actions GitHub Actions
Copy link
Contributor

❌ Gradle check result for 739e791: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

@github-actions GitHub Actions
Copy link
Contributor

❌ Gradle check result for c6a0036: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

@kiranprakash154
Copy link
Contributor Author

❌ Gradle check result for c6a0036: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

Known Flaky Test - #7755

@kiranprakash154 kiranprakash154 marked this pull request as ready for review March 29, 2024 06:44
@kiranprakash154 kiranprakash154 self-assigned this Mar 29, 2024
@kiranprakash154
Update IndicesRequestCache.java
4b41242 
Signed-off-by: Kiran Prakash <awskiran@amazon.com>
@kiranprakash154
Update ClusterSettings.java
bbf7920 
Signed-off-by: Kiran Prakash <awskiran@amazon.com>
@kiranprakash154
Update IndicesService.java
8316f74 
Signed-off-by: Kiran Prakash <awskiran@amazon.com>
@kiranprakash154
address existing tests
fd8680c 
Signed-off-by: Kiran Prakash <awskiran@amazon.com>
@kiranprakash154
UTs
84a550a 
Signed-off-by: Kiran Prakash <awskiran@amazon.com>
@kiranprakash154
Update CHANGELOG.md
a6b7ec3 
Signed-off-by: Kiran Prakash <awskiran@amazon.com>
@kiranprakash154
ITs
bc00536 
Signed-off-by: Kiran Prakash <awskiran@amazon.com>
@github-actions GitHub Actions
Copy link
Contributor

✅ Gradle check result for bc00536: SUCCESS

@codecov Codecov
Copy link

codecov bot commented Mar 29, 2024

Codecov Report

Attention: Patch coverage is 83.33333% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 71.31%. Comparing base (b15cb0c) to head (bc00536).
Report is 107 commits behind head on main.

Files Patch % Lines
...va/org/opensearch/indices/IndicesRequestCache.java 83.33% 0 Missing and 2 partials ⚠️
Additional details and impacted files 
@@             Coverage Diff              @@
##               main   #12975      +/-   ##
============================================
- Coverage     71.42%   71.31%   -0.11%     
- Complexity    59978    60264     +286     
============================================
  Files          4985     5021      +36     
  Lines        282275   284076    +1801     
  Branches      40946    41151     +205     
============================================
+ Hits         201603   202600     +997     
- Misses        63999    64659     +660     
- Partials      16673    16817     +144

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sgup432
Copy link
Contributor

sgup432 commented Apr 15, 2024

This one seems to be stale. Please see #12941 for the updated change.

@kiranprakash154
Copy link
Contributor Author

This can be closed since #12941 contains the changes planned in this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@abbashus abbashus Awaiting requested review from abbashus

@adnapibar adnapibar Awaiting requested review from adnapibar

@anasalkouz anasalkouz Awaiting requested review from anasalkouz anasalkouz is a code owner

@andrross andrross Awaiting requested review from andrross andrross is a code owner

@Bukhtawar Bukhtawar Awaiting requested review from Bukhtawar Bukhtawar is a code owner

@CEHENKLE CEHENKLE Awaiting requested review from CEHENKLE CEHENKLE is a code owner

@dblock dblock Awaiting requested review from dblock dblock is a code owner

@dbwiddis dbwiddis Awaiting requested review from dbwiddis dbwiddis is a code owner

@dreamer-89 dreamer-89 Awaiting requested review from dreamer-89

@gbbafna gbbafna Awaiting requested review from gbbafna gbbafna is a code owner

@kotwanikunal kotwanikunal Awaiting requested review from kotwanikunal kotwanikunal is a code owner

@mch2 mch2 Awaiting requested review from mch2 mch2 is a code owner

@msfroh msfroh Awaiting requested review from msfroh msfroh is a code owner

@nknize nknize Awaiting requested review from nknize nknize is a code owner

@owaiskazi19 owaiskazi19 Awaiting requested review from owaiskazi19 owaiskazi19 is a code owner

@reta reta Awaiting requested review from reta reta is a code owner

@Rishikesh1159 Rishikesh1159 Awaiting requested review from Rishikesh1159 Rishikesh1159 is a code owner

@ryanbogan ryanbogan Awaiting requested review from ryanbogan

@sachinpkale sachinpkale Awaiting requested review from sachinpkale sachinpkale is a code owner

@saratvemulapalli saratvemulapalli Awaiting requested review from saratvemulapalli saratvemulapalli is a code owner

@shwetathareja shwetathareja Awaiting requested review from shwetathareja shwetathareja is a code owner

@sohami sohami Awaiting requested review from sohami sohami is a code owner

@tlfeng tlfeng Awaiting requested review from tlfeng

@VachaShah VachaShah Awaiting requested review from VachaShah VachaShah is a code owner

Assignees

@kiranprakash154 kiranprakash154

Labels
enhancement Enhancement or improvement to existing feature or request Search:Performance
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Tiered Caching][Milestone 1] Integrating IndicesRequestCache with tiered cache
2 participants
@kiranprakash154 @sgup432