forked from opensearch-project/anomaly-detection
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathAbstractTimeSeriesActionHandler.java
1237 lines (1134 loc) · 61.7 KB
/
AbstractTimeSeriesActionHandler.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
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright OpenSearch Contributors
* SPDX-License-Identifier: Apache-2.0
*/
package org.opensearch.timeseries.rest.handler;
import static org.opensearch.core.xcontent.XContentParserUtils.ensureExpectedToken;
import static org.opensearch.timeseries.constant.CommonMessages.CATEGORICAL_FIELD_TYPE_ERR_MSG;
import static org.opensearch.timeseries.constant.CommonMessages.TIMESTAMP_VALIDATION_FAILED;
import static org.opensearch.timeseries.indices.IndexManagement.getScripts;
import static org.opensearch.timeseries.util.ParseUtils.parseAggregators;
import static org.opensearch.timeseries.util.RestHandlerUtils.XCONTENT_WITH_TYPE;
import static org.opensearch.timeseries.util.RestHandlerUtils.isExceptionCausedByInvalidQuery;
import java.io.IOException;
import java.time.Clock;
import java.util.*;
import java.util.stream.Collectors;
import org.apache.commons.lang.StringUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.opensearch.OpenSearchStatusException;
import org.opensearch.action.admin.indices.create.CreateIndexResponse;
import org.opensearch.action.admin.indices.mapping.get.GetFieldMappingsAction;
import org.opensearch.action.admin.indices.mapping.get.GetFieldMappingsRequest;
import org.opensearch.action.admin.indices.mapping.get.GetFieldMappingsResponse;
import org.opensearch.action.admin.indices.settings.put.UpdateSettingsRequest;
import org.opensearch.action.get.GetRequest;
import org.opensearch.action.get.GetResponse;
import org.opensearch.action.index.IndexRequest;
import org.opensearch.action.index.IndexResponse;
import org.opensearch.action.ingest.DeletePipelineRequest;
import org.opensearch.action.ingest.PutPipelineRequest;
import org.opensearch.action.search.SearchRequest;
import org.opensearch.action.search.SearchResponse;
import org.opensearch.action.support.IndicesOptions;
import org.opensearch.action.support.WriteRequest;
import org.opensearch.action.support.master.AcknowledgedResponse;
import org.opensearch.action.support.replication.ReplicationResponse;
import org.opensearch.client.Client;
import org.opensearch.cluster.service.ClusterService;
import org.opensearch.common.settings.Settings;
import org.opensearch.common.unit.TimeValue;
import org.opensearch.common.util.concurrent.ThreadContext;
import org.opensearch.common.xcontent.XContentFactory;
import org.opensearch.common.xcontent.XContentType;
import org.opensearch.commons.authuser.User;
import org.opensearch.core.action.ActionListener;
import org.opensearch.core.action.ActionResponse;
import org.opensearch.core.common.bytes.BytesReference;
import org.opensearch.core.rest.RestStatus;
import org.opensearch.core.xcontent.NamedXContentRegistry;
import org.opensearch.core.xcontent.XContentBuilder;
import org.opensearch.core.xcontent.XContentParser;
import org.opensearch.index.query.BoolQueryBuilder;
import org.opensearch.index.query.QueryBuilder;
import org.opensearch.index.query.QueryBuilders;
import org.opensearch.rest.RestRequest;
import org.opensearch.search.aggregations.AggregatorFactories;
import org.opensearch.search.builder.SearchSourceBuilder;
import org.opensearch.timeseries.AnalysisType;
import org.opensearch.timeseries.common.exception.TimeSeriesException;
import org.opensearch.timeseries.common.exception.ValidationException;
import org.opensearch.timeseries.constant.CommonMessages;
import org.opensearch.timeseries.constant.CommonName;
import org.opensearch.timeseries.feature.SearchFeatureDao;
import org.opensearch.timeseries.indices.IndexManagement;
import org.opensearch.timeseries.indices.TimeSeriesIndex;
import org.opensearch.timeseries.model.Config;
import org.opensearch.timeseries.model.Feature;
import org.opensearch.timeseries.model.MergeableList;
import org.opensearch.timeseries.model.TaskType;
import org.opensearch.timeseries.model.TimeSeriesTask;
import org.opensearch.timeseries.model.ValidationAspect;
import org.opensearch.timeseries.model.ValidationIssueType;
import org.opensearch.timeseries.settings.TimeSeriesSettings;
import org.opensearch.timeseries.task.TaskCacheManager;
import org.opensearch.timeseries.task.TaskManager;
import org.opensearch.timeseries.util.*;
import org.opensearch.transport.TransportService;
import com.google.common.collect.Sets;
/**
* AbstractTimeSeriesActionHandler serves as the foundational base for handling various time series actions
* such as creating, updating, and validating configurations related to time series analysis. This class encapsulates
* common logic and utilities for managing time series indices, processing requests, and interacting with the OpenSearch cluster
* to execute time series tasks.
*
* Responsibilities include:
* - Validating and processing REST requests for time series configurations, ensuring they comply with predefined
* constraints and formats.
* - Managing interactions with the underlying time series indices, including index creation, document indexing,
* and configuration retrieval.
* - Serving as a base for specialized action handlers that implement specific logic for different types of time series tasks
* (e.g., anomaly detection, forecasting).
* - Handling security and permission validations for time series operations, leveraging OpenSearch's security features
* to ensure operations are performed by authorized users.
*
* The class is designed to be extended by specific action handlers that implement the abstract methods provided,
* allowing for flexible and modular enhancement of the time series capabilities within OpenSearch.
*
* Usage of this class requires extending it to implement the abstract methods, which include but are not limited to
* configuration validation, indexing logic, and model validation. Implementers will benefit from the common utilities
* and framework provided by this class, focusing on the unique logic pertinent to their specific time series task.
*/
public abstract class AbstractTimeSeriesActionHandler<T extends ActionResponse, IndexType extends Enum<IndexType> & TimeSeriesIndex, IndexManagementType extends IndexManagement<IndexType>, TaskCacheManagerType extends TaskCacheManager, TaskTypeEnum extends TaskType, TaskClass extends TimeSeriesTask, TaskManagerType extends TaskManager<TaskCacheManagerType, TaskTypeEnum, TaskClass, IndexType, IndexManagementType>>
implements
Processor<T> {
protected final Logger logger = LogManager.getLogger(AbstractTimeSeriesActionHandler.class);
public static final String NAME_REGEX = "[a-zA-Z0-9._-]+";
public static final Integer MAX_NAME_SIZE = 64;
public static final String CATEGORY_NOT_FOUND_ERR_MSG = "Can't find the categorical field %s in index %s";
public static String INVALID_NAME_SIZE = "Name should be shortened. The maximum limit is "
+ AbstractTimeSeriesActionHandler.MAX_NAME_SIZE
+ " characters.";
public static final Set<String> ALL_VALIDATION_ASPECTS_STRS = Arrays
.asList(ValidationAspect.values())
.stream()
.map(aspect -> aspect.getName())
.collect(Collectors.toSet());
protected final Config config;
protected final IndexManagement<IndexType> timeSeriesIndices;
protected final boolean isDryRun;
protected final Client client;
protected final String id;
protected final SecurityClientUtil clientUtil;
protected final User user;
protected final RestRequest.Method method;
protected final ConfigUpdateConfirmer<IndexType, IndexManagementType, TaskCacheManagerType, TaskTypeEnum, TaskClass, TaskManagerType> handler;
protected final ClusterService clusterService;
protected final NamedXContentRegistry xContentRegistry;
protected final TimeValue requestTimeout;
protected final WriteRequest.RefreshPolicy refreshPolicy;
protected final Long seqNo;
protected final Long primaryTerm;
protected final String validationType;
protected final SearchFeatureDao searchFeatureDao;
protected final Integer maxFeatures;
protected final Integer maxCategoricalFields;
protected final AnalysisType context;
protected final List<TaskTypeEnum> batchTasks;
protected final boolean canUpdateEverything;
protected final Integer maxSingleStreamConfigs;
protected final Integer maxHCConfigs;
protected final Clock clock;
protected final Settings settings;
protected final ValidationAspect configValidationAspect;
protected boolean breakingUIChange;
public AbstractTimeSeriesActionHandler(
Config config,
IndexManagement<IndexType> timeSeriesIndices,
boolean isDryRun,
Client client,
String id,
SecurityClientUtil clientUtil,
User user,
RestRequest.Method method,
ClusterService clusterService,
NamedXContentRegistry xContentRegistry,
TransportService transportService,
TimeValue requestTimeout,
WriteRequest.RefreshPolicy refreshPolicy,
Long seqNo,
Long primaryTerm,
String validationType,
SearchFeatureDao searchFeatureDao,
Integer maxFeatures,
Integer maxCategoricalFields,
AnalysisType context,
TaskManagerType taskManager,
List<TaskTypeEnum> batchTasks,
boolean canUpdateCategoryField,
Integer maxSingleStreamConfigs,
Integer maxHCConfigs,
Clock clock,
Settings settings,
ValidationAspect configValidationAspect
) {
this.config = config;
this.timeSeriesIndices = timeSeriesIndices;
this.isDryRun = isDryRun;
this.client = client;
this.id = id == null ? "" : id;
this.clientUtil = clientUtil;
this.user = user;
this.method = method;
this.clusterService = clusterService;
this.xContentRegistry = xContentRegistry;
this.requestTimeout = requestTimeout;
this.refreshPolicy = refreshPolicy;
this.seqNo = seqNo;
this.primaryTerm = primaryTerm;
this.validationType = validationType;
this.searchFeatureDao = searchFeatureDao;
this.maxFeatures = maxFeatures;
this.maxCategoricalFields = maxCategoricalFields;
this.context = context;
this.batchTasks = batchTasks;
this.canUpdateEverything = canUpdateCategoryField;
this.maxSingleStreamConfigs = maxSingleStreamConfigs;
this.maxHCConfigs = maxHCConfigs;
this.clock = clock;
this.settings = settings;
this.handler = new ConfigUpdateConfirmer<>(taskManager, transportService);
this.configValidationAspect = configValidationAspect;
this.breakingUIChange = false;
}
/**
* Start function to process create/update/validate config request.
*
* If validation type is detector/forecaster then all validation in this class involves validation
* checks against the configurations.
* Any issues raised here would block user from creating the config (e.g., anomaly detector).
* If validation Aspect is of type model then further non-blocker validation will be executed
* after the blocker validation is executed. Any issues that are raised for model validation
* are simply warnings for the user in terms of how configuration could be changed to lead to
* a higher likelihood of model training completing successfully.
*
* For custom index validation, if config is not using custom result index, check if config
* index exist first, if not, will create first. Otherwise, check if custom
* result index exists or not. If exists, will check if index mapping matches
* config result index mapping and if user has correct permission to write index.
* If doesn't exist, will create custom result index with result index
* mapping.
*/
@Override
public void start(ActionListener<T> listener) {
String resultIndexOrAlias = config.getCustomResultIndexOrAlias();
// use default detector result index which is system index
if (resultIndexOrAlias == null) {
createOrUpdateConfig(listener);
return;
}
if (this.isDryRun) {
if (timeSeriesIndices.doesIndexExist(resultIndexOrAlias) || timeSeriesIndices.doesAliasExist(resultIndexOrAlias)) {
timeSeriesIndices
.validateResultIndexAndExecute(
resultIndexOrAlias,
() -> createOrUpdateConfig(listener),
false,
ActionListener.wrap(r -> createOrUpdateConfig(listener), ex -> {
logger.error(ex);
listener.onFailure(createValidationException(ex.getMessage(), ValidationIssueType.RESULT_INDEX));
return;
})
);
return;
} else {
createOrUpdateConfig(listener);
return;
}
}
// use custom result index if not validating and resultIndex not null
timeSeriesIndices.initCustomResultIndexAndExecute(resultIndexOrAlias, () -> createOrUpdateConfig(listener), listener);
}
// if isDryRun is true then this method is being executed through Validation API meaning actual
// index won't be created, only validation checks will be executed throughout the class
private void createOrUpdateConfig(ActionListener<T> listener) {
try (ThreadContext.StoredContext context = client.threadPool().getThreadContext().stashContext()) {
if (!timeSeriesIndices.doesConfigIndexExist() && !this.isDryRun) {
logger.info("Config Indices do not exist");
timeSeriesIndices
.initConfigIndex(
ActionListener
.wrap(
response -> onCreateMappingsResponse(response, false, listener),
exception -> listener.onFailure(exception)
)
);
} else {
logger.info("DryRun variable " + this.isDryRun);
validateName(this.isDryRun, listener);
}
} catch (Exception e) {
logger.error("Failed to create or update forecaster " + id, e);
listener.onFailure(e);
}
}
protected void validateName(boolean indexingDryRun, ActionListener<T> listener) {
if (!config.getName().matches(NAME_REGEX)) {
listener.onFailure(createValidationException(CommonMessages.INVALID_NAME, ValidationIssueType.NAME));
return;
}
if (config.getName().length() > MAX_NAME_SIZE) {
listener.onFailure(createValidationException(AbstractTimeSeriesActionHandler.INVALID_NAME_SIZE, ValidationIssueType.NAME));
return;
}
validateTimeField(indexingDryRun, listener);
}
protected void validateTimeField(boolean indexingDryRun, ActionListener<T> listener) {
String givenTimeField = config.getTimeField();
HashMap<String, List<String>> clusterIndicesMap = CrossClusterConfigUtils
.separateClusterIndexes(config.getIndices(), clusterService);
ActionListener<MergeableList<Optional<double[]>>> validateGetMappingForTimeFieldListener = ActionListener.wrap(response -> {
prepareConfigIndexing(indexingDryRun, listener);
}, exception -> { listener.onFailure(createValidationException(exception.getMessage(), ValidationIssueType.TIMEFIELD_FIELD)); });
MultiResponsesDelegateActionListener<MergeableList<Optional<double[]>>> multiGetMappingResponseListener =
new MultiResponsesDelegateActionListener<>(
validateGetMappingForTimeFieldListener,
clusterIndicesMap.entrySet().size(),
String.format(Locale.ROOT, TIMESTAMP_VALIDATION_FAILED, config.getName()),
false
);
for (Map.Entry<String, List<String>> clusterIndicesEntry : clusterIndicesMap.entrySet()) {
GetFieldMappingsRequest getMappingsRequestForIndex = new GetFieldMappingsRequest();
getMappingsRequestForIndex.indices((clusterIndicesEntry.getValue().toArray(new String[0]))).fields(givenTimeField);
getMappingsRequestForIndex.indicesOptions(IndicesOptions.strictExpand());
Client targetClusterClient = CrossClusterConfigUtils.getClientForCluster(clusterIndicesEntry.getKey(), client, clusterService);
ActionListener<GetFieldMappingsResponse> getMappingResponseListener = ActionListener.wrap(getMappingsResponse -> {
boolean foundField = false;
Map<String, Map<String, GetFieldMappingsResponse.FieldMappingMetadata>> mappingsByIndex = getMappingsResponse.mappings();
for (Map.Entry<String, Map<String, GetFieldMappingsResponse.FieldMappingMetadata>> mappingsByField : mappingsByIndex
.entrySet()) {
if (mappingsByField.getValue().isEmpty()) {
multiGetMappingResponseListener
.onFailure(
new ValidationException(
String
.format(
Locale.ROOT,
CommonMessages.NON_EXISTENT_TIMESTAMP_IN_INDEX,
givenTimeField,
mappingsByField.getKey()
),
ValidationIssueType.TIMEFIELD_FIELD,
configValidationAspect
)
);
return;
}
for (Map.Entry<String, GetFieldMappingsResponse.FieldMappingMetadata> field2Metadata : mappingsByField
.getValue()
.entrySet()) {
GetFieldMappingsResponse.FieldMappingMetadata fieldMetadata = field2Metadata.getValue();
if (fieldMetadata != null) {
// sourceAsMap returns sth like {host2={type=keyword}} with host2 being a nested field
Map<String, Object> fieldMap = fieldMetadata.sourceAsMap();
if (fieldMap != null) {
for (Object type : fieldMap.values()) {
if (type instanceof Map) {
foundField = true;
Map<String, Object> metadataMap = (Map<String, Object>) type;
String typeName = (String) metadataMap.get(CommonName.TYPE);
if (!typeName.equals(CommonName.DATE_TYPE) && !typeName.equals(CommonName.DATE_NANOS_TYPE)) {
multiGetMappingResponseListener
.onFailure(
new ValidationException(
String.format(Locale.ROOT, CommonMessages.INVALID_TIMESTAMP, givenTimeField),
ValidationIssueType.TIMEFIELD_FIELD,
configValidationAspect
)
);
return;
}
}
}
}
}
}
}
if (!foundField) {
multiGetMappingResponseListener
.onFailure(
new ValidationException(
String.format(Locale.ROOT, CommonMessages.NON_EXISTENT_TIMESTAMP, givenTimeField),
ValidationIssueType.TIMEFIELD_FIELD,
configValidationAspect
)
);
return;
}
multiGetMappingResponseListener
.onResponse(new MergeableList<>(new ArrayList<>(Collections.singletonList(Optional.empty()))));
}, e -> {
String errorMessage = String.format(Locale.ROOT, "Fail to get the index mapping of %s", clusterIndicesEntry.getValue());
logger.error(errorMessage, e);
multiGetMappingResponseListener.onFailure(new IllegalArgumentException(errorMessage, e));
});
clientUtil
.executeWithInjectedSecurity(
GetFieldMappingsAction.INSTANCE,
getMappingsRequestForIndex,
user,
targetClusterClient,
context,
getMappingResponseListener
);
}
}
/**
* Prepares for indexing a new configuration.
*
* This method handles the preparation of indexing a configuration, either during validation (dry run)
* or for create/update operations. It supports both PUT and POST REST request methods.
*
* @param indexingDryRun indicates whether this is a dry run for indexing.
* If {@code true}, the operation performs validation without creating/updating the configuration.
* If {@code false}, the configuration is created or updated.
* @param listener the {@link ActionListener} to handle the response or failure of the operation.
*
* <p><b>Behavior:</b></p>
* <ul>
* <li>For {@code RestRequest.Method.PUT}: Validates that the job is not already running before proceeding
* with updating the configuration. It updates the configuration and manages the result index mapping
* if necessary.</li>
* <li>For {@code RestRequest.Method.POST}: Creates a new configuration. If a custom result index or alias is specified:
* <ul>
* <li>If flattening of the result index mapping is enabled, it initializes a flattened result index,
* sets up an ingest pipeline, and updates the flattened result index settings to bind the ingest pipeline
* with the flattened result index, enabling the writing of flattened nested fields into the flattened result index.</li>
* <li>If flattening is not enabled, directly returns the creation response.</li>
* </ul>
* If no custom result index or alias is specified, returns the creation response directly.</li>
* </ul>
*
* <p><b>Notes:</b></p>
* <ul>
* <li>If the configuration has a custom result index or alias and flattening is enabled,
* the flattened result index name is suffixed with the detector ID in lowercase.</li>
* <li>The ingest pipeline ID is uniquely generated based on the detector ID in lowercase.</li>
* </ul>
*
* <p><b>Exceptions:</b></p>
* <ul>
* <li>If the {@code createConfigResponse} is of an unexpected type, which indicates create config call has failed,
* then an {@link IllegalStateException} is thrown.</li>
* </ul>
*/
protected void prepareConfigIndexing(boolean indexingDryRun, ActionListener<T> listener) {
if (method == RestRequest.Method.PUT) {
handlePutRequest(indexingDryRun, listener);
} else {
handlePostRequest(indexingDryRun, listener);
}
}
private void handlePutRequest(boolean indexingDryRun, ActionListener<T> listener) {
handler
.confirmJobRunning(
clusterService,
client,
id,
listener,
() -> { updateConfig(id, indexingDryRun, listener); },
xContentRegistry
);
}
private void handlePostRequest(boolean indexingDryRun, ActionListener<T> listener) {
createConfig(indexingDryRun, ActionListener.wrap(createConfigResponse -> {
if (shouldHandleFlattening(indexingDryRun)) {
String configId = RestHandlerUtils.getConfigIdFromIndexResponse(createConfigResponse);
String flattenedResultIndexAlias = timeSeriesIndices
.getFlattenedResultIndexAlias(config.getCustomResultIndexOrAlias(), configId);
String pipelineId = timeSeriesIndices.getFlattenResultIndexIngestPipelineId(configId);
timeSeriesIndices
.initFlattenedResultIndex(
flattenedResultIndexAlias,
ActionListener.wrap(initResponse -> setupIngestPipeline(configId, ActionListener.wrap(pipelineResponse -> {
updateResultIndexSetting(
pipelineId,
flattenedResultIndexAlias,
ActionListener.wrap(updateResponse -> listener.onResponse(createConfigResponse), listener::onFailure)
);
}, listener::onFailure)), listener::onFailure)
);
} else {
listener.onResponse(createConfigResponse);
}
}, listener::onFailure));
}
private boolean shouldHandleFlattening(boolean indexingDryRun) {
Boolean flattenResultIndexMapping = config.getFlattenResultIndexMapping();
return !indexingDryRun && config.getCustomResultIndexOrAlias() != null && Boolean.TRUE.equals(flattenResultIndexMapping);
}
protected void setupIngestPipeline(String configId, ActionListener<T> listener) {
String flattenedResultIndexAlias = timeSeriesIndices.getFlattenedResultIndexAlias(config.getCustomResultIndexOrAlias(), configId);
String pipelineId = timeSeriesIndices.getFlattenResultIndexIngestPipelineId(configId);
try {
BytesReference pipelineSource = createPipelineDefinition(flattenedResultIndexAlias);
PutPipelineRequest putPipelineRequest = new PutPipelineRequest(pipelineId, pipelineSource, XContentType.JSON);
client.admin().cluster().putPipeline(putPipelineRequest, ActionListener.wrap(response -> {
if (response.isAcknowledged()) {
logger.info("Ingest pipeline created successfully for pipelineId: {}", pipelineId);
listener.onResponse(null);
} else {
String errorMessage = "Ingest pipeline creation was not acknowledged for pipelineId: " + pipelineId;
logger.error(errorMessage);
listener.onFailure(new OpenSearchStatusException(errorMessage, RestStatus.INTERNAL_SERVER_ERROR));
}
}, exception -> {
logger.error("Error while creating ingest pipeline for pipelineId: {}", pipelineId, exception);
listener.onFailure(exception);
}));
} catch (IOException e) {
logger.error("Exception while building ingest pipeline definition for pipeline ID: {}", pipelineId, e);
listener.onFailure(e);
}
}
private BytesReference createPipelineDefinition(String indexName) throws IOException {
XContentBuilder pipelineBuilder = XContentFactory.jsonBuilder();
pipelineBuilder.startObject();
{
pipelineBuilder.field("description", "Ingest pipeline for flattening result index: " + indexName);
pipelineBuilder.startArray("processors");
{
pipelineBuilder.startObject();
{
pipelineBuilder.startObject("script");
{
pipelineBuilder.field("lang", "painless");
String flattenScript = getScripts(TimeSeriesSettings.FLATTEN_CUSTOM_RESULT_INDEX_PAINLESS);
pipelineBuilder.field("source", flattenScript);
}
pipelineBuilder.endObject();
}
pipelineBuilder.endObject();
}
pipelineBuilder.endArray();
}
pipelineBuilder.endObject();
return BytesReference.bytes(pipelineBuilder);
}
protected void updateResultIndexSetting(String pipelineId, String flattenedResultIndex, ActionListener<T> listener) {
UpdateSettingsRequest updateSettingsRequest = new UpdateSettingsRequest();
updateSettingsRequest.indices(flattenedResultIndex);
Settings.Builder settingsBuilder = Settings.builder();
settingsBuilder.put("index.default_pipeline", pipelineId);
updateSettingsRequest.settings(settingsBuilder);
client.admin().indices().updateSettings(updateSettingsRequest, ActionListener.wrap(response -> {
if (response.isAcknowledged()) {
logger.info("Successfully updated settings for index: {} with pipeline: {}", flattenedResultIndex, pipelineId);
listener.onResponse(null);
} else {
String errorMsg = "Settings update not acknowledged for index: " + flattenedResultIndex;
logger.error(errorMsg);
listener.onFailure(new OpenSearchStatusException(errorMsg, RestStatus.INTERNAL_SERVER_ERROR));
}
}, exception -> {
logger.error("Failed to update settings for index: {} with pipeline: {}", flattenedResultIndex, pipelineId, exception);
listener.onFailure(exception);
}));
}
private void handleFlattenResultIndexMappingUpdate(Config existingConfig, ActionListener<T> listener) {
if (config.getCustomResultIndexOrAlias() == null) {
return;
}
if (existingConfig.getFlattenResultIndexMapping()
&& !config.getFlattenResultIndexMapping()
&& existingConfig.getCustomResultIndexOrAlias() != null) {
String pipelineId = timeSeriesIndices.getFlattenResultIndexIngestPipelineId(config.getId());
client.admin().cluster().deletePipeline(new DeletePipelineRequest(pipelineId), new ActionListener<AcknowledgedResponse>() {
@Override
public void onResponse(AcknowledgedResponse acknowledgedResponse) {
if (acknowledgedResponse.isAcknowledged()) {
logger.info("Ingest pipeline deleted successfully for pipelineId: {}", pipelineId);
} else {
logger.error("Failed to delete ingest pipeline for pipelineId: {}", pipelineId);
listener
.onFailure(
new OpenSearchStatusException(
"Ingest pipeline deletion was not acknowledged for pipelineId: " + pipelineId,
RestStatus.INTERNAL_SERVER_ERROR
)
);
}
}
@Override
public void onFailure(Exception e) {
if (e instanceof OpenSearchStatusException && ((OpenSearchStatusException) e).status() == RestStatus.NOT_FOUND) {
logger.info("Ingest pipeline [{}] not found, skipping deletion.", pipelineId);
listener.onResponse(null);
} else {
logger.error("Error while deleting ingest pipeline for pipelineId: {}", pipelineId, e);
listener.onFailure(e);
}
}
});
} else if (!existingConfig.getFlattenResultIndexMapping()
&& config.getFlattenResultIndexMapping()
&& existingConfig.getCustomResultIndexOrAlias() != null) {
listener.onFailure(new OpenSearchStatusException(CommonMessages.CAN_NOT_CHANGE_FLATTEN_RESULT_INDEX, RestStatus.BAD_REQUEST));
return;
}
}
protected void updateConfig(String id, boolean indexingDryRun, ActionListener<T> listener) {
GetRequest request = new GetRequest(CommonName.CONFIG_INDEX, id);
client
.get(
request,
ActionListener
.wrap(
response -> onGetConfigResponse(response, indexingDryRun, id, listener),
exception -> listener.onFailure(exception)
)
);
}
private void onGetConfigResponse(GetResponse response, boolean indexingDryRun, String id, ActionListener<T> listener) {
if (!response.isExists()) {
listener.onFailure(new OpenSearchStatusException(CommonMessages.FAIL_TO_FIND_CONFIG_MSG + id, RestStatus.NOT_FOUND));
return;
}
try (XContentParser parser = RestHandlerUtils.createXContentParserFromRegistry(xContentRegistry, response.getSourceAsBytesRef())) {
ensureExpectedToken(XContentParser.Token.START_OBJECT, parser.nextToken(), parser);
Config existingConfig = parse(parser, response);
// If category field changed, frontend may not be able to render AD result for different config types correctly.
// For example, if an anomaly detector changed from HC to single entity detector, AD result page may show multiple anomaly
// result points on the same time point if there are multiple entities have anomaly results.
// If single-category HC changed category field from IP to error type, the AD result page may show both IP and error type
// in top N entities list. That's confusing.
// So we decide to block updating detector category field.
// for forecasting, we will not show results after forecaster configuration change
// thus it is safe to allow updating everything. In the future, we might change AD to allow such behavior.
if (!canUpdateEverything) {
if (!ParseUtils.listEqualsWithoutConsideringOrder(existingConfig.getCategoryFields(), config.getCategoryFields())) {
listener.onFailure(new OpenSearchStatusException(CommonMessages.CAN_NOT_CHANGE_CATEGORY_FIELD, RestStatus.BAD_REQUEST));
return;
}
if (!Objects.equals(existingConfig.getCustomResultIndexOrAlias(), config.getCustomResultIndexOrAlias())) {
listener
.onFailure(
new OpenSearchStatusException(CommonMessages.CAN_NOT_CHANGE_CUSTOM_RESULT_INDEX, RestStatus.BAD_REQUEST)
);
return;
}
} else {
if (!ParseUtils.listEqualsWithoutConsideringOrder(existingConfig.getCategoryFields(), config.getCategoryFields())
|| !Objects.equals(existingConfig.getCustomResultIndexOrAlias(), config.getCustomResultIndexOrAlias())) {
breakingUIChange = true;
}
}
handleFlattenResultIndexMappingUpdate(existingConfig, listener);
ActionListener<Void> confirmBatchRunningListener = ActionListener
.wrap(
r -> searchConfigInputIndices(id, indexingDryRun, listener),
// can't update config if there is task running
listener::onFailure
);
handler.confirmBatchRunning(id, batchTasks, confirmBatchRunningListener);
} catch (Exception e) {
String message = "Failed to parse config " + id;
logger.error(message, e);
listener.onFailure(new OpenSearchStatusException(message, RestStatus.INTERNAL_SERVER_ERROR));
}
}
protected void validateAgainstExistingHCConfig(String configId, boolean indexingDryRun, ActionListener<T> listener) {
if (timeSeriesIndices.doesConfigIndexExist()) {
QueryBuilder query = QueryBuilders.boolQuery().filter(QueryBuilders.existsQuery(Config.CATEGORY_FIELD));
SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder().query(query).size(0).timeout(requestTimeout);
SearchRequest searchRequest = new SearchRequest(CommonName.CONFIG_INDEX).source(searchSourceBuilder);
client
.search(
searchRequest,
ActionListener
.wrap(
response -> onSearchHCConfigResponse(response, configId, indexingDryRun, listener),
exception -> listener.onFailure(exception)
)
);
} else {
validateCategoricalFieldsInAllIndices(configId, indexingDryRun, listener);
}
}
protected void createConfig(boolean indexingDryRun, ActionListener<T> listener) {
try {
List<String> categoricalFields = config.getCategoryFields();
if (categoricalFields != null && categoricalFields.size() > 0) {
validateAgainstExistingHCConfig(null, indexingDryRun, listener);
} else {
if (timeSeriesIndices.doesConfigIndexExist()) {
QueryBuilder query = QueryBuilders.matchAllQuery();
SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder().query(query).size(0).timeout(requestTimeout);
SearchRequest searchRequest = new SearchRequest(CommonName.CONFIG_INDEX).source(searchSourceBuilder);
client
.search(
searchRequest,
ActionListener
.wrap(
response -> onSearchTotalConfigResponse(response, indexingDryRun, listener),
exception -> listener.onFailure(exception)
)
);
} else {
searchConfigInputIndices(null, indexingDryRun, listener);
}
}
} catch (Exception e) {
listener.onFailure(e);
}
}
protected void onSearchTotalConfigResponse(SearchResponse response, boolean indexingDryRun, ActionListener<T> listener)
throws IOException {
if (response.getHits().getTotalHits().value >= getMaxSingleStreamConfigs()) {
String errorMsgSingleEntity = getExceedMaxSingleStreamConfigsErrorMsg(getMaxSingleStreamConfigs());
logger.error(errorMsgSingleEntity);
if (indexingDryRun) {
listener.onFailure(createValidationException(errorMsgSingleEntity, ValidationIssueType.GENERAL_SETTINGS));
return;
}
listener.onFailure(new IllegalArgumentException(errorMsgSingleEntity));
} else {
searchConfigInputIndices(null, indexingDryRun, listener);
}
}
protected void onSearchHCConfigResponse(SearchResponse response, String detectorId, boolean indexingDryRun, ActionListener<T> listener)
throws IOException {
if (response.getHits().getTotalHits().value >= getMaxHCConfigs()) {
String errorMsg = getExceedMaxHCConfigsErrorMsg(getMaxHCConfigs());
logger.error(errorMsg);
if (indexingDryRun) {
listener.onFailure(createValidationException(errorMsg, ValidationIssueType.GENERAL_SETTINGS));
return;
}
listener.onFailure(new IllegalArgumentException(errorMsg));
} else {
validateCategoricalFieldsInAllIndices(detectorId, indexingDryRun, listener);
}
}
protected void validateCategoricalFieldsInAllIndices(String configId, boolean indexingDryRun, ActionListener<T> listener) {
HashMap<String, List<String>> clusterIndicesMap = CrossClusterConfigUtils
.separateClusterIndexes(config.getIndices(), clusterService);
Iterator<Map.Entry<String, List<String>>> iterator = clusterIndicesMap.entrySet().iterator();
validateCategoricalField(iterator, configId, indexingDryRun, listener);
}
protected void validateCategoricalField(
Iterator<Map.Entry<String, List<String>>> iterator,
String configId,
boolean indexingDryRun,
ActionListener<T> listener
) {
if (!iterator.hasNext()) {
searchConfigInputIndices(configId, indexingDryRun, listener); // Call after all indices are validated
return;
}
// Get the next cluster indices entry
Map.Entry<String, List<String>> clusterIndicesEntry = iterator.next();
List<String> categoryField = config.getCategoryFields();
// categoryField should have at least 1 element. Otherwise, we won't reach here.
// we only support a certain number of categorical field
// If there is more fields than required, Config's constructor
// throws validation exception before reaching here
String categoryField0 = categoryField.get(0);
Client targetClusterClient = CrossClusterConfigUtils.getClientForCluster(clusterIndicesEntry.getKey(), client, clusterService);
// Create the GetFieldMappingsRequest for each index
GetFieldMappingsRequest getMappingsRequestForIndex = new GetFieldMappingsRequest();
getMappingsRequestForIndex
.indices(clusterIndicesEntry.getValue().toArray(new String[0]))
.fields(categoryField.toArray(new String[0]));
getMappingsRequestForIndex.indicesOptions(IndicesOptions.strictExpand());
// Define the listener for each getMapping request
ActionListener<GetFieldMappingsResponse> getMappingsListener = ActionListener.wrap(getMappingsResponse -> {
// example getMappingsResponse:
// GetFieldMappingsResponse{mappings={server-metrics={_doc={service=FieldMappingMetadata{fullName='service',
// source=org.opensearch.core.common.bytes.BytesArray@7ba87dbd}}}}}
// for nested field, it would be
// GetFieldMappingsResponse{mappings={server-metrics={_doc={host_nest.host2=FieldMappingMetadata{fullName='host_nest.host2',
// source=org.opensearch.core.common.bytes.BytesArray@8fb4de08}}}}}
boolean foundField = false;
// Review why the change from FieldMappingMetadata to GetFieldMappingsResponse.FieldMappingMetadata
Map<String, Map<String, GetFieldMappingsResponse.FieldMappingMetadata>> mappingsByIndex = getMappingsResponse.mappings();
for (Map<String, GetFieldMappingsResponse.FieldMappingMetadata> mappingsByField : mappingsByIndex.values()) {
for (Map.Entry<String, GetFieldMappingsResponse.FieldMappingMetadata> field2Metadata : mappingsByField.entrySet()) {
// example output:
// host_nest.host2=FieldMappingMetadata{fullName='host_nest.host2',
// source=org.opensearch.core.common.bytes.BytesArray@8fb4de08}
// Review why the change from FieldMappingMetadata to GetFieldMappingsResponse.FieldMappingMetadata
GetFieldMappingsResponse.FieldMappingMetadata fieldMetadata = field2Metadata.getValue();
if (fieldMetadata != null) {
// sourceAsMap returns sth like {host2={type=keyword}} with host2 being a nested field
Map<String, Object> fieldMap = fieldMetadata.sourceAsMap();
if (fieldMap != null) {
for (Object type : fieldMap.values()) {
if (type != null && type instanceof Map) {
foundField = true;
Map<String, Object> metadataMap = (Map<String, Object>) type;
String typeName = (String) metadataMap.get(CommonName.TYPE);
if (!typeName.equals(CommonName.KEYWORD_TYPE) && !typeName.equals(CommonName.IP_TYPE)) {
String error = String.format(Locale.ROOT, CATEGORICAL_FIELD_TYPE_ERR_MSG, field2Metadata.getKey());
listener.onFailure(createValidationException(error, ValidationIssueType.CATEGORY));
return;
}
}
}
}
}
}
}
if (foundField == false) {
listener
.onFailure(
createValidationException(
String
.format(
Locale.ROOT,
CATEGORY_NOT_FOUND_ERR_MSG,
categoryField0,
Arrays.toString(clusterIndicesEntry.getValue().toArray(new String[0]))
),
ValidationIssueType.CATEGORY
)
);
return;
}
validateCategoricalField(iterator, configId, indexingDryRun, listener);
}, error -> {
String message = String.format(Locale.ROOT, CommonMessages.FAIL_TO_GET_MAPPING_MSG, config.getIndices());
logger.error(message, error);
listener.onFailure(new IllegalArgumentException(message));
});
clientUtil
.executeWithInjectedSecurity(
GetFieldMappingsAction.INSTANCE,
getMappingsRequestForIndex,
user,
targetClusterClient,
context,
getMappingsListener
);
}
protected void searchConfigInputIndices(String configId, boolean indexingDryRun, ActionListener<T> listener) {
SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder()
.query(QueryBuilders.matchAllQuery())
.size(0)
.timeout(requestTimeout);
SearchRequest searchRequest = new SearchRequest(config.getIndices().toArray(new String[0])).source(searchSourceBuilder);
ActionListener<SearchResponse> searchResponseListener = ActionListener
.wrap(
searchResponse -> onSearchConfigInputIndicesResponse(searchResponse, configId, indexingDryRun, listener),
exception -> listener.onFailure(exception)
);
clientUtil.asyncRequestWithInjectedSecurity(searchRequest, client::search, user, client, context, searchResponseListener);
}
protected void onSearchConfigInputIndicesResponse(
SearchResponse response,
String configId,
boolean indexingDryRun,
ActionListener<T> listener
) throws IOException {
if (response.getHits().getTotalHits().value == 0) {
String errorMsg = getNoDocsInUserIndexErrorMsg(Arrays.toString(config.getIndices().toArray(new String[0])));
logger.error(errorMsg);
if (indexingDryRun) {
listener.onFailure(createValidationException(errorMsg, ValidationIssueType.INDICES));
return;
}
listener.onFailure(new IllegalArgumentException(errorMsg));
} else {
validateConfigFeatures(configId, indexingDryRun, listener);
}
}
protected void checkConfigNameExists(String configId, boolean indexingDryRun, ActionListener<T> listener) throws IOException {
if (timeSeriesIndices.doesConfigIndexExist()) {
BoolQueryBuilder boolQueryBuilder = new BoolQueryBuilder();
// src/main/resources/mappings/config.json#L14
boolQueryBuilder.must(QueryBuilders.termQuery("name.keyword", config.getName()));
if (StringUtils.isNotBlank(configId)) {
boolQueryBuilder.mustNot(QueryBuilders.termQuery(RestHandlerUtils._ID, configId));
}
SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder().query(boolQueryBuilder).timeout(requestTimeout);
SearchRequest searchRequest = new SearchRequest(CommonName.CONFIG_INDEX).source(searchSourceBuilder);
client
.search(
searchRequest,
ActionListener
.wrap(
searchResponse -> onSearchConfigNameResponse(searchResponse, config.getName(), indexingDryRun, listener),
exception -> listener.onFailure(exception)
)
);
} else {
tryIndexingConfig(indexingDryRun, listener);
}
}
protected void onSearchConfigNameResponse(SearchResponse response, String name, boolean indexingDryRun, ActionListener<T> listener)
throws IOException {
if (response.getHits().getTotalHits().value > 0) {
String errorMsg = getDuplicateConfigErrorMsg(name);
logger.warn(errorMsg);
if (indexingDryRun) {
listener.onFailure(createValidationException(errorMsg, ValidationIssueType.NAME));
} else {
listener.onFailure(new OpenSearchStatusException(errorMsg, RestStatus.CONFLICT));
}
} else {
tryIndexingConfig(indexingDryRun, listener);
}
}
protected void tryIndexingConfig(boolean indexingDryRun, ActionListener<T> listener) throws IOException {
if (!indexingDryRun) {
indexConfig(id, listener);
} else {
finishConfigValidationOrContinueToModelValidation(listener);
}
}
protected Set<ValidationAspect> getValidationTypes(String validationType) {
if (StringUtils.isBlank(validationType)) {
return getDefaultValidationType();
} else {
Set<String> typesInRequest = new HashSet<>(Arrays.asList(validationType.split(",")));
return ValidationAspect
.getNames(Sets.intersection(AbstractTimeSeriesActionHandler.ALL_VALIDATION_ASPECTS_STRS, typesInRequest));
}
}
protected void finishConfigValidationOrContinueToModelValidation(ActionListener<T> listener) {
logger.info("Skipping indexing detector. No blocking issue found so far.");
if (!getValidationTypes(validationType).contains(ValidationAspect.MODEL)) {
listener.onResponse(null);
} else {
validateModel(listener);
}
}
protected void indexConfig(String id, ActionListener<T> listener) throws IOException {
Config copiedConfig = copyConfig(user, config);
IndexRequest indexRequest = new IndexRequest(CommonName.CONFIG_INDEX)
.setRefreshPolicy(refreshPolicy)
.source(copiedConfig.toXContent(XContentFactory.jsonBuilder(), XCONTENT_WITH_TYPE))
.setIfSeqNo(seqNo)
.setIfPrimaryTerm(primaryTerm)
.timeout(requestTimeout);
if (StringUtils.isNotBlank(id)) {
indexRequest.id(id);