Skip to content

Commit 0d2f9a2

Browse files
Add additional details to search backpressure stats (#11982) (#12085)
1 parent 71d11c3 commit 0d2f9a2

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

_tuning-your-cluster/availability-and-recovery/search-backpressure.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -223,12 +223,12 @@ The response contains the following fields.
223223
Field Name | Data type | Description
224224
:--- | :--- | :---
225225
search_backpressure | Object | Statistics about search backpressure.
226-
search_backpressure.search_task | Object | Statistics specific to the search task.
227-
search_backpressure.search_task.[resource_tracker_stats](#resource_tracker_stats) | Object | Statistics about the current search tasks.
228-
search_backpressure.search_task.[cancellation_stats](#cancellation_stats) | Object | Statistics about the search tasks canceled since the node last restarted.
229-
search_backpressure.search_shard_task | Object | Statistics specific to the search shard task.
230-
search_backpressure.search_shard_task.[resource_tracker_stats](#resource_tracker_stats) | Object | Statistics about the current search shard tasks.
231-
search_backpressure.search_shard_task.[cancellation_stats](#cancellation_stats) | Object | Statistics about the search shard tasks canceled since the node last restarted.
226+
search_backpressure.search_task | Object | Statistics for search tasks. Contains resource tracker statistics for individual cancellation criteria (heap, CPU, elapsed time) and a summary of all cancellation activity across these trackers.
227+
search_backpressure.search_task.[resource_tracker_stats](#resource_tracker_stats) | Object | Per-tracker statistics showing cancellation counts for each resource type (heap usage, CPU usage, elapsed time) and current resource consumption metrics.
228+
search_backpressure.search_task.[cancellation_stats](#cancellation_stats) | Object | Aggregated cancellation statistics across all resource trackers. The sum of `cancellation_count` and `cancellation_limit_reached_count` equals the total of all resource tracker cancellation counts.
229+
search_backpressure.search_shard_task | Object | Statistics for search shard tasks. Contains resource tracker statistics for individual cancellation criteria (heap, CPU, elapsed time) and a summary of all cancellation activity across these trackers.
230+
search_backpressure.search_shard_task.[resource_tracker_stats](#resource_tracker_stats) | Object | Per-tracker statistics showing cancellation counts for each resource type (heap usage, CPU usage, elapsed time) and current resource consumption metrics.
231+
search_backpressure.search_shard_task.[cancellation_stats](#cancellation_stats) | Object | Aggregated cancellation statistics across all resource trackers. The sum of `cancellation_count` and `cancellation_limit_reached_count` equals the total of all resource tracker cancellation counts.
232232
search_backpressure.mode | String | The [mode](#search-backpressure-modes) for search backpressure.
233233

234234
### `resource_tracker_stats`
@@ -274,3 +274,6 @@ Field Name | Data type | Description
274274
:--- | :--- | :---
275275
cancellation_count | Integer | The total number of tasks marked for cancellation since the node last restarted.
276276
cancellation_limit_reached_count | Integer | The number of times when the number of tasks eligible for cancellation exceeded the set cancellation threshold.
277+
278+
Each resource tracker (heap, CPU, elapsed time) independently identifies tasks that breach its thresholds and increments its own `cancellation_count`. Since a single task may breach multiple resource thresholds, the sum of resource tracker `cancellation_count` values may exceed the top-level `cancellation_count`, which represents the actual number of unique tasks that were cancelled. The `cancellation_limit_reached_count` increments when the cancellation rate limit is reached during an observer iteration, preventing additional cancellations in that iteration.
279+
{: .note}

0 commit comments

Comments
 (0)