Skip to content

Show heap percent threshold in cancellation message #20779

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jainankitk merged 1 commit into from
Mar 5, 2026
+4 −7
Merged

Show heap percent threshold in cancellation message #20779

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
- Fallback to netty client if AWS Crt client is not available on the target platform / architecture ([#20698](https://github.com/opensearch-project/OpenSearch/pull/20698))
- Fix ShardSearchFailure in transport-grpc ([#20641](https://github.com/opensearch-project/OpenSearch/pull/20641))
- Fix TLS cert hot-reload for Arrow Flight transport ([#20732](https://github.com/opensearch-project/OpenSearch/pull/20732))
- Fix misleading heap usage cancellation message in SearchBackpressureService ([#20779](https://github.com/opensearch-project/OpenSearch/pull/20779))

### Dependencies
- Bump shadow-gradle-plugin from 8.3.9 to 9.3.1 ([#20569](https://github.com/opensearch-project/OpenSearch/pull/20569))
Expand Down
6 changes: 1 addition & 5 deletions server/src/main/java/org/opensearch/search/backpressure/trackers/HeapUsageTracker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,7 @@ private void setDefaultResourceUsageBreachEvaluator() {

return Optional.of(
new TaskCancellation.Reason(
"heap usage exceeded ["
+ new ByteSizeValue((long) currentUsage)
+ " >= "
+ new ByteSizeValue((long) allowedUsage)
+ "]",
"heap usage exceeded [" + new ByteSizeValue((long) currentUsage) + " >= " + new ByteSizeValue((long) threshold) + "]",
(int) (currentUsage / averageUsage) // TODO: fine-tune the cancellation score/weight
)
);
Expand Down
4 changes: 2 additions & 2 deletions server/src/test/java/org/opensearch/search/backpressure/trackers/HeapUsageTrackerTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ public void testSearchTaskEligibleForCancellation() {
Optional<TaskCancellation.Reason> reason = tracker.checkAndMaybeGetCancellationReason(task);
assertTrue(reason.isPresent());
assertEquals(6, reason.get().getCancellationScore());
assertEquals("heap usage exceeded [300b >= 150b]", reason.get().getMessage());
assertEquals("heap usage exceeded [300b >= 0b]", reason.get().getMessage());
}

public void testSearchShardTaskEligibleForCancellation() {
Expand Down Expand Up @@ -100,7 +100,7 @@ public void testSearchShardTaskEligibleForCancellation() {
Optional<TaskCancellation.Reason> reason = tracker.checkAndMaybeGetCancellationReason(task);
assertTrue(reason.isPresent());
assertEquals(4, reason.get().getCancellationScore());
assertEquals("heap usage exceeded [200b >= 100b]", reason.get().getMessage());
assertEquals("heap usage exceeded [200b >= 0b]", reason.get().getMessage());
}

public void testNotEligibleForCancellation() {
Expand Down
Loading