From f7bba7121e01d75fbc92770182e0461e6f420c8e Mon Sep 17 00:00:00 2001 From: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Date: Wed, 22 Feb 2023 10:58:40 -0500 Subject: [PATCH] Changed format and link of search backpressure (#3023) Signed-off-by: Fanit Kolchina --- .../search-backpressure.md | 36 +++++++++---------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/_tuning-your-cluster/availability-and-recovery/search-backpressure.md b/_tuning-your-cluster/availability-and-recovery/search-backpressure.md index 05f8d461..38ead834 100644 --- a/_tuning-your-cluster/availability-and-recovery/search-backpressure.md +++ b/_tuning-your-cluster/availability-and-recovery/search-backpressure.md @@ -80,26 +80,26 @@ Search backpressure adds several settings to the standard OpenSearch cluster set Setting | Default | Description :--- | :--- | :--- -search_backpressure.
    mode | `monitor_only` | The search backpressure [mode](#search-backpressure-modes). Valid values are `monitor_only`, `enforced`, or `disabled`. -search_backpressure.
    interval_millis | 1,000 ms | The interval at which the observer thread measures the resource usage and cancels tasks. -search_backpressure.
    cancellation_ratio | 10% | The maximum number of tasks to cancel, as a percentage of successful task completions. -search_backpressure.
    cancellation_rate | 0.003 | The maximum number of tasks to cancel per millisecond of elapsed time. -search_backpressure.
    cancellation_burst | 10 | The maximum number of tasks to cancel in a single iteration of the observer thread. -search_backpressure.
    node_duress.
        num_successive_breaches | 3 | The number of successive limit breaches after which the node is considered to be under duress. -search_backpressure.
    node_duress.
        cpu_threshold | 90% | The CPU usage threshold (as a percentage) required for a node to be considered to be under duress. -search_backpressure.
    node_duress.
        heap_threshold | 70% | The heap usage threshold (as a percentage) required for a node to be considered to be under duress. -search_backpressure.
    search_shard_task.
        total_heap_percent_threshold | 5% | The heap usage threshold (as a percentage) required for the sum of heap usages of all search shard tasks before cancellation is applied. -search_backpressure.
    search_shard_task.
        heap_percent_threshold | 0.5% | The heap usage threshold (as a percentage) required for a single search shard task before it is considered for cancellation. -search_backpressure.
    search_shard_task.
        heap_variance | 2.0 | The minimum variance required for a single search shard task's heap usage compared to the rolling average of previously completed tasks before it is considered for cancellation. -search_backpressure.
    search_shard_task.
        heap_moving_average_window_size | 100 | The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage. -search_backpressure.
    search_shard_task.
        cpu_time_millis_threshold | 15,000 ms | The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. -search_backpressure.
    search_shard_task.
        elapsed_time_millis_threshold | 30,000 ms | The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. +search_backpressure.mode | `monitor_only` | The search backpressure [mode](#search-backpressure-modes). Valid values are `monitor_only`, `enforced`, or `disabled`. +search_backpressure.interval_millis | 1,000 ms | The interval at which the observer thread measures the resource usage and cancels tasks. +search_backpressure.cancellation_ratio | 10% | The maximum number of tasks to cancel, as a percentage of successful task completions. +search_backpressure.cancellation_rate | 0.003 | The maximum number of tasks to cancel per millisecond of elapsed time. +search_backpressure.cancellation_burst | 10 | The maximum number of tasks to cancel in a single iteration of the observer thread. +search_backpressure.node_duress.num_successive_breaches | 3 | The number of successive limit breaches after which the node is considered under duress. +search_backpressure.node_duress.cpu_threshold | 90% | The CPU usage threshold (as a percentage) required for a node to be considered under duress. +search_backpressure.node_duress.heap_threshold | 70% | The heap usage threshold (as a percentage) required for a node to be considered under duress. +search_backpressure.search_shard_task.total_heap_percent_threshold | 5% | The heap usage threshold (as a percentage) required for the sum of heap usages of all search shard tasks before cancellation is applied. +search_backpressure.search_shard_task.heap_percent_threshold | 0.5% | The heap usage threshold (as a percentage) required for a single search shard task before it is considered for cancellation. +search_backpressure.search_shard_task.heap_variance | 2.0 | The minimum variance required for a single search shard task's heap usage compared to the rolling average of previously completed tasks before it is considered for cancellation. +search_backpressure.search_shard_task.heap_moving_average_window_size | 100 | The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage. +search_backpressure.search_shard_task.cpu_time_millis_threshold | 15,000 ms | The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. +search_backpressure.search_shard_task.elapsed_time_millis_threshold | 30,000 ms | The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. ## Search Backpressure Stats API Introduced 2.4 {: .label .label-purple } -You can use the [nodes stats API operation]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/text-analyzers/#how-to-use-text-analyzers) to monitor server-side request cancellations. +You can use the [nodes stats API operation]({{site.url}}{{site.baseurl}}/api-reference/nodes-apis/nodes-stats) to monitor server-side request cancellations. #### Example request @@ -174,9 +174,9 @@ The response contains the following fields. Field Name | Data type | Description :--- | :--- | :--- search_backpressure | Object | Statistics about search backpressure. -search_backpressure.
    search_shard_task | Object | Statistics specific to the search shard task. -search_backpressure.
    search_shard_task.
    [resource_tracker_stats](#resource_tracker_stats) | Object | Statistics about the current tasks. -search_backpressure.
    search_shard_task.
    [calcellation_stats](#cancellation_stats) | Object | Statistics about the tasks canceled since the node last restarted. +search_backpressure.search_shard_task | Object | Statistics specific to the search shard task. +search_backpressure.search_shard_task.[resource_tracker_stats](#resource_tracker_stats) | Object | Statistics about the current tasks. +search_backpressure.search_shard_task.[cancellation_stats](#cancellation_stats) | Object | Statistics about the tasks canceled since the node last restarted. search_backpressure.mode | String | The [mode](#search-backpressure-modes) for search backpressure. ### `resource_tracker_stats`