From b2b59aa01fff3052b4f188a2a7d7151c22fe74b6 Mon Sep 17 00:00:00 2001 From: David Z <38449481+dzane17@users.noreply.github.com> Date: Tue, 17 Oct 2023 10:33:30 -0700 Subject: [PATCH] phase_took documentation (#5154) * phase_took documentation Signed-off-by: David Zane * Update _api-reference/cluster-api/cluster-settings.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: David Z <38449481+dzane17@users.noreply.github.com> * Update _api-reference/search.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: David Z <38449481+dzane17@users.noreply.github.com> --------- Signed-off-by: David Zane Signed-off-by: David Z <38449481+dzane17@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --- _api-reference/cluster-api/cluster-settings.md | 1 + _api-reference/search.md | 1 + 2 files changed, 2 insertions(+) diff --git a/_api-reference/cluster-api/cluster-settings.md b/_api-reference/cluster-api/cluster-settings.md index f7333349f5..d433d1e322 100644 --- a/_api-reference/cluster-api/cluster-settings.md +++ b/_api-reference/cluster-api/cluster-settings.md @@ -74,6 +74,7 @@ The following request field parameters are compatible with the cluster API. | breaker.model_inference.limit | String | The limit for the trained model circuit breaker. Default is `50%` of the JVM heap. | | breaker.model_inference.overhead | Integer | The constant that all trained model estimations are multiplied by to determine a final estimation. Default is `1`. | | search.max_buckets | Integer | The maximum number of aggregation buckets allowed in a single response. Default is `65536`. | +| search.phase_took_enabled | Boolean | Enables returning phase-level `took` time values in search responses. Default is `false`. | | snapshot.max_concurrent_operations | Integer | The maximum number of concurrent snapshot operations. Default is `1000`. | | slm.health.failed_snapshot_warn_threshold | String | The number of failed invocations since the last successful snapshot that will indicate a problem as per the health API profile. Default is five repeated failures: `5L`. | | indices.breaker.total.limit | String | The starting limit for the overall parent breaker. Default is `70%` of the JVM heap if `indices.breaker.total.use_real_memory` is set to `false`. Default is `95%` of the JVM heap if `indices.breaker.total.use_real_memory` is set to `true`. | diff --git a/_api-reference/search.md b/_api-reference/search.md index 215e77c7fe..1e55e64b98 100644 --- a/_api-reference/search.md +++ b/_api-reference/search.md @@ -59,6 +59,7 @@ ignore_throttled | Boolean | Whether to ignore concrete, expanded, or indexes wi ignore_unavailable | Boolean | Specifies whether to include missing or closed indexes in the response. Default is false. lenient | Boolean | Specifies whether OpenSearch should accept requests if queries have format errors (for example, querying a text field for an integer). Default is false. max_concurrent_shard_requests | Integer | How many concurrent shard requests this request should execute on each node. Default is 5. +phase_took | Boolean | Whether to return phase-level `took` time values in the response. Default is false. pre_filter_shard_size | Integer | A prefilter size threshold that triggers a prefilter operation if the request exceeds the threshold. Default is 128 shards. preference | String | Specifies the shards or nodes on which OpenSearch should perform the search. For valid values, see [The `preference` query parameter](#the-preference-query-parameter). q | String | Lucene query string’s query.