Adds cluster setting to allow caching requests with size>0 in request cache#16484

Merged

dbwiddis merged 10 commits into

opensearch-project:mainfrom

peteralfonsi:caching-setting

Nov 1, 2024

Contributor

peteralfonsi commented Oct 25, 2024 •

edited

Loading

Description

Adds a cluster setting, indices.requests.cache.enable_for_all_requests, which controls whether to allow caching requests with size > 0 in the request cache. Defaults to false, matching previous behavior.

Since tiered caching can make the request cache significantly larger, it can make sense to cache these requests. This setting probably shouldn't be turned on if tiered caching isn't in use.

Tested in UT, IT, and manually tested turning the cluster setting on and off while checking whether requests were cached.

Related Issues

Resolves #16485

Check List

Functionality includes testing.
[N/A] API changes companion pull request created, if applicable.
Public documentation issue/PR created, if applicable.

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.


          Add cluster setting to allow size>0 in request cache

29a23c0

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

peteralfonsi requested review from Bukhtawar, CEHENKLE, Rishikesh1159, VachaShah, anasalkouz, andrross, ashking94, dblock, dbwiddis, gbbafna, jainankitk, kotwanikunal, linuxpi, mch2, msfroh, nknize, owaiskazi19, reta, sachinpkale, saratvemulapalli, shwetathareja and sohami as code owners

October 25, 2024 17:50

peteralfonsi added the skip-changelog label

dbwiddis reviewed

View reviewed changes

Member

dbwiddis left a comment

Why is adding a new setting not something that should be documented or added in the change log?

Contributor Author

peteralfonsi commented Oct 25, 2024

Why is adding a new setting not something that should be documented or added in the change log?

My mistake, I thought this was only for larger changes. I'll add it to the changelog.

peteralfonsi removed the skip-changelog label


          Add to changelog

ccfb3e4

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

Member

dbwiddis commented Oct 25, 2024

Why is adding a new setting not something that should be documented or added in the change log?

My mistake, I thought this was only for larger changes. I'll add it to the changelog.

It may also need to be updated in the documentation.

dbwiddis added the backport 2.x label

opensearch-ci-bot mentioned this pull request

[AUTOCUT] Gradle Check Flaky Test Report for ShardIndexingPressureSettingsIT #14331

Open

Peter Alfonsi and others added 3 commits

October 28, 2024 11:51


          make canCacheSizeNonzeroRequests volatile

Signed-off-by: Peter Alfonsi <petealft@amazon.com>


          Merge branch 'main' into caching-setting

2c4a1a8

Signed-off-by: Peter Alfonsi <peter.alfonsi@gmail.com>


          fix changelog merge

f54a0cf

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

Contributor

github-actions Bot commented Oct 28, 2024

✅ Gradle check result for f54a0cf: SUCCESS


          Changed setting name

1d955ef

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

sgup432 reviewed

View reviewed changes

server/src/main/java/org/opensearch/indices/IndicesService.java Outdated

sgup432 reviewed

View reviewed changes

server/src/main/java/org/opensearch/indices/IndicesRequestCache.java Outdated

Contributor

github-actions Bot commented Oct 28, 2024

✅ Gradle check result for 1d955ef: SUCCESS


          more renaming

fe3818a

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

Contributor

github-actions Bot commented Oct 28, 2024

❌ Gradle check result for fe3818a: 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?


          fix spotless check

c37b2bb

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

Contributor

github-actions Bot commented Oct 29, 2024

❌ Gradle check result for c37b2bb:

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 Bot added enhancement Search:Performance labels


          rerun gradle check

99cbb04

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

Contributor

github-actions Bot commented Oct 29, 2024

✅ Gradle check result for 99cbb04: SUCCESS

sgup432 approved these changes

View reviewed changes

peteralfonsi mentioned this pull request

Document setting allowing size > 0 queries into request cache opensearch-project/documentation-website#8634

Merged

1 task

Contributor Author

peteralfonsi commented Oct 30, 2024

@dbwiddis, I've raised the doc PR, are we otherwise good to merge? Please let me know if you have any other comments.

dbwiddis approved these changes

View reviewed changes

dbwiddis merged commit 0363aa7 into opensearch-project:main

opensearch-trigger-bot Bot pushed a commit that referenced this pull request


          Adds cluster setting to allow caching requests with size>0 in request…

a87a209

… cache (#16484)

* Add cluster setting to allow size>0 in request cache

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

* Add to changelog

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

* addressed dbwiddis's comments

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

* make canCacheSizeNonzeroRequests volatile

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

* fix changelog merge

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

* Changed setting name

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

* more renaming

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

* fix spotless check

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

* rerun gradle check

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

---------

Signed-off-by: Peter Alfonsi <petealft@amazon.com>
Signed-off-by: Peter Alfonsi <peter.alfonsi@gmail.com>
Co-authored-by: Peter Alfonsi <petealft@amazon.com>
(cherry picked from commit 0363aa7)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

opensearch-trigger-bot Bot mentioned this pull request

[Backport 2.x] Adds cluster setting to allow caching requests with size>0 in request cache #16540

Merged

dbwiddis pushed a commit that referenced this pull request


          Adds cluster setting to allow caching requests with size>0 in request…

ee9d090

… cache (#16484) (#16540)

* Add cluster setting to allow size>0 in request cache



* Add to changelog



* addressed dbwiddis's comments



* make canCacheSizeNonzeroRequests volatile



* fix changelog merge



* Changed setting name



* more renaming



* fix spotless check



* rerun gradle check



---------




(cherry picked from commit 0363aa7)

Signed-off-by: Peter Alfonsi <petealft@amazon.com>
Signed-off-by: Peter Alfonsi <peter.alfonsi@gmail.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Peter Alfonsi <petealft@amazon.com>

opensearch-ci-bot mentioned this pull request

[AUTOCUT] Gradle Check Flaky Test Report for ResourceAwareTasksTests #14293

Closed

This was referenced Nov 5, 2024

Document change to size > 0 setting for request cache opensearch-project/documentation-website#8684

Merged

Change setting allowing size > 0 queries in request cache to be an int threshold #16570

Merged

akolarkunnu pushed a commit to akolarkunnu/OpenSearch that referenced this pull request


          Adds cluster setting to allow caching requests with size>0 in request…

3de30f7

… cache (opensearch-project#16484)

* Add cluster setting to allow size>0 in request cache

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

* Add to changelog

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

* addressed dbwiddis's comments

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

* make canCacheSizeNonzeroRequests volatile

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

* fix changelog merge

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

* Changed setting name

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

* more renaming

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

* fix spotless check

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

* rerun gradle check

Signed-off-by: Peter Alfonsi <petealft@amazon.com>

---------

Signed-off-by: Peter Alfonsi <petealft@amazon.com>
Signed-off-by: Peter Alfonsi <peter.alfonsi@gmail.com>
Co-authored-by: Peter Alfonsi <petealft@amazon.com>

tkykenmt mentioned this pull request

docs: add request-cache report for v2.19.0 tkykenmt/opensearch-feature-explorer#2123

Merged

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

Reviewers

dbwiddis dbwiddis approved these changes

anasalkouz Awaiting requested review from anasalkouz

andrross Awaiting requested review from andrross

ashking94 Awaiting requested review from ashking94

Bukhtawar Awaiting requested review from Bukhtawar

CEHENKLE Awaiting requested review from CEHENKLE

dblock Awaiting requested review from dblock

gbbafna Awaiting requested review from gbbafna

jainankitk Awaiting requested review from jainankitk

kotwanikunal Awaiting requested review from kotwanikunal

linuxpi Awaiting requested review from linuxpi

mch2 Awaiting requested review from mch2

msfroh Awaiting requested review from msfroh

nknize Awaiting requested review from nknize

owaiskazi19 Awaiting requested review from owaiskazi19

reta Awaiting requested review from reta

Rishikesh1159 Awaiting requested review from Rishikesh1159

sachinpkale Awaiting requested review from sachinpkale

saratvemulapalli Awaiting requested review from saratvemulapalli

shwetathareja Awaiting requested review from shwetathareja

sohami Awaiting requested review from sohami

VachaShah Awaiting requested review from VachaShah

+1 more reviewer

sgup432 sgup432 approved these changes

Labels

backport 2.x enhancement Search:Performance