Skip to content

Adding capability for remote search#235

Draft
sstults wants to merge 13 commits into
opensearch-project:mainfrom
sstults:feature/remote-search-infrastructure
Draft

Adding capability for remote search#235
sstults wants to merge 13 commits into
opensearch-project:mainfrom
sstults:feature/remote-search-infrastructure

Conversation

@sstults
Copy link
Copy Markdown
Contributor

@sstults sstults commented Aug 29, 2025

Description

The Remote Query capability extends the Search Relevance plugin to execute search requests against external search systems (e.g., Solr or other OpenSearch clusters) while maintaining a consistent evaluation model. It introduces managed Remote Search Configurations with secure credential handling, per-config rate limiting and concurrency controls, and optional caching to reduce load and improve throughput. Queries are sent over HTTP(S) via a RemoteSearchExecutor, and results are normalized into an OpenSearch-compatible shape by the RemoteResponseMapper, enabling uniform processing regardless of the remote engine’s native response format. The system emphasizes robustness and observability with structured failure tracking, circuit breaker patterns, retries, and new metrics for remote execution performance, failures, and cache effectiveness.

This capability integrates with the existing experiment infrastructure. Experiments continue to use the same query sets, judgment workflows, and metrics (NDCG, MAP, MRR, P@K), and downstream evaluation remains unchanged because responses are normalized before scoring. The design supports side-by-side comparisons of local and remote systems within the standard experiment lifecycle, preserving backward compatibility while enabling cross-platform evaluation scenarios such as migration validation, A/B tests across environments, and multi-vendor benchmarking. This integration allows teams to compare configurations and engines under identical conditions, aggregate results using established indices and reports, and operate within familiar SRW orchestration, APIs, and persistence models.

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

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.

sstults and others added 12 commits August 29, 2025 20:30
- Added RemoteSearchConfiguration model with validation
- Added RemoteSearchCache model for caching search results
- Added RemoteSearchFailure model for error tracking
- Added corresponding DAO for remote search configuration
- Added JSON mappings for all three models
- Added comprehensive unit tests for all models
- Updated PluginConstants with remote search related constants

Signed-off-by: Scott Stults <sstults@opensourceconnections.com>
Signed-off-by: Scott Stults <sstults@opensourceconnections.com>
---------

Signed-off-by: Anthony Leong <aj.leong623@gmail.com>
Co-authored-by: Eric Pugh <epugh@opensourceconnections.com>
Co-authored-by: Daniel Wrigley <54574577+wrigleyDan@users.noreply.github.com>
Signed-off-by: Scott Stults <sstults@opensourceconnections.com>
…ct#198)

Signed-off-by: Fen Qin <mfenqin@amazon.com>
Signed-off-by: Scott Stults <sstults@opensourceconnections.com>
Signed-off-by: Martin Gaievski <gaievski@amazon.com>
Signed-off-by: Scott Stults <sstults@opensourceconnections.com>
…ving the --skip-ubi feature (opensearch-project#199)

Signed-off-by: Eric Pugh <epugh@opensourceconnections.com>
Signed-off-by: Scott Stults <sstults@opensourceconnections.com>
…set. (opensearch-project#207)

Signed-off-by: wrigleyDan <dwrigley@opensourceconnections.com>
Signed-off-by: Scott Stults <sstults@opensourceconnections.com>
…in/CI action (opensearch-project#208)

Signed-off-by: Martin Gaievski <gaievski@amazon.com>
Signed-off-by: Scott Stults <sstults@opensourceconnections.com>
* Add release notes for 3.2.0

Signed-off-by: opensearch-ci <opensearch-infra@amazon.com>

* Update release-notes for 3.2.0 (opensearch-project#210)

* Add release notes for 3.2.0

Signed-off-by: opensearch-ci <opensearch-infra@amazon.com>
Signed-off-by: Fen Qin <mfenqin@amazon.com>

* clean up CHANGELOG.md

Signed-off-by: Fen Qin <mfenqin@amazon.com>

---------

Signed-off-by: opensearch-ci <opensearch-infra@amazon.com>
Signed-off-by: Fen Qin <mfenqin@amazon.com>
Co-authored-by: opensearch-ci <opensearch-infra@amazon.com>

---------

Signed-off-by: opensearch-ci <opensearch-infra@amazon.com>
Signed-off-by: Fen Qin <mfenqin@amazon.com>
Co-authored-by: Fen Qin <75345540+fen-qin@users.noreply.github.com>
Signed-off-by: Scott Stults <sstults@opensourceconnections.com>
Signed-off-by: Fen Qin <mfenqin@amazon.com>
Signed-off-by: Scott Stults <sstults@opensourceconnections.com>
…h-project#214)

* remove docker-compose.yml and update DEVELOPER_GUIDE.md

Signed-off-by: wrigleyDan <dwrigley@opensourceconnections.com>

* Apply suggestions from code review

typo fix

Signed-off-by: Eric Pugh <epugh@opensourceconnections.com>

---------

Signed-off-by: wrigleyDan <dwrigley@opensourceconnections.com>
Signed-off-by: Eric Pugh <epugh@opensourceconnections.com>
Co-authored-by: Eric Pugh <epugh@opensourceconnections.com>
Signed-off-by: Scott Stults <sstults@opensourceconnections.com>
Signed-off-by: Scott Stults <sstults@opensourceconnections.com>
@sstults sstults force-pushed the feature/remote-search-infrastructure branch from f7cf0db to d4a2000 Compare August 30, 2025 00:31
Signed-off-by: Scott Stults <sstults@opensourceconnections.com>
@codecov
Copy link
Copy Markdown

codecov Bot commented Sep 7, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 0.00%. Comparing base (4d08752) to head (bdeb196).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@     Coverage Diff     @@
##   main   #235   +/-   ##
===========================
===========================

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants