Add warning related to ad and concurrent segment search (opensearch-p…

…roject#6411) * Add warning related to ad and concurrent segment search Signed-off-by: Jay Deng <[email protected]> * Update _search-plugins/concurrent-segment-search.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Jay Deng <[email protected]> * Update _search-plugins/concurrent-segment-search.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: Jay Deng <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
oeyh · Mar 14, 2024 · 1b4fb65 · 1b4fb65
1 parent 8908739
commit 1b4fb65
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/_search-plugins/concurrent-segment-search.md b/_search-plugins/concurrent-segment-search.md
@@ -103,6 +103,10 @@ Non-concurrent search calculates the document count error and returns it in the
 
 For more information about how `shard_size` can affect both `doc_count_error_upper_bound` and collected buckets, see [this GitHub issue](https://github.com/opensearch-project/OpenSearch/issues/11680#issuecomment-1885882985).
 
+The [Anomaly Detection](https://opensearch.org/docs/latest/observing-your-data/ad/index/) plugin is not compatible with concurrent segment search. To use concurrent segment search with the Anomaly Detection plugin, disable concurrent segment search for the anomaly detection result indexes by applying the index-level setting. By default, the result indexes are specified by the `.opendistro-anomaly-results` alias. See [this GitHub issue](https://github.com/opensearch-project/OpenSearch/issues/12331) for more information.
+{: .warning}
+
+
 ## Developer information: AggregatorFactory changes
 
 Because of implementation details, not all aggregator types can support concurrent segment search. To accommodate this, we have introduced a [`supportsConcurrentSegmentSearch()`](https://github.com/opensearch-project/OpenSearch/blob/bb38ed4836496ac70258c2472668325a012ea3ed/server/src/main/java/org/opensearch/search/aggregations/AggregatorFactory.java#L121) method in the `AggregatorFactory` class to indicate whether a given aggregation type supports concurrent segment search. By default, this method returns `false`. Any aggregator that needs to support concurrent segment search must override this method in its own factory implementation.