-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce new setting search.concurrent.max_slice to control the slic…
…e computation for concurrent segment search (#8884) * Introduce new setting search.concurrent.max_slice to control the slice computation for concurrent segment search. It uses lucene default mechanism if the setting value is <=0 otherwise uses custom max target slice mechanism Signed-off-by: Sorabh Hamirwasia <[email protected]> * Address review comments Signed-off-by: Sorabh Hamirwasia <[email protected]> * Address review comments Signed-off-by: Sorabh Hamirwasia <[email protected]> --------- Signed-off-by: Sorabh Hamirwasia <[email protected]>
- Loading branch information
Showing
12 changed files
with
383 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
47 changes: 47 additions & 0 deletions
47
server/src/main/java/org/opensearch/search/SearchBootstrapSettings.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.search; | ||
|
|
||
| import org.opensearch.common.settings.Setting; | ||
| import org.opensearch.common.settings.Settings; | ||
|
|
||
| /** | ||
| * Keeps track of all the search related node level settings which can be accessed via static methods | ||
| * | ||
| * @opensearch.internal | ||
| */ | ||
| public class SearchBootstrapSettings { | ||
| // settings to configure maximum slice created per search request using OS custom slice computation mechanism. Default lucene | ||
| // mechanism will not be used if this setting is set with value > 0 | ||
| public static final String CONCURRENT_SEGMENT_SEARCH_TARGET_MAX_SLICE_COUNT_KEY = "search.concurrent.max_slice"; | ||
| public static final int CONCURRENT_SEGMENT_SEARCH_TARGET_MAX_SLICE_COUNT_DEFAULT_VALUE = 0; | ||
|
|
||
| // value == 0 means lucene slice computation will be used | ||
| // this setting will be updated to dynamic setting as part of https://github.com/opensearch-project/OpenSearch/issues/8870 | ||
| public static final Setting<Integer> CONCURRENT_SEGMENT_SEARCH_TARGET_MAX_SLICE_COUNT_SETTING = Setting.intSetting( | ||
| CONCURRENT_SEGMENT_SEARCH_TARGET_MAX_SLICE_COUNT_KEY, | ||
| CONCURRENT_SEGMENT_SEARCH_TARGET_MAX_SLICE_COUNT_DEFAULT_VALUE, | ||
| CONCURRENT_SEGMENT_SEARCH_TARGET_MAX_SLICE_COUNT_DEFAULT_VALUE, | ||
| Setting.Property.NodeScope | ||
| ); | ||
| private static Settings settings; | ||
|
|
||
| public static void initialize(Settings openSearchSettings) { | ||
| settings = openSearchSettings; | ||
| } | ||
|
|
||
| public static int getTargetMaxSlice() { | ||
| return (settings != null) | ||
| ? settings.getAsInt( | ||
| CONCURRENT_SEGMENT_SEARCH_TARGET_MAX_SLICE_COUNT_KEY, | ||
| CONCURRENT_SEGMENT_SEARCH_TARGET_MAX_SLICE_COUNT_DEFAULT_VALUE | ||
| ) | ||
| : CONCURRENT_SEGMENT_SEARCH_TARGET_MAX_SLICE_COUNT_DEFAULT_VALUE; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
55 changes: 55 additions & 0 deletions
55
server/src/main/java/org/opensearch/search/internal/MaxTargetSliceSupplier.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.search.internal; | ||
|
|
||
| import org.apache.lucene.index.LeafReaderContext; | ||
| import org.apache.lucene.search.IndexSearcher; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.Comparator; | ||
| import java.util.List; | ||
|
|
||
| /** | ||
| * Supplier to compute leaf slices based on passed in leaves and max target slice count to limit the number of computed slices. It sorts | ||
| * all the leaves based on document count and then assign each leaf in round-robin fashion to the target slice count slices. Based on | ||
| * experiment results as shared in <a href=https://github.com/opensearch-project/OpenSearch/issues/7358>issue-7358</a> | ||
| * we can see this mechanism helps to achieve better tail/median latency over default lucene slice computation. | ||
| * | ||
| * @opensearch.internal | ||
| */ | ||
| final class MaxTargetSliceSupplier { | ||
|
|
||
| static IndexSearcher.LeafSlice[] getSlices(List<LeafReaderContext> leaves, int targetMaxSlice) { | ||
| if (targetMaxSlice <= 0) { | ||
| throw new IllegalArgumentException("MaxTargetSliceSupplier called with unexpected slice count of " + targetMaxSlice); | ||
| } | ||
|
|
||
| // slice count should not exceed the segment count | ||
| int targetSliceCount = Math.min(targetMaxSlice, leaves.size()); | ||
|
|
||
| // Make a copy so we can sort: | ||
| List<LeafReaderContext> sortedLeaves = new ArrayList<>(leaves); | ||
|
|
||
| // Sort by maxDoc, descending: | ||
| sortedLeaves.sort(Collections.reverseOrder(Comparator.comparingInt(l -> l.reader().maxDoc()))); | ||
|
|
||
| final List<List<LeafReaderContext>> groupedLeaves = new ArrayList<>(); | ||
| for (int i = 0; i < targetSliceCount; ++i) { | ||
| groupedLeaves.add(new ArrayList<>()); | ||
| } | ||
| // distribute the slices in round-robin fashion | ||
| for (int idx = 0; idx < sortedLeaves.size(); ++idx) { | ||
| int currentGroup = idx % targetSliceCount; | ||
| groupedLeaves.get(currentGroup).add(sortedLeaves.get(idx)); | ||
| } | ||
|
|
||
| return groupedLeaves.stream().map(IndexSearcher.LeafSlice::new).toArray(IndexSearcher.LeafSlice[]::new); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
51 changes: 51 additions & 0 deletions
51
server/src/test/java/org/opensearch/search/internal/IndexReaderUtils.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.search.internal; | ||
|
|
||
| import org.apache.lucene.analysis.standard.StandardAnalyzer; | ||
| import org.apache.lucene.document.Document; | ||
| import org.apache.lucene.document.Field; | ||
| import org.apache.lucene.document.StringField; | ||
| import org.apache.lucene.index.DirectoryReader; | ||
| import org.apache.lucene.index.IndexWriter; | ||
| import org.apache.lucene.index.IndexWriterConfig; | ||
| import org.apache.lucene.index.LeafReaderContext; | ||
| import org.apache.lucene.index.NoMergePolicy; | ||
| import org.apache.lucene.store.Directory; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| import static org.apache.lucene.tests.util.LuceneTestCase.newDirectory; | ||
|
|
||
| public class IndexReaderUtils { | ||
|
|
||
| /** | ||
| * Utility to create leafCount number of {@link LeafReaderContext} | ||
| * @param leafCount count of leaves to create | ||
| * @return created leaves | ||
| */ | ||
| public static List<LeafReaderContext> getLeaves(int leafCount) throws Exception { | ||
| final Directory directory = newDirectory(); | ||
| IndexWriter iw = new IndexWriter(directory, new IndexWriterConfig(new StandardAnalyzer()).setMergePolicy(NoMergePolicy.INSTANCE)); | ||
| for (int i = 0; i < leafCount; ++i) { | ||
| Document document = new Document(); | ||
| final String fieldValue = "value" + i; | ||
| document.add(new StringField("field1", fieldValue, Field.Store.NO)); | ||
| document.add(new StringField("field2", fieldValue, Field.Store.NO)); | ||
| iw.addDocument(document); | ||
| iw.commit(); | ||
| } | ||
| iw.close(); | ||
| DirectoryReader directoryReader = DirectoryReader.open(directory); | ||
| List<LeafReaderContext> leaves = directoryReader.leaves(); | ||
| directoryReader.close(); | ||
| directory.close(); | ||
| return leaves; | ||
| } | ||
| } |
Oops, something went wrong.