Update Pipeline Config API #5767
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
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,7 @@ | ||
| package org.opensearch.dataprepper.core.exception; | ||
|
|
||
| public class DynamicPipelineConfigUpdateException extends RuntimeException { | ||
| public DynamicPipelineConfigUpdateException(String message) { | ||
| super(message); | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.dataprepper.core.pipeline.server; | ||
|
|
||
| import org.opensearch.dataprepper.core.exception.DynamicPipelineConfigUpdateException; | ||
| import org.opensearch.dataprepper.model.annotations.DataPrepperPlugin; | ||
| import org.opensearch.dataprepper.model.annotations.SingleThread; | ||
| import org.opensearch.dataprepper.model.configuration.PipelineModel; | ||
| import org.opensearch.dataprepper.model.configuration.PipelinesDataFlowModel; | ||
| import org.opensearch.dataprepper.model.configuration.PluginModel; | ||
| import org.opensearch.dataprepper.model.configuration.SinkModel; | ||
| import org.opensearch.dataprepper.model.peerforwarder.RequiresPeerForwarding; | ||
| import org.reflections.Reflections; | ||
| import org.reflections.scanners.TypeAnnotationsScanner; | ||
|
|
||
| import java.util.HashSet; | ||
| import java.util.List; | ||
| import java.util.Set; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| public class DynamicPipelineUpdateUtil { | ||
|
Member
There was a problem hiding this comment. Let's not use
Collaborator
Author
There was a problem hiding this comment. Converted to Spring Service (named bean) |
||
|
|
||
| public static final Set<String> excludedProcessorsFromDynamicUpdate = Set.of("aggregate"); | ||
|
|
||
| public static boolean isDynamicUpdateFeasible(final PipelinesDataFlowModel currentPipelineDataFlowMode, | ||
| final PipelinesDataFlowModel targetDataPipelineDataFlowMode) { | ||
|
|
||
| checkIfSamePipelineExists(currentPipelineDataFlowMode, targetDataPipelineDataFlowMode); | ||
| Set<String> singleThreadedProcessorNames = scanForSingleThreadAnnotatedProcessorPlugins(); | ||
| singleThreadedProcessorNames.addAll(excludedProcessorsFromDynamicUpdate); | ||
|
|
||
| for (String pipelineName : currentPipelineDataFlowMode.getPipelines().keySet()) { | ||
| PipelineModel currentPipelineModel = currentPipelineDataFlowMode.getPipelines().get(pipelineName); | ||
| PipelineModel targetPipelineModel = targetDataPipelineDataFlowMode.getPipelines().get(pipelineName); | ||
|
|
||
| // Check if source configuration remains unchanged | ||
| PluginModel currentSource = currentPipelineModel.getSource(); | ||
| PluginModel targetSource = targetPipelineModel.getSource(); | ||
| if (!currentSource.equals(targetSource)) { | ||
| throw new DynamicPipelineConfigUpdateException( | ||
| "Source configuration cannot be modified in pipeline: " + pipelineName); | ||
| } | ||
|
|
||
| // Check if sinks configuration remains unchanged | ||
| List<SinkModel> currentSinks = currentPipelineModel.getSinks(); | ||
| List<SinkModel> targetSinks = targetPipelineModel.getSinks(); | ||
| if (!currentSinks.equals(targetSinks)) { | ||
| throw new DynamicPipelineConfigUpdateException( | ||
| "Sinks configuration cannot be modified in pipeline: " + pipelineName); | ||
| } | ||
|
|
||
| List<PluginModel> currentProcessors = currentPipelineModel.getProcessors(); | ||
| List<PluginModel> targetProcessors = targetPipelineModel.getProcessors(); | ||
|
|
||
| currentProcessors = currentProcessors == null ? List.of() : currentProcessors; | ||
| targetProcessors = targetProcessors == null ? List.of() : targetProcessors; | ||
|
|
||
| // Collect single-threaded processors in current and target | ||
| Set<String> currentSingleThreaded = currentProcessors.stream() | ||
|
Member
There was a problem hiding this comment. There is a bit of split logic here. We have other places to look for this annotation. Can we make use of that existing code? |
||
| .map(PluginModel::getPluginName) | ||
| .filter(singleThreadedProcessorNames::contains) | ||
| .collect(Collectors.toSet()); | ||
|
|
||
| Set<String> targetSingleThreaded = targetProcessors.stream() | ||
| .map(PluginModel::getPluginName) | ||
| .filter(singleThreadedProcessorNames::contains) | ||
| .collect(Collectors.toSet()); | ||
|
|
||
| // Only throw if target adds new single-threaded processors or modifies existing ones | ||
| for (String targetProcessor : targetSingleThreaded) { | ||
| if (!currentSingleThreaded.contains(targetProcessor)) { | ||
| throw new DynamicPipelineConfigUpdateException( | ||
| "Cannot add new single-threaded processor: " + targetProcessor); | ||
|
Member
There was a problem hiding this comment. Why do we care about this? Is it because of the state? If so, this is insufficient. The Also, Maybe we should have an |
||
| } | ||
| } | ||
| } | ||
| return true; | ||
| } | ||
|
|
||
| public static void executeDynamicUpdateOfPipelineConfig(final PipelinesDataFlowModel currentPipelineDataFlowMode, | ||
| final PipelinesDataFlowModel targetDataPipelineDataFlowMode) { | ||
|
|
||
|
|
||
| } | ||
|
|
||
| public static void checkIfSamePipelineExists(final PipelinesDataFlowModel currentPipelineDataFlowMode, | ||
| final PipelinesDataFlowModel targetDataPipelineDataFlowMode) { | ||
|
|
||
| Set<String> currentPipelineNames = currentPipelineDataFlowMode.getPipelines().keySet(); | ||
| Set<String> targetPipelineNames = targetDataPipelineDataFlowMode.getPipelines().keySet(); | ||
|
|
||
| if (!currentPipelineNames.equals(targetPipelineNames)) { | ||
| String addedPipelines = targetPipelineNames.stream() | ||
| .filter(name -> !currentPipelineNames.contains(name)) | ||
| .collect(Collectors.joining(", ")); | ||
| String removedPipelines = currentPipelineNames.stream() | ||
| .filter(name -> !targetPipelineNames.contains(name)) | ||
| .collect(Collectors.joining(", ")); | ||
|
|
||
| StringBuilder errorMessage = new StringBuilder("Pipeline configuration mismatch found."); | ||
| if (!addedPipelines.isEmpty()) { | ||
| errorMessage.append(" New pipelines found: ").append(addedPipelines).append("."); | ||
| } | ||
| if (!removedPipelines.isEmpty()) { | ||
| errorMessage.append(" Missing pipelines: ").append(removedPipelines).append("."); | ||
| } | ||
|
|
||
| throw new DynamicPipelineConfigUpdateException(errorMessage.toString()); | ||
| } | ||
| } | ||
|
|
||
| public static Set<String> scanForSingleThreadAnnotatedProcessorPlugins() { | ||
|
Member
There was a problem hiding this comment. This is duplicating work from the I don't think the |
||
| Reflections reflections = new Reflections("org.opensearch.dataprepper", new TypeAnnotationsScanner()); | ||
| Set<Class<?>> dataPrepperPlugins = reflections.getTypesAnnotatedWith(DataPrepperPlugin.class); | ||
| Set<String> singleThreadedProcessorNames = new HashSet<>(); | ||
|
|
||
| for (Class<?> clazz : dataPrepperPlugins) { | ||
| if (clazz.isAnnotationPresent(SingleThread.class) || RequiresPeerForwarding.class.isAssignableFrom(clazz)) { | ||
| DataPrepperPlugin pluginAnnotation = clazz.getAnnotation(DataPrepperPlugin.class); | ||
| String name = pluginAnnotation.name(); | ||
| singleThreadedProcessorNames.add(name); | ||
| } | ||
| } | ||
| return singleThreadedProcessorNames; | ||
| } | ||
|
|
||
| } | ||
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,31 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.dataprepper.core.pipeline.server; | ||
|
|
||
| import com.sun.net.httpserver.HttpExchange; | ||
| import com.sun.net.httpserver.HttpHandler; | ||
| import org.opensearch.dataprepper.core.pipeline.PipelinesProvider; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| /** | ||
| * HttpHandler to handle requests for updating pipeline configurations from S3 | ||
| */ | ||
| public class IsDynamicallyUpdatablePipelineHandler extends UpdatePipelineBaseHandler implements HttpHandler { | ||
|
|
||
| private static final Logger LOG = LoggerFactory.getLogger(IsDynamicallyUpdatablePipelineHandler.class); | ||
|
|
||
| public IsDynamicallyUpdatablePipelineHandler(final PipelinesProvider pipelinesProvider) { | ||
| super(pipelinesProvider); | ||
| } | ||
|
|
||
| @Override | ||
| public void handle(final HttpExchange exchange) throws IOException { | ||
| baseHandle(exchange, false); | ||
| } | ||
| } |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Were these moved within nested classes? Or just shifted in the code?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just shifted in the code. I now adjusted my IDE formatter not to touch unmodified code.