-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
SearchPipelineService.java
498 lines (457 loc) · 22.8 KB
/
SearchPipelineService.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
/*
* 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.pipeline;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.opensearch.ExceptionsHelper;
import org.opensearch.OpenSearchParseException;
import org.opensearch.ResourceNotFoundException;
import org.opensearch.action.search.DeleteSearchPipelineRequest;
import org.opensearch.action.search.PutSearchPipelineRequest;
import org.opensearch.action.search.SearchRequest;
import org.opensearch.action.support.master.AcknowledgedResponse;
import org.opensearch.client.Client;
import org.opensearch.cluster.AckedClusterStateUpdateTask;
import org.opensearch.cluster.ClusterChangedEvent;
import org.opensearch.cluster.ClusterState;
import org.opensearch.cluster.ClusterStateApplier;
import org.opensearch.cluster.metadata.IndexMetadata;
import org.opensearch.cluster.metadata.Metadata;
import org.opensearch.cluster.node.DiscoveryNode;
import org.opensearch.cluster.service.ClusterManagerTaskKeys;
import org.opensearch.cluster.service.ClusterManagerTaskThrottler;
import org.opensearch.cluster.service.ClusterService;
import org.opensearch.common.metrics.OperationMetrics;
import org.opensearch.common.regex.Regex;
import org.opensearch.common.settings.Settings;
import org.opensearch.common.unit.TimeValue;
import org.opensearch.common.xcontent.XContentHelper;
import org.opensearch.core.action.ActionListener;
import org.opensearch.core.common.io.stream.NamedWriteableRegistry;
import org.opensearch.core.service.ReportingService;
import org.opensearch.core.xcontent.NamedXContentRegistry;
import org.opensearch.env.Environment;
import org.opensearch.gateway.GatewayService;
import org.opensearch.index.IndexSettings;
import org.opensearch.index.analysis.AnalysisRegistry;
import org.opensearch.ingest.ConfigurationUtils;
import org.opensearch.plugins.SearchPipelinePlugin;
import org.opensearch.script.ScriptService;
import org.opensearch.threadpool.ThreadPool;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
/**
* The main entry point for search pipelines. Handles CRUD operations and exposes the API to execute search pipelines
* against requests and responses.
*/
public class SearchPipelineService implements ClusterStateApplier, ReportingService<SearchPipelineInfo> {
public static final String SEARCH_PIPELINE_ORIGIN = "search_pipeline";
public static final String AD_HOC_PIPELINE_ID = "_ad_hoc_pipeline";
public static final String NOOP_PIPELINE_ID = "_none";
private static final Logger logger = LogManager.getLogger(SearchPipelineService.class);
private final ClusterService clusterService;
private final ScriptService scriptService;
private final Map<String, Processor.Factory<SearchRequestProcessor>> requestProcessorFactories;
private final Map<String, Processor.Factory<SearchResponseProcessor>> responseProcessorFactories;
private final Map<String, Processor.Factory<SearchPhaseResultsProcessor>> phaseInjectorProcessorFactories;
private volatile Map<String, PipelineHolder> pipelines = Collections.emptyMap();
private final ThreadPool threadPool;
private final List<Consumer<ClusterState>> searchPipelineClusterStateListeners = new CopyOnWriteArrayList<>();
private final ClusterManagerTaskThrottler.ThrottlingKey putPipelineTaskKey;
private final ClusterManagerTaskThrottler.ThrottlingKey deletePipelineTaskKey;
private final NamedWriteableRegistry namedWriteableRegistry;
private volatile ClusterState state;
private final OperationMetrics totalRequestProcessingMetrics = new OperationMetrics();
private final OperationMetrics totalResponseProcessingMetrics = new OperationMetrics();
public SearchPipelineService(
ClusterService clusterService,
ThreadPool threadPool,
Environment env,
ScriptService scriptService,
AnalysisRegistry analysisRegistry,
NamedXContentRegistry namedXContentRegistry,
NamedWriteableRegistry namedWriteableRegistry,
List<SearchPipelinePlugin> searchPipelinePlugins,
Client client
) {
this.clusterService = clusterService;
this.scriptService = scriptService;
this.threadPool = threadPool;
this.namedWriteableRegistry = namedWriteableRegistry;
SearchPipelinePlugin.Parameters parameters = new SearchPipelinePlugin.Parameters(
env,
scriptService,
analysisRegistry,
threadPool.getThreadContext(),
threadPool::relativeTimeInMillis,
(delay, command) -> threadPool.schedule(command, TimeValue.timeValueMillis(delay), ThreadPool.Names.GENERIC),
this,
client,
threadPool.generic()::execute,
namedXContentRegistry
);
this.requestProcessorFactories = processorFactories(searchPipelinePlugins, p -> p.getRequestProcessors(parameters));
this.responseProcessorFactories = processorFactories(searchPipelinePlugins, p -> p.getResponseProcessors(parameters));
this.phaseInjectorProcessorFactories = processorFactories(
searchPipelinePlugins,
p -> p.getSearchPhaseResultsProcessors(parameters)
);
putPipelineTaskKey = clusterService.registerClusterManagerTask(ClusterManagerTaskKeys.PUT_SEARCH_PIPELINE_KEY, true);
deletePipelineTaskKey = clusterService.registerClusterManagerTask(ClusterManagerTaskKeys.DELETE_SEARCH_PIPELINE_KEY, true);
}
private static <T extends Processor> Map<String, Processor.Factory<T>> processorFactories(
List<SearchPipelinePlugin> searchPipelinePlugins,
Function<SearchPipelinePlugin, Map<String, Processor.Factory<T>>> processorLoader
) {
Map<String, Processor.Factory<T>> processorFactories = new HashMap<>();
for (SearchPipelinePlugin searchPipelinePlugin : searchPipelinePlugins) {
Map<String, Processor.Factory<T>> newProcessors = processorLoader.apply(searchPipelinePlugin);
for (Map.Entry<String, Processor.Factory<T>> entry : newProcessors.entrySet()) {
if (processorFactories.put(entry.getKey(), entry.getValue()) != null) {
throw new IllegalArgumentException("Search processor [" + entry.getKey() + "] is already registered");
}
}
}
return Collections.unmodifiableMap(processorFactories);
}
@Override
public void applyClusterState(ClusterChangedEvent event) {
state = event.state();
if (state.blocks().hasGlobalBlock(GatewayService.STATE_NOT_RECOVERED_BLOCK)) {
return;
}
searchPipelineClusterStateListeners.forEach(consumer -> consumer.accept(state));
SearchPipelineMetadata newSearchPipelineMetadata = state.getMetadata().custom(SearchPipelineMetadata.TYPE);
if (newSearchPipelineMetadata == null) {
return;
}
try {
innerUpdatePipelines(newSearchPipelineMetadata);
} catch (OpenSearchParseException e) {
logger.warn("failed to update search pipelines", e);
}
}
void innerUpdatePipelines(SearchPipelineMetadata newSearchPipelineMetadata) {
Map<String, PipelineHolder> existingPipelines = this.pipelines;
// Lazily initialize these variables in order to favour the most likely scenario that there are no pipeline changes:
Map<String, PipelineHolder> newPipelines = null;
List<OpenSearchParseException> exceptions = null;
// Iterate over pipeline configurations in metadata and constructs a new pipeline if there is no pipeline
// or the pipeline configuration has been modified
for (PipelineConfiguration newConfiguration : newSearchPipelineMetadata.getPipelines().values()) {
PipelineHolder previous = existingPipelines.get(newConfiguration.getId());
if (previous != null && previous.configuration.equals(newConfiguration)) {
continue;
}
if (newPipelines == null) {
newPipelines = new HashMap<>(existingPipelines);
}
try {
PipelineWithMetrics newPipeline = PipelineWithMetrics.create(
newConfiguration.getId(),
newConfiguration.getConfigAsMap(),
requestProcessorFactories,
responseProcessorFactories,
phaseInjectorProcessorFactories,
namedWriteableRegistry,
totalRequestProcessingMetrics,
totalResponseProcessingMetrics,
new Processor.PipelineContext(Processor.PipelineSource.UPDATE_PIPELINE)
);
newPipelines.put(newConfiguration.getId(), new PipelineHolder(newConfiguration, newPipeline));
if (previous != null) {
newPipeline.copyMetrics(previous.pipeline);
}
} catch (Exception e) {
OpenSearchParseException parseException = new OpenSearchParseException(
"Error updating pipeline with id [" + newConfiguration.getId() + "]",
e
);
// TODO -- replace pipeline with one that throws this exception when we try to use it
if (exceptions == null) {
exceptions = new ArrayList<>();
}
exceptions.add(parseException);
}
}
// Iterate over the current active pipelines and check whether they are missing in the pipeline configuration and
// if so delete the pipeline from new Pipelines map:
for (Map.Entry<String, PipelineHolder> entry : existingPipelines.entrySet()) {
if (newSearchPipelineMetadata.getPipelines().get(entry.getKey()) == null) {
if (newPipelines == null) {
newPipelines = new HashMap<>(existingPipelines);
}
newPipelines.remove(entry.getKey());
}
}
if (newPipelines != null) {
this.pipelines = Collections.unmodifiableMap(newPipelines);
if (exceptions != null) {
ExceptionsHelper.rethrowAndSuppress(exceptions);
}
}
}
public void putPipeline(
Map<DiscoveryNode, SearchPipelineInfo> searchPipelineInfos,
PutSearchPipelineRequest request,
ActionListener<AcknowledgedResponse> listener
) throws Exception {
validatePipeline(searchPipelineInfos, request);
clusterService.submitStateUpdateTask(
"put-search-pipeline-" + request.getId(),
new AckedClusterStateUpdateTask<>(request, listener) {
@Override
public ClusterState execute(ClusterState currentState) {
return innerPut(request, currentState);
}
@Override
public ClusterManagerTaskThrottler.ThrottlingKey getClusterManagerThrottlingKey() {
return putPipelineTaskKey;
}
@Override
protected AcknowledgedResponse newResponse(boolean acknowledged) {
return new AcknowledgedResponse(acknowledged);
}
}
);
}
static ClusterState innerPut(PutSearchPipelineRequest request, ClusterState currentState) {
SearchPipelineMetadata currentSearchPipelineMetadata = currentState.metadata().custom(SearchPipelineMetadata.TYPE);
Map<String, PipelineConfiguration> pipelines;
if (currentSearchPipelineMetadata != null) {
pipelines = new HashMap<>(currentSearchPipelineMetadata.getPipelines());
} else {
pipelines = new HashMap<>();
}
pipelines.put(request.getId(), new PipelineConfiguration(request.getId(), request.getSource(), request.getMediaType()));
ClusterState.Builder newState = ClusterState.builder(currentState);
newState.metadata(
Metadata.builder(currentState.getMetadata())
.putCustom(SearchPipelineMetadata.TYPE, new SearchPipelineMetadata(pipelines))
.build()
);
return newState.build();
}
void validatePipeline(Map<DiscoveryNode, SearchPipelineInfo> searchPipelineInfos, PutSearchPipelineRequest request) throws Exception {
if (searchPipelineInfos.isEmpty()) {
throw new IllegalStateException("Search pipeline info is empty");
}
Map<String, Object> pipelineConfig = XContentHelper.convertToMap(request.getSource(), false, request.getMediaType()).v2();
Pipeline pipeline = PipelineWithMetrics.create(
request.getId(),
pipelineConfig,
requestProcessorFactories,
responseProcessorFactories,
phaseInjectorProcessorFactories,
namedWriteableRegistry,
new OperationMetrics(), // Use ephemeral metrics for validation
new OperationMetrics(),
new Processor.PipelineContext(Processor.PipelineSource.VALIDATE_PIPELINE)
);
List<Exception> exceptions = new ArrayList<>();
for (SearchRequestProcessor processor : pipeline.getSearchRequestProcessors()) {
for (Map.Entry<DiscoveryNode, SearchPipelineInfo> entry : searchPipelineInfos.entrySet()) {
String type = processor.getType();
if (entry.getValue().containsProcessor(Pipeline.REQUEST_PROCESSORS_KEY, type) == false) {
String message = "Processor type [" + processor.getType() + "] is not installed on node [" + entry.getKey() + "]";
exceptions.add(ConfigurationUtils.newConfigurationException(processor.getType(), processor.getTag(), null, message));
}
}
}
for (SearchResponseProcessor processor : pipeline.getSearchResponseProcessors()) {
for (Map.Entry<DiscoveryNode, SearchPipelineInfo> entry : searchPipelineInfos.entrySet()) {
String type = processor.getType();
if (entry.getValue().containsProcessor(Pipeline.RESPONSE_PROCESSORS_KEY, type) == false) {
String message = "Processor type [" + processor.getType() + "] is not installed on node [" + entry.getKey() + "]";
exceptions.add(ConfigurationUtils.newConfigurationException(processor.getType(), processor.getTag(), null, message));
}
}
}
ExceptionsHelper.rethrowAndSuppress(exceptions);
}
public void deletePipeline(DeleteSearchPipelineRequest request, ActionListener<AcknowledgedResponse> listener) throws Exception {
clusterService.submitStateUpdateTask(
"delete-search-pipeline-" + request.getId(),
new AckedClusterStateUpdateTask<>(request, listener) {
@Override
public ClusterState execute(ClusterState currentState) {
return innerDelete(request, currentState);
}
@Override
public ClusterManagerTaskThrottler.ThrottlingKey getClusterManagerThrottlingKey() {
return deletePipelineTaskKey;
}
@Override
protected AcknowledgedResponse newResponse(boolean acknowledged) {
return new AcknowledgedResponse(acknowledged);
}
}
);
}
static ClusterState innerDelete(DeleteSearchPipelineRequest request, ClusterState currentState) {
SearchPipelineMetadata currentMetadata = currentState.metadata().custom(SearchPipelineMetadata.TYPE);
if (currentMetadata == null) {
return currentState;
}
Map<String, PipelineConfiguration> pipelines = currentMetadata.getPipelines();
Set<String> toRemove = new HashSet<>();
for (String pipelineKey : pipelines.keySet()) {
if (Regex.simpleMatch(request.getId(), pipelineKey)) {
toRemove.add(pipelineKey);
}
}
if (toRemove.isEmpty()) {
if (Regex.isMatchAllPattern(request.getId())) {
// Deleting all the empty state is a no-op.
return currentState;
}
throw new ResourceNotFoundException("pipeline [{}] is missing", request.getId());
}
final Map<String, PipelineConfiguration> newPipelines = new HashMap<>(pipelines);
for (String key : toRemove) {
newPipelines.remove(key);
}
ClusterState.Builder newState = ClusterState.builder(currentState);
newState.metadata(
Metadata.builder(currentState.getMetadata()).putCustom(SearchPipelineMetadata.TYPE, new SearchPipelineMetadata(newPipelines))
);
return newState.build();
}
public PipelinedRequest resolvePipeline(SearchRequest searchRequest) {
Pipeline pipeline = Pipeline.NO_OP_PIPELINE;
if (searchRequest.source() != null && searchRequest.source().searchPipelineSource() != null) {
// Pipeline defined in search request (ad hoc pipeline).
if (searchRequest.pipeline() != null) {
throw new IllegalArgumentException(
"Both named and inline search pipeline were specified. Please only specify one or the other."
);
}
try {
pipeline = PipelineWithMetrics.create(
AD_HOC_PIPELINE_ID,
searchRequest.source().searchPipelineSource(),
requestProcessorFactories,
responseProcessorFactories,
phaseInjectorProcessorFactories,
namedWriteableRegistry,
totalRequestProcessingMetrics,
totalResponseProcessingMetrics,
new Processor.PipelineContext(Processor.PipelineSource.SEARCH_REQUEST)
);
} catch (Exception e) {
throw new SearchPipelineProcessingException(e);
}
} else {
String pipelineId = NOOP_PIPELINE_ID;
if (searchRequest.pipeline() != null) {
// Named pipeline specified for the request
pipelineId = searchRequest.pipeline();
} else if (state != null && searchRequest.indices() != null && searchRequest.indices().length == 1) {
// Check for index default pipeline
IndexMetadata indexMetadata = state.metadata().index(searchRequest.indices()[0]);
if (indexMetadata != null) {
Settings indexSettings = indexMetadata.getSettings();
if (IndexSettings.DEFAULT_SEARCH_PIPELINE.exists(indexSettings)) {
pipelineId = IndexSettings.DEFAULT_SEARCH_PIPELINE.get(indexSettings);
}
}
}
if (NOOP_PIPELINE_ID.equals(pipelineId) == false) {
PipelineHolder pipelineHolder = pipelines.get(pipelineId);
if (pipelineHolder == null) {
throw new IllegalArgumentException("Pipeline " + pipelineId + " is not defined");
}
pipeline = pipelineHolder.pipeline;
}
}
PipelineProcessingContext requestContext = new PipelineProcessingContext();
return new PipelinedRequest(pipeline, searchRequest, requestContext);
}
Map<String, Processor.Factory<SearchRequestProcessor>> getRequestProcessorFactories() {
return requestProcessorFactories;
}
Map<String, Processor.Factory<SearchResponseProcessor>> getResponseProcessorFactories() {
return responseProcessorFactories;
}
@Override
public SearchPipelineInfo info() {
List<ProcessorInfo> requestProcessorInfoList = requestProcessorFactories.keySet()
.stream()
.map(ProcessorInfo::new)
.collect(Collectors.toList());
List<ProcessorInfo> responseProcessorInfoList = responseProcessorFactories.keySet()
.stream()
.map(ProcessorInfo::new)
.collect(Collectors.toList());
return new SearchPipelineInfo(
Map.of(Pipeline.REQUEST_PROCESSORS_KEY, requestProcessorInfoList, Pipeline.RESPONSE_PROCESSORS_KEY, responseProcessorInfoList)
);
}
public SearchPipelineStats stats() {
SearchPipelineStats.Builder builder = new SearchPipelineStats.Builder();
builder.withTotalStats(totalRequestProcessingMetrics, totalResponseProcessingMetrics);
for (PipelineHolder pipelineHolder : pipelines.values()) {
PipelineWithMetrics pipeline = pipelineHolder.pipeline;
pipeline.populateStats(builder);
}
return builder.build();
}
public static List<PipelineConfiguration> getPipelines(ClusterState clusterState, String... ids) {
SearchPipelineMetadata metadata = clusterState.getMetadata().custom(SearchPipelineMetadata.TYPE);
return innerGetPipelines(metadata, ids);
}
static List<PipelineConfiguration> innerGetPipelines(SearchPipelineMetadata metadata, String... ids) {
if (metadata == null) {
return Collections.emptyList();
}
// if we didn't ask for _any_ ID, then we get them all (this is the same as if they ask for '*')
if (ids.length == 0) {
return new ArrayList<>(metadata.getPipelines().values());
}
List<PipelineConfiguration> result = new ArrayList<>(ids.length);
for (String id : ids) {
if (Regex.isSimpleMatchPattern(id)) {
for (Map.Entry<String, PipelineConfiguration> entry : metadata.getPipelines().entrySet()) {
if (Regex.simpleMatch(id, entry.getKey())) {
result.add(entry.getValue());
}
}
} else {
PipelineConfiguration pipeline = metadata.getPipelines().get(id);
if (pipeline != null) {
result.add(pipeline);
}
}
}
return result;
}
public ClusterService getClusterService() {
return clusterService;
}
Map<String, PipelineHolder> getPipelines() {
return pipelines;
}
static class PipelineHolder {
final PipelineConfiguration configuration;
final PipelineWithMetrics pipeline;
PipelineHolder(PipelineConfiguration configuration, PipelineWithMetrics pipeline) {
this.configuration = Objects.requireNonNull(configuration);
this.pipeline = Objects.requireNonNull(pipeline);
}
}
}