Skip to content

Commit 2ef6964

Browse files
authored
Add back changes from PR 6362 to concurrent segment search (#6416)
Signed-off-by: Fanit Kolchina <[email protected]>
1 parent ad2e88a commit 2ef6964

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

_search-plugins/concurrent-segment-search.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,15 +77,31 @@ The `search.concurrent.max_slice_count` setting can take the following valid val
7777
- `0`: Use the default Lucene mechanism.
7878
- Positive integer: Use the max target slice count mechanism. Usually, a value between 2 and 8 should be sufficient.
7979

80+
## Limitations
81+
82+
The following aggregations do not support the concurrent search model. If a search request contains one of these aggregations, the request will be executed using the non-concurrent path even if concurrent segment search is enabled at the cluster level or index level.
83+
- Parent aggregations on [join]({{site.url}}{{site.baseurl}}/field-types/supported-field-types/join/) fields. See [this GitHub issue](https://github.com/opensearch-project/OpenSearch/issues/9316) for more information.
84+
- `sampler` and `diversified_sampler` aggregations. See [this GitHub issue](https://github.com/opensearch-project/OpenSearch/issues/110750) for more information.
85+
86+
## Other considerations
87+
88+
The following sections provide additional considerations for concurrent segment search.
89+
8090
### The `terminate_after` search parameter
8191

8292
The [`terminate_after` search parameter]({{site.url}}{{site.baseurl}}/api-reference/search/#url-parameters) is used to terminate a search request once a specified number of documents has been collected. If you include the `terminate_after` parameter in a request, concurrent segment search is disabled and the request is run in a non-concurrent manner.
8393

8494
Typically, queries are used with smaller `terminate_after` values and thus complete quickly because the search is performed on a reduced dataset. Therefore, concurrent search may not further improve performance in this case. Moreover, when `terminate_after` is used with other search request parameters, such as `track_total_hits` or `size`, it adds complexity and changes the expected query behavior. Falling back to a non-concurrent path for search requests that include `terminate_after` ensures consistent results between concurrent and non-concurrent requests.
8595

86-
## Limitations
96+
### Sorting
97+
98+
Depending on the data layout of the segments, the sort optimization feature can prune entire segments based on the min and max values as well as previously collected values. If the top values are present in the first few segments and all other segments are pruned, query latency may increase when sorting with concurrent segment search. Conversely, if the last few segments contain the top values, then latency may improve with concurrent segment search.
99+
100+
### Terms aggregations
101+
102+
Non-concurrent search calculates the document count error and returns it in the `doc_count_error_upper_bound` response parameter. During concurrent segment search, the `shard_size` parameter is applied at the segment slice level. Because of this, concurrent search may introduce an additional document count error.
87103

88-
Parent aggregations on [join]({{site.url}}{{site.baseurl}}/field-types/supported-field-types/join/) fields do not support the concurrent search model. Thus, if a search request contains a parent aggregation, the aggregation will be executed using the non-concurrent path even if concurrent segment search is enabled at the cluster level.
104+
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).
89105

90106
## Developer information: AggregatorFactory changes
91107

0 commit comments

Comments
 (0)