-
Notifications
You must be signed in to change notification settings - Fork 2.6k
[Remote segments] Add backpressure in write path on segments lag between local and remote store #7459
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
Merged
Merged
[Remote segments] Add backpressure in write path on segments lag between local and remote store #7459
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
4bc2186
Add backpressure in write path on remote segments lag
ashking94 66ed34d
Remove refresh seq no lag
ashking94 4d5089d
Merge remote-tracking branch 'upstream/main' into 7424
ashking94 5250f52
Remove seq no lag condition from tests
ashking94 345409c
Address review comments
ashking94 0d87c8c
Address review comments
ashking94 5ae6109
Merge remote-tracking branch 'upstream/main' into 7424
ashking94 dc378e8
Empty-Commit
ashking94 4803283
Increase the default limit for variance factor
ashking94 6dad1a4
Fix failing test & incorporate comments
ashking94 077aa99
Empty-Commit
ashking94 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
145 changes: 145 additions & 0 deletions
145
...rTest/java/org/opensearch/remotestore/AbstractRemoteStoreMockRepositoryIntegTestCase.java
This file contains hidden or 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,145 @@ | ||
| /* | ||
| * 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.remotestore; | ||
|
|
||
| import org.junit.Before; | ||
| import org.opensearch.action.index.IndexResponse; | ||
| import org.opensearch.cluster.metadata.IndexMetadata; | ||
| import org.opensearch.common.UUIDs; | ||
| import org.opensearch.common.settings.Settings; | ||
| import org.opensearch.common.util.FeatureFlags; | ||
| import org.opensearch.core.util.FileSystemUtils; | ||
| import org.opensearch.index.IndexModule; | ||
| import org.opensearch.index.IndexSettings; | ||
| import org.opensearch.index.store.RemoteSegmentStoreDirectory; | ||
| import org.opensearch.indices.replication.common.ReplicationType; | ||
| import org.opensearch.snapshots.AbstractSnapshotIntegTestCase; | ||
| import org.opensearch.test.FeatureFlagSetter; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.file.Path; | ||
| import java.util.Arrays; | ||
| import java.util.Collections; | ||
| import java.util.Set; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import static org.opensearch.test.hamcrest.OpenSearchAssertions.assertAcked; | ||
|
|
||
| public abstract class AbstractRemoteStoreMockRepositoryIntegTestCase extends AbstractSnapshotIntegTestCase { | ||
|
|
||
| protected static final String REPOSITORY_NAME = "my-segment-repo-1"; | ||
| protected static final String INDEX_NAME = "remote-store-test-idx-1"; | ||
|
|
||
| @Override | ||
| protected Settings featureFlagSettings() { | ||
| return Settings.builder().put(super.featureFlagSettings()).put(FeatureFlags.REMOTE_STORE, "true").build(); | ||
| } | ||
|
|
||
| @Before | ||
| public void setup() { | ||
| FeatureFlagSetter.set(FeatureFlags.REMOTE_STORE); | ||
| internalCluster().startClusterManagerOnlyNode(); | ||
| } | ||
|
|
||
| @Override | ||
| public Settings indexSettings() { | ||
| return remoteStoreIndexSettings(0); | ||
| } | ||
|
|
||
| protected Settings remoteStoreIndexSettings(int numberOfReplicas) { | ||
| return Settings.builder() | ||
| .put(super.indexSettings()) | ||
| .put(IndexSettings.INDEX_REFRESH_INTERVAL_SETTING.getKey(), "300s") | ||
| .put(IndexMetadata.SETTING_NUMBER_OF_SHARDS, 1) | ||
| .put(IndexMetadata.SETTING_NUMBER_OF_REPLICAS, numberOfReplicas) | ||
| .put(IndexModule.INDEX_QUERY_CACHE_ENABLED_SETTING.getKey(), false) | ||
| .put(IndexMetadata.SETTING_REPLICATION_TYPE, ReplicationType.SEGMENT) | ||
| .put(IndexMetadata.SETTING_REMOTE_STORE_ENABLED, true) | ||
| .put(IndexMetadata.SETTING_REMOTE_STORE_REPOSITORY, REPOSITORY_NAME) | ||
| .build(); | ||
| } | ||
|
|
||
| protected void deleteRepo() { | ||
| logger.info("--> Deleting the repository={}", REPOSITORY_NAME); | ||
| assertAcked(clusterAdmin().prepareDeleteRepository(REPOSITORY_NAME)); | ||
| } | ||
|
|
||
| protected void setup(Path repoLocation, double ioFailureRate, String skipExceptionBlobList) { | ||
| logger.info("--> Creating repository={} at the path={}", REPOSITORY_NAME, repoLocation); | ||
| // The random_control_io_exception_rate setting ensures that 10-25% of all operations to remote store results in | ||
| /// IOException. skip_exception_on_verification_file & skip_exception_on_list_blobs settings ensures that the | ||
| // repository creation can happen without failure. | ||
| createRepository( | ||
| REPOSITORY_NAME, | ||
| "mock", | ||
| Settings.builder() | ||
| .put("location", repoLocation) | ||
| .put("random_control_io_exception_rate", ioFailureRate) | ||
| .put("skip_exception_on_verification_file", true) | ||
| .put("skip_exception_on_list_blobs", true) | ||
| // Skipping is required for metadata as it is part of recovery | ||
| .put("skip_exception_on_blobs", skipExceptionBlobList) | ||
| .put("max_failure_number", Long.MAX_VALUE) | ||
| ); | ||
|
|
||
| internalCluster().startDataOnlyNodes(1); | ||
| createIndex(INDEX_NAME); | ||
| logger.info("--> Created index={}", INDEX_NAME); | ||
| ensureYellowAndNoInitializingShards(INDEX_NAME); | ||
| logger.info("--> Cluster is yellow with no initializing shards"); | ||
| ensureGreen(INDEX_NAME); | ||
| logger.info("--> Cluster is green"); | ||
| } | ||
|
|
||
| /** | ||
| * Gets all segment files which starts with "_". For instance, _0.cfe, _o.cfs etc. | ||
| * | ||
| * @param location the path to location where segment files are being searched. | ||
| * @return set of file names of all segment file or empty set if there was IOException thrown. | ||
| */ | ||
| protected Set<String> getSegmentFiles(Path location) { | ||
| try { | ||
| return Arrays.stream(FileSystemUtils.files(location)) | ||
| .filter(path -> path.getFileName().toString().startsWith("_")) | ||
| .map(path -> path.getFileName().toString()) | ||
| .map(this::getLocalSegmentFilename) | ||
| .collect(Collectors.toSet()); | ||
| } catch (IOException exception) { | ||
| logger.error("Exception occurred while getting segment files", exception); | ||
| } | ||
| return Collections.emptySet(); | ||
| } | ||
|
|
||
| private String getLocalSegmentFilename(String remoteFilename) { | ||
| return remoteFilename.split(RemoteSegmentStoreDirectory.SEGMENT_NAME_UUID_SEPARATOR)[0]; | ||
| } | ||
|
|
||
| private IndexResponse indexSingleDoc() { | ||
| return client().prepareIndex(INDEX_NAME) | ||
| .setId(UUIDs.randomBase64UUID()) | ||
| .setSource(randomAlphaOfLength(5), randomAlphaOfLength(5)) | ||
| .get(); | ||
| } | ||
|
|
||
| protected void indexData(int numberOfIterations, boolean invokeFlush) { | ||
| logger.info("--> Indexing data for {} iterations with flush={}", numberOfIterations, invokeFlush); | ||
| for (int i = 0; i < numberOfIterations; i++) { | ||
| int numberOfOperations = randomIntBetween(1, 5); | ||
| logger.info("--> Indexing {} operations in iteration #{}", numberOfOperations, i); | ||
| for (int j = 0; j < numberOfOperations; j++) { | ||
| indexSingleDoc(); | ||
| } | ||
| if (invokeFlush) { | ||
| flush(INDEX_NAME); | ||
| } else { | ||
| refresh(INDEX_NAME); | ||
| } | ||
| } | ||
| } | ||
| } |
43 changes: 43 additions & 0 deletions
43
...er/src/internalClusterTest/java/org/opensearch/remotestore/RemoteStoreBackpressureIT.java
This file contains hidden or 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,43 @@ | ||
| /* | ||
| * 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.remotestore; | ||
|
|
||
| import org.opensearch.action.admin.cluster.settings.ClusterUpdateSettingsResponse; | ||
| import org.opensearch.common.settings.Settings; | ||
| import org.opensearch.core.concurrency.OpenSearchRejectedExecutionException; | ||
| import org.opensearch.test.OpenSearchIntegTestCase; | ||
|
|
||
| import java.nio.file.Path; | ||
|
|
||
| import static org.opensearch.index.remote.RemoteRefreshSegmentPressureSettings.REMOTE_REFRESH_SEGMENT_PRESSURE_ENABLED; | ||
|
|
||
| @OpenSearchIntegTestCase.ClusterScope(scope = OpenSearchIntegTestCase.Scope.TEST, numDataNodes = 0) | ||
| public class RemoteStoreBackpressureIT extends AbstractRemoteStoreMockRepositoryIntegTestCase { | ||
|
|
||
| public void testWritesRejected() { | ||
| Path location = randomRepoPath().toAbsolutePath(); | ||
| setup(location, 1d, "metadata"); | ||
|
|
||
| Settings request = Settings.builder().put(REMOTE_REFRESH_SEGMENT_PRESSURE_ENABLED.getKey(), true).build(); | ||
| ClusterUpdateSettingsResponse clusterUpdateResponse = client().admin() | ||
| .cluster() | ||
| .prepareUpdateSettings() | ||
| .setPersistentSettings(request) | ||
| .get(); | ||
| assertEquals(clusterUpdateResponse.getPersistentSettings().get(REMOTE_REFRESH_SEGMENT_PRESSURE_ENABLED.getKey()), "true"); | ||
|
|
||
| logger.info("--> Indexing data"); | ||
| OpenSearchRejectedExecutionException ex = assertThrows( | ||
| OpenSearchRejectedExecutionException.class, | ||
| () -> indexData(randomIntBetween(10, 20), randomBoolean()) | ||
| ); | ||
| assertTrue(ex.getMessage().contains("rejected execution on primary shard")); | ||
| deleteRepo(); | ||
| } | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.