Make search pipelines asynchronous #10598

msfroh · 2023-10-12T22:17:30Z

Description

If a search processor needs to make a call out to another service, we should not risk blocking on the transport thread. We should support async execution.

Related Issues

Resolves #10248

Check List

New functionality includes testing.
- All tests pass
New functionality has been documented.
- New functionality has javadoc added
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.

github-actions · 2023-10-12T22:20:40Z

Gradle Check (Jenkins) Run Completed with:

RESULT: ❌
URL:
CommitID: f44e521
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 · 2023-10-12T22:22:48Z

Gradle Check (Jenkins) Run Completed with:

RESULT: ❌
URL:
CommitID: 1e63756
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 · 2023-10-12T22:47:02Z

Compatibility status:

Checks if related components are compatible with change 70567bd

Incompatible components

Incompatible components: [https://github.com/opensearch-project/performance-analyzer.git]

Skipped components

Compatible components

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

github-actions · 2023-10-12T23:44:05Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/27780/
CommitID: 07aa11e
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 · 2023-10-12T23:44:24Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/27778/
CommitID: f5f70aa
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 · 2023-10-13T00:20:23Z

Gradle Check (Jenkins) Run Completed with:

RESULT: null ❌
URL: https://build.ci.opensearch.org/job/gradle-check/27781/
CommitID: 526493e
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 · 2023-10-13T03:34:45Z

Gradle Check (Jenkins) Run Completed with:

RESULT: SUCCESS ✅
URL: https://build.ci.opensearch.org/job/gradle-check/27795/
CommitID: 526493e

codecov · 2023-10-13T03:36:30Z

Codecov Report

Merging #10598 (70567bd) into main (be65f54) will increase coverage by 0.03%.
Report is 4 commits behind head on main.
The diff coverage is 93.33%.

@@             Coverage Diff              @@
##               main   #10598      +/-   ##
============================================
+ Coverage     71.21%   71.25%   +0.03%     
- Complexity    58689    58767      +78     
============================================
  Files          4870     4872       +2     
  Lines        276539   276594      +55     
  Branches      40190    40189       -1     
============================================
+ Hits         196945   197092     +147     
+ Misses        63192    63096      -96     
- Partials      16402    16406       +4

Files	Coverage Δ
...g/opensearch/search/pipeline/PipelinedRequest.java	`100.00% <100.00%> (ø)`
...nsearch/search/pipeline/SearchPipelineService.java	`85.51% <100.00%> (-0.07%)`	⬇️
...search/search/pipeline/SearchRequestProcessor.java	`100.00% <100.00%> (ø)`
...earch/search/pipeline/SearchResponseProcessor.java	`100.00% <100.00%> (ø)`
.../java/org/opensearch/search/pipeline/Pipeline.java	`85.81% <96.62%> (+2.98%)`	⬆️
...pensearch/action/search/TransportSearchAction.java	`67.69% <70.58%> (+1.08%)`	⬆️

... and 460 files with indirect coverage changes

harshavamsi · 2023-10-26T17:17:07Z

@reta can you take a look and approve if this looks good?

server/src/main/java/org/opensearch/search/pipeline/SearchResponseProcessor.java

reta · 2023-10-26T19:10:36Z

@reta can you take a look and approve if this looks good?

@harshavamsi there comments we agreed to address but they aren't

github-actions · 2023-10-26T23:58:54Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/29114/
CommitID: 5bc661b
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 · 2023-10-27T04:12:36Z

Gradle Check (Jenkins) Run Completed with:

RESULT: SUCCESS ✅
URL: https://build.ci.opensearch.org/job/gradle-check/29118/
CommitID: 5bc661b

server/src/main/java/org/opensearch/search/pipeline/SearchRequestProcessor.java

msfroh · 2023-10-27T17:22:58Z

@reta can you take a look and approve if this looks good?

@harshavamsi there comments we agreed to address but they aren't

Oh -- yeah, sorry. I got sidetracked with some other stuff. I didn't consider this one ready to merge yet. I'll let y'all know once I've addressed the outstanding issues.

If a search processor needs to make a call out to another service, we should not risk blocking on the transport thread. We should support async execution. Signed-off-by: Michael Froh <[email protected]>

Also, IntelliJ suggested refactoring creation of the terminal request callback into a separate method since the existing method was really big. I liked that suggestion. Signed-off-by: Michael Froh <[email protected]>

Signed-off-by: Michael Froh <[email protected]>

github-actions · 2023-10-27T20:10:11Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/29175/
CommitID: 70567bd
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 · 2023-10-28T00:29:52Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/29178/
CommitID: 70567bd
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 · 2023-10-29T03:29:19Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/29189/
CommitID: 70567bd
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 · 2023-10-29T04:21:05Z

Gradle Check (Jenkins) Run Completed with:

RESULT: SUCCESS ✅
URL: https://build.ci.opensearch.org/job/gradle-check/29190/
CommitID: 70567bd

opensearch-trigger-bot · 2023-10-30T17:10:09Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch/backport-2.x
# Create a new branch
git switch --create backport/backport-10598-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 da011ba7ec35770bf4aabf1d26f8e257946fc28f
# Push it to GitHub
git push --set-upstream origin backport/backport-10598-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-10598-to-2.x.

* Make search pipelines asynchronous If a search processor needs to make a call out to another service, we should not risk blocking on the transport thread. We should support async execution. Signed-off-by: Michael Froh <[email protected]> * Compute pipelineStart before building request callback chain Also, IntelliJ suggested refactoring creation of the terminal request callback into a separate method since the existing method was really big. I liked that suggestion. Signed-off-by: Michael Froh <[email protected]> * Rename async methods (put async at end) Signed-off-by: Michael Froh <[email protected]> --------- Signed-off-by: Michael Froh <[email protected]> (cherry picked from commit da011ba)

* Make search pipelines asynchronous If a search processor needs to make a call out to another service, we should not risk blocking on the transport thread. We should support async execution. Signed-off-by: Michael Froh <[email protected]> * Compute pipelineStart before building request callback chain Also, IntelliJ suggested refactoring creation of the terminal request callback into a separate method since the existing method was really big. I liked that suggestion. Signed-off-by: Michael Froh <[email protected]> * Rename async methods (put async at end) Signed-off-by: Michael Froh <[email protected]> --------- Signed-off-by: Michael Froh <[email protected]> Signed-off-by: Shivansh Arora <[email protected]>

github-actions bot added bug Something isn't working Search Search query, autocomplete ...etc labels Oct 12, 2023

msfroh force-pushed the async_search_pipelines branch 2 times, most recently from 07aa11e to 526493e Compare October 12, 2023 23:38

msfroh marked this pull request as ready for review October 13, 2023 17:09

msfroh requested review from reta, anasalkouz, andrross, Bukhtawar, CEHENKLE, dblock, gbbafna, setiah, kartg, kotwanikunal, mch2, nknize, owaiskazi19, peternied, Rishikesh1159, ryanbogan and saratvemulapalli as code owners October 13, 2023 17:09

austintlee approved these changes Oct 17, 2023

View reviewed changes

noCharger added the Search:Relevance label Oct 23, 2023

reta reviewed Oct 26, 2023

View reviewed changes

server/src/main/java/org/opensearch/search/pipeline/SearchResponseProcessor.java Outdated Show resolved Hide resolved

msfroh force-pushed the async_search_pipelines branch from 526493e to 5bc661b Compare October 26, 2023 23:15

msfroh requested a review from abbashus as a code owner October 26, 2023 23:15

reta reviewed Oct 27, 2023

View reviewed changes

server/src/main/java/org/opensearch/search/pipeline/SearchRequestProcessor.java Outdated Show resolved Hide resolved

noCharger assigned msfroh Oct 27, 2023

msfroh added 3 commits October 27, 2023 19:27

Make search pipelines asynchronous

7f5889a

If a search processor needs to make a call out to another service, we should not risk blocking on the transport thread. We should support async execution. Signed-off-by: Michael Froh <[email protected]>

Compute pipelineStart before building request callback chain

6f823bd

Also, IntelliJ suggested refactoring creation of the terminal request callback into a separate method since the existing method was really big. I liked that suggestion. Signed-off-by: Michael Froh <[email protected]>

Rename async methods (put async at end)

70567bd

Signed-off-by: Michael Froh <[email protected]>

msfroh force-pushed the async_search_pipelines branch from 5bc661b to 70567bd Compare October 27, 2023 19:27

reta approved these changes Oct 27, 2023

View reviewed changes

msfroh added the backport 2.x Backport to 2.x branch label Oct 30, 2023

msfroh merged commit da011ba into opensearch-project:main Oct 30, 2023
20 checks passed

opensearch-trigger-bot bot added the backport-failed label Oct 30, 2023

msfroh mentioned this pull request Oct 30, 2023

[Backport 2.x] Make search pipelines asynchronous #11010

Merged

8 tasks

BrewTestBot mentioned this pull request Feb 21, 2024

opensearch 2.12.0 Homebrew/homebrew-core#163463

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make search pipelines asynchronous #10598

Make search pipelines asynchronous #10598

msfroh commented Oct 12, 2023 •

edited

Loading

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023 •

edited

Loading

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 13, 2023

github-actions bot commented Oct 13, 2023

codecov bot commented Oct 13, 2023 •

edited

Loading

harshavamsi commented Oct 26, 2023

reta commented Oct 26, 2023

github-actions bot commented Oct 26, 2023

github-actions bot commented Oct 27, 2023

msfroh commented Oct 27, 2023

github-actions bot commented Oct 27, 2023

github-actions bot commented Oct 28, 2023

github-actions bot commented Oct 29, 2023

github-actions bot commented Oct 29, 2023

opensearch-trigger-bot bot commented Oct 30, 2023

Make search pipelines asynchronous #10598

Make search pipelines asynchronous #10598

Conversation

msfroh commented Oct 12, 2023 • edited Loading

Description

Related Issues

Check List

github-actions bot commented Oct 12, 2023

Gradle Check (Jenkins) Run Completed with:

github-actions bot commented Oct 12, 2023

Gradle Check (Jenkins) Run Completed with:

github-actions bot commented Oct 12, 2023 • edited Loading

Compatibility status:

Incompatible components

Skipped components

Compatible components

github-actions bot commented Oct 12, 2023

Gradle Check (Jenkins) Run Completed with:

github-actions bot commented Oct 12, 2023

Gradle Check (Jenkins) Run Completed with:

github-actions bot commented Oct 13, 2023

Gradle Check (Jenkins) Run Completed with:

github-actions bot commented Oct 13, 2023

Gradle Check (Jenkins) Run Completed with:

codecov bot commented Oct 13, 2023 • edited Loading

Codecov Report

harshavamsi commented Oct 26, 2023

reta commented Oct 26, 2023

github-actions bot commented Oct 26, 2023

Gradle Check (Jenkins) Run Completed with:

github-actions bot commented Oct 27, 2023

Gradle Check (Jenkins) Run Completed with:

msfroh commented Oct 27, 2023

github-actions bot commented Oct 27, 2023

Gradle Check (Jenkins) Run Completed with:

github-actions bot commented Oct 28, 2023

Gradle Check (Jenkins) Run Completed with:

github-actions bot commented Oct 29, 2023

Gradle Check (Jenkins) Run Completed with:

github-actions bot commented Oct 29, 2023

Gradle Check (Jenkins) Run Completed with:

opensearch-trigger-bot bot commented Oct 30, 2023

msfroh commented Oct 12, 2023 •

edited

Loading

github-actions bot commented Oct 12, 2023 •

edited

Loading

codecov bot commented Oct 13, 2023 •

edited

Loading