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

Passing IndicesService to ingest processor factory with processor params #10307

Conversation

martin-gaievski
Copy link
Member

@martin-gaievski martin-gaievski commented Oct 2, 2023

Description

This change solves the problem of ingest pipeline processors not being able to access index mapping information. By passing reference to IngestService we opening this possibility, processor may use it to read mapping like this :

in the ingest plugin

    Map<String, Processor.Factory> getProcessors(Processor.Parameters parameters) {
        return Map.of(
            MyIngestProcessor.TYPE,
            new MyIngestProcessorFactory(parameters.indicesService)
        );
    }

in the processor factory

    public MyIngestProcessor create(... ) throws Exception {
        return new MyIngestProcessor(parameters.indicesService);
    }

in the processor

    IndicesService indicesService;
    
    void execute(IngestDocument ingestDocument, BiConsumer<IngestDocument, Exception> handler) {
        String index = ingestDocument.getSourceAndMetadata().get(IndexFieldMapper.NAME);
        MappingMetadata mappingMeta = indicesService.clusterService().state().metadata().index(indexName).mapping();
    }

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.

@github-actions
Copy link
Contributor

github-actions bot commented Oct 2, 2023

Compatibility status:

Checks if related components are compatible with change 7b82dd5

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

@github-actions
Copy link
Contributor

github-actions bot commented Oct 2, 2023

Gradle Check (Jenkins) Run Completed with:

@github-actions
Copy link
Contributor

github-actions bot commented Oct 2, 2023

Gradle Check (Jenkins) Run Completed with:

@github-actions
Copy link
Contributor

github-actions bot commented Oct 2, 2023

Gradle Check (Jenkins) Run Completed with:

@msfroh
Copy link
Collaborator

msfroh commented Oct 4, 2023

As a nitpick, the title should probably say "Passing IndicesService..."

@opensearch-trigger-bot opensearch-trigger-bot bot added the stalled Issues that have stalled label Nov 4, 2023
@msfroh
Copy link
Collaborator

msfroh commented Nov 14, 2023

@martin-gaievski -- Are you still planning to move forward with this one? Looks like we have some merge conflicts to resolve.

@martin-gaievski martin-gaievski changed the title Passing IngestService to ingest processor factory with processor params Passing IndicesService to ingest processor factory with processor params Nov 15, 2023
@martin-gaievski
Copy link
Member Author

Yes, I think the change still makes sense, resolving merge conflicts now

Copy link
Contributor

❕ Gradle check result for 40e72bd: UNSTABLE

  • TEST FAILURES:
      2 org.opensearch.smoketest.SmokeTestMultiNodeClientYamlTestSuiteIT.test {yaml=pit/10_basic/Delete all}

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

CHANGELOG.md Outdated Show resolved Hide resolved
Signed-off-by: Martin Gaievski <gaievski@amazon.com>
@martin-gaievski martin-gaievski force-pushed the passing-indicesService-to-processor-factories branch from 40e72bd to e670524 Compare November 15, 2023 02:40
Copy link
Contributor

✅ Gradle check result for e670524: SUCCESS

Copy link

codecov bot commented Nov 15, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (3ff7e97) 71.15% compared to head (7b82dd5) 71.30%.
Report is 4 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main   #10307      +/-   ##
============================================
+ Coverage     71.15%   71.30%   +0.15%     
- Complexity    58783    58853      +70     
============================================
  Files          4885     4885              
  Lines        277199   277200       +1     
  Branches      40285    40285              
============================================
+ Hits         197247   197666     +419     
+ Misses        63448    63005     -443     
- Partials      16504    16529      +25     

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

@opensearch-trigger-bot opensearch-trigger-bot bot removed the stalled Issues that have stalled label Nov 15, 2023
@ryanbogan ryanbogan added the backport 2.x Backport to 2.x branch label Nov 15, 2023
Copy link
Member

@ryanbogan ryanbogan left a comment

Choose a reason for hiding this comment

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

One small suggestion, everything else looks good to me!

CHANGELOG.md Outdated Show resolved Hide resolved
Signed-off-by: Martin Gaievski <gaievski@amazon.com>
Copy link
Contributor

❕ Gradle check result for 7b82dd5: UNSTABLE

  • TEST FAILURES:
      1 org.opensearch.index.ShardIndexingPressureSettingsIT.testShardIndexingPressureLastSuccessfulSettingsUpdate

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

@msfroh msfroh merged commit c0c76e6 into opensearch-project:main Nov 15, 2023
29 checks passed
@opensearch-trigger-bot
Copy link
Contributor

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-10307-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 c0c76e6db6b6a39401700de54f7aa64e2cc6f9f1
# Push it to GitHub
git push --set-upstream origin backport/backport-10307-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-10307-to-2.x.

martin-gaievski added a commit to martin-gaievski/OpenSearch that referenced this pull request Nov 20, 2023
…ams (opensearch-project#10307)

* Passing IngestService to processor factory with processor params

Signed-off-by: Martin Gaievski <gaievski@amazon.com>

* Fixed typo in the changlelog entry for this PR

Signed-off-by: Martin Gaievski <gaievski@amazon.com>

---------

Signed-off-by: Martin Gaievski <gaievski@amazon.com>
(cherry picked from commit c0c76e6)
ryanbogan pushed a commit that referenced this pull request Nov 20, 2023
…ams (#10307) (#11281)

* Passing IngestService to processor factory with processor params

Signed-off-by: Martin Gaievski <gaievski@amazon.com>

* Fixed typo in the changlelog entry for this PR

Signed-off-by: Martin Gaievski <gaievski@amazon.com>

---------

Signed-off-by: Martin Gaievski <gaievski@amazon.com>
(cherry picked from commit c0c76e6)
fahadshamiinsta pushed a commit to fahadshamiinsta/OpenSearch270 that referenced this pull request Dec 4, 2023
…ams (opensearch-project#10307)

* Passing IngestService to processor factory with processor params

Signed-off-by: Martin Gaievski <gaievski@amazon.com>

* Fixed typo in the changlelog entry for this PR

Signed-off-by: Martin Gaievski <gaievski@amazon.com>

---------

Signed-off-by: Martin Gaievski <gaievski@amazon.com>
rayshrey pushed a commit to rayshrey/OpenSearch that referenced this pull request Mar 18, 2024
…ams (opensearch-project#10307)

* Passing IngestService to processor factory with processor params

Signed-off-by: Martin Gaievski <gaievski@amazon.com>

* Fixed typo in the changlelog entry for this PR

Signed-off-by: Martin Gaievski <gaievski@amazon.com>

---------

Signed-off-by: Martin Gaievski <gaievski@amazon.com>
shiv0408 pushed a commit to Gaurav614/OpenSearch that referenced this pull request Apr 25, 2024
…ams (opensearch-project#10307)

* Passing IngestService to processor factory with processor params

Signed-off-by: Martin Gaievski <gaievski@amazon.com>

* Fixed typo in the changlelog entry for this PR

Signed-off-by: Martin Gaievski <gaievski@amazon.com>

---------

Signed-off-by: Martin Gaievski <gaievski@amazon.com>
Signed-off-by: Shivansh Arora <hishiv@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x Backport to 2.x branch backport-failed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants