[Enhancement] Extend 'show usage resource groups;' with mem_pool metrics #66690

arin-mirza · 2025-12-12T16:09:08Z

Why I'm doing:

The mem_pool property for resource groups was recently introduced. See related pull requests below:

Currently, there is no way to display the usage metrics of the memory pools.

What I'm doing:

This pull request extends the result of show usage resource groups; command with the following:

Column	Description
Id
Backend
BEInUseCpuCores
BEInUseMemBytes
BERunningQueries
+ BEMemLimitBytes	Memory limit of the resource group.
+ BEMemPool	Name of the memory pool the resource group belongs to.
+ BEMemPoolInUseMemBytes	Current total memory usage of the mem_pool.
+ BEMemPoolMemLimitBytes	Specified memory limit of the mem_pool.

The current implementation of memory pools requires configuring the memory limit of all resource groups (BEMemLimitBytes) under the same memory pool to the same value. This value also corresponds to the memory limit of the memory pool (BEMemPoolMemLimitBytes). The displayed values in these two columns will coincide due to this restriction, but it might change in the future.
The value of BEMemPoolInUseMemBytes is the sum of memory usages of each resource group that belongs to that memory pool. See the screenshots below for an example scenario.

Notes/Discussion

If two workgroups with the same id but different versions exist at the same time, the metrics to be reported for memory pools must belong to the latest version of that workgroup. This necessitates knowing which group_version a TResourceGroupUsage object belongs to. I tried two different approaches:
- In resorce_group_usage_recorder.cpp, I added an auxillary VersionedResourceGroupUsage struct which had a group_version and a TResourceGroupUsage object as a pair. This solution worked, but it is just too messy for something as simple as this. See b9c4141
(Preferred) I added a group_version field to the ResourceUsage.thrift file and directly use it. This is much cleaner. See bba2165
- The group_version is only used by resorce_group_usage_recorder.cpp in the backend, and is not read from the thrift file on the front end side.

Demo

Fixes #issue

What type of PR is this:

Does this PR entail a change in behavior?

Yes, this PR will result in a change in behavior.
No, this PR will not result in a change in behavior.

If yes, please specify the type of change:

Interface/UI changes: syntax, type conversion, expression evaluation, display information
Parameter changes: default values, similar parameters but with different default values
Policy changes: use new policy to replace old one, functionality automatically enabled
Feature removed
Miscellaneous: upgrade & downgrade compatibility, etc.

Checklist:

I have added test cases for my bug fix or my new feature
This pr needs user documentation (for new or modified features or behaviors)
- I have added documentation for my new feature or new function
This is a backport pr

Bugfix cherry-pick branch check:

Note

Enhances resource group usage reporting with memory‑pool metrics end-to-end.

FE: Extends SHOW USAGE RESOURCE GROUPS with BEMemLimitBytes, BEMemPool, BEMemPoolInUseMemBytes, BEMemPoolMemLimitBytes; updates metadata, rendering, and tests
BE: ResourceGroupUsageRecorder now includes group_version, mem_limit_bytes, mem_pool, and mem‑pool limit/usage; merges per‑group stats preferring latest group_version
BE: WorkGroup exposes parent memory limit/usage helpers used for mem‑pool values
FE runtime: ComputeNode.ResourceGroupUsage extended to carry new fields and map from thrift
Thrift: adds fields to TResourceGroupUsage for mem limits/pool and group_version

^{Written by Cursor Bugbot for commit a07cc5e. This will update automatically on new commits. Configure here.}

mergify · 2025-12-12T16:09:36Z

🧪 CI Insights

Here's what we observed from your CI run for b9c4141.

🟢 All jobs passed!

But CI Insights is watching 👀

alvin-celerdata · 2025-12-12T17:02:21Z

@cursor review

be/src/agent/resource_group_usage_recorder.cpp

fe/fe-core/src/main/java/com/starrocks/system/ComputeNode.java

alvin-celerdata · 2025-12-14T17:57:20Z

@cursor review

cursor

Bug: Test assertions missing new columns in expected output

The test assertions at lines 1592-1602 and 1620-1624 expect the old output format with only 6 columns, but the code now produces 10 columns per row (including BEMemLimitBytes, BEMemPool, BEMemPoolInUseMemBytes, and BEMemPoolMemLimitBytes). The header assertion at lines 1562-1563 was correctly updated to include the new columns, but the data row assertions still expect the old format. These tests will fail because the actual output contains 4 additional column values that are not included in the expected strings.

fe/fe-core/src/test/java/com/starrocks/qe/scheduler/QueryQueueManagerTest.java#L1591-L1602

starrocks/fe/fe-core/src/test/java/com/starrocks/qe/scheduler/QueryQueueManagerTest.java

Lines 1591 to 1602 in 4f1d12a

    
           String res = starRocksAssert.executeShowResourceUsageSql("SHOW USAGE RESOURCE GROUPS;"); 
        
           assertThat(res).isEqualTo("Name|Id|Backend|BEInUseCpuCores|BEInUseMemBytes|BERunningQueries\n" + 
        
                   "default_wg|2|be0-host|3.112|39|38\n" + 
        
                   "default_mv_wg|3|be1-host|4.11|49|48\n" + 
        
                   "wg0|10|be0-host|0.112|9|8\n" + 
        
                   "wg0|10|be1-host|1.11|19|18\n" + 
        
                   "wg1|11|be0-host|0.1|0|0\n" + 
        
                   "wg1|11|be1-host|1.1|0|0\n" + 
        
                   "wg2|12|be0-host|0.12|7|6\n" + 
        
                   "wg2|12|be1-host|1.12|17|16\n" + 
        
                   "wg3|13|be0-host|0.03|0|0\n" + 
        
                   "wg3|13|be1-host|0.13|0|0");

fe/fe-core/src/test/java/com/starrocks/qe/scheduler/QueryQueueManagerTest.java#L1619-L1624

starrocks/fe/fe-core/src/test/java/com/starrocks/qe/scheduler/QueryQueueManagerTest.java

Lines 1619 to 1624 in 4f1d12a

    
           String res = starRocksAssert.executeShowResourceUsageSql("SHOW USAGE RESOURCE GROUPS;"); 
        
           assertThat(res).isEqualTo("Name|Id|Backend|BEInUseCpuCores|BEInUseMemBytes|BERunningQueries\n" + 
        
                   "wg0|10|be0-host|0.21|29|28\n" + 
        
                   "wg1|11|be0-host|0.2|0|0\n" + 
        
                   "wg2|12|be1-host|1.22|27|26\n" + 
        
                   "wg3|13|be1-host|0.23|0|0");

arin-mirza · 2025-12-16T16:56:41Z

I adjusted the test case testShowResourceGroupUsage properly in 9fc7afa and fixed the clang formatting issue in 4708184

alvin-celerdata · 2025-12-16T17:32:53Z

@cursor review

fe/fe-core/src/main/java/com/starrocks/system/ComputeNode.java

be/src/agent/resource_group_usage_recorder.cpp

arin-mirza · 2025-12-19T19:38:48Z

The failing CI PIPELINE / FE UT check is due to testShowResourceGroupUsage test failing with:

2025-12-19T18:29:56.5650451Z [�[1;34mINFO�[m] 
2025-12-19T18:29:56.5650846Z [�[1;34mINFO�[m] Results:
2025-12-19T18:29:56.5651234Z [�[1;34mINFO�[m] 
2025-12-19T18:29:56.5651646Z [�[1;31mERROR�[m] �[1;31mFailures: �[m
2025-12-19T18:29:56.5652459Z [�[1;31mERROR�[m] �[1;31m  QueryQueueManagerTest.testShowResourceGroupUsage:1562 
2025-12-19T18:29:56.5653107Z expected: 
2025-12-19T18:29:56.5654336Z   "Name|Id|Backend|BEInUseCpuCores|BEInUseMemBytes|BERunningQueries|BEMemLimitBytes|BEMemPool|BEMemPoolInUseMemBytes|BEMemPoolMemLimitBytes
2025-12-19T18:29:56.5655474Z   "
2025-12-19T18:29:56.5655750Z  but was: 
2025-12-19T18:29:56.5656196Z   "Name|Id|Backend|BEInUseCpuCores|BEInUseMemBytes|BERunningQueries
2025-12-19T18:29:56.5656801Z   "�[m
2025-12-19T18:29:56.5657137Z [�[1;34mINFO�[m] 
2025-12-19T18:29:56.5657866Z [�[1;31mERROR�[m] �[1;31mTests run: 14661, Failures: 1, Errors: 0, Skipped: 81�[m
2025-12-19T18:29:56.5658570Z [�[1;34mINFO�[m]

This is very interesting, because this test passes for me locally, and I can see the new columns when executing show usage resource groups; on locally built starrocks fe/be instances, which is how I took the screenshots in the PR description.

The columns in the fe response are also clearly being extended in ShowResourceGroupUsageStmt.java.

Any idea why the CI run might not be getting the expected result?

alvin-celerdata · 2025-12-19T21:59:59Z

@cursor review

cursor

✅ Bugbot reviewed your changes and found no bugs!

alvin-celerdata · 2025-12-27T18:51:19Z

@mergify rebase

mergify · 2025-12-27T18:51:47Z

rebase

✅ Branch has been successfully rebased

alvin-celerdata · 2025-12-27T22:29:52Z

@arin-mirza
Could you fix the failed FE UT? After this passes, I will merge it.

cursor

✅ Bugbot reviewed your changes and found no bugs!

arin-mirza · 2025-12-30T20:05:44Z

Regarding the failing BE UT check

FAILED TESTS (2/2145):
   37396 ms: /root/starrocks/be/ut_build_Release/test/starrocks_dw_test LakePrimaryKeyConsistencyTest/LakePrimaryKeyConsistencyTest.test_local_pk_consistency/0
   36347 ms: /root/starrocks/be/ut_build_Release/test/starrocks_dw_test LakePrimaryKeyConsistencyTest/LakePrimaryKeyConsistencyTest.test_random_seed_pk_consistency/0

Seems unrelated. Flaky?

github-actions · 2025-12-30T21:10:13Z

[FE Incremental Coverage Report]

✅ pass : 24 / 24 (100.00%)

file detail

	path	covered_line	new_line	coverage	not_covered_line_detail
🔵	com/starrocks/sql/ast/ShowResourceGroupUsageStmt.java	9	9	100.00%	[]
🔵	com/starrocks/qe/ShowResultMetaFactory.java	4	4	100.00%	[]
🔵	com/starrocks/system/ComputeNode.java	11	11	100.00%	[]

alvin-celerdata · 2025-12-31T15:04:55Z

@mergify rebase

…age metrics Signed-off-by: arin-mirza <a.mirza@celonis.com>

Signed-off-by: arin-mirza <a.mirza@celonis.com>

…olumns Signed-off-by: arin-mirza <a.mirza@celonis.com>

Signed-off-by: arin-mirza <a.mirza@celonis.com>

mergify · 2025-12-31T15:05:40Z

rebase

✅ Branch has been successfully rebased

sonarqubecloud · 2025-12-31T15:15:44Z

Quality Gate passed

Issues
7 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

github-actions · 2025-12-31T17:28:13Z

[Java-Extensions Incremental Coverage Report]

✅ pass : 0 / 0 (0%)

github-actions · 2025-12-31T17:34:13Z

@Mergifyio backport branch-4.0

mergify · 2025-12-31T17:34:41Z

backport branch-4.0

✅ Backports have been created

Details

#67412 [Enhancement] Extend 'show usage resource groups;' with mem_pool metrics (backport #66690) has been created for branch branch-4.0 but encountered conflicts

…ics (#66690) Signed-off-by: arin-mirza <a.mirza@celonis.com> (cherry picked from commit f4a8df5) # Conflicts: # fe/fe-core/src/main/java/com/starrocks/qe/ShowResultMetaFactory.java # fe/fe-core/src/main/java/com/starrocks/sql/ast/ShowResourceGroupUsageStmt.java

github-actions · 2025-12-31T17:45:28Z

[BE Incremental Coverage Report]

❌ fail : 13 / 18 (72.22%)

file detail

	path	covered_line	new_line	coverage	not_covered_line_detail
🔵	be/src/agent/resource_group_usage_recorder.cpp	6	11	54.55%	[55, 56, 57, 58, 59]
🔵	be/src/exec/workgroup/work_group.h	7	7	100.00%	[]

…ics (StarRocks#66690) Signed-off-by: arin-mirza <a.mirza@celonis.com> Signed-off-by: Farhad Shahmohammadi <f.shahmohammadi@celonis.com>

…ics (StarRocks#66690) Signed-off-by: arin-mirza <a.mirza@celonis.com>

arin-mirza requested review from a team as code owners December 12, 2025 16:09

github-actions bot added the behavior_changed label Dec 12, 2025

wanpengfei-git added the PROTO-REVIEW label Dec 12, 2025

wanpengfei-git requested a review from a team December 12, 2025 16:09

mergify bot assigned arin-mirza Dec 12, 2025

github-actions bot added the 4.0 label Dec 12, 2025

arin-mirza force-pushed the extend-show-usage-resource-groups-with-mem-pool-metrics branch from bf65e1c to b9c4141 Compare December 12, 2025 16:28

cursor bot reviewed Dec 12, 2025

View reviewed changes

be/src/agent/resource_group_usage_recorder.cpp Show resolved Hide resolved

stephen-shelby reviewed Dec 14, 2025

View reviewed changes

fe/fe-core/src/main/java/com/starrocks/system/ComputeNode.java Show resolved Hide resolved

cursor bot reviewed Dec 14, 2025

View reviewed changes

arin-mirza requested a review from stephen-shelby December 16, 2025 16:57

cursor bot reviewed Dec 16, 2025

View reviewed changes

fe/fe-core/src/main/java/com/starrocks/system/ComputeNode.java Show resolved Hide resolved

be/src/agent/resource_group_usage_recorder.cpp Show resolved Hide resolved

cursor bot reviewed Dec 19, 2025

View reviewed changes

murphyatwork previously approved these changes Dec 25, 2025

View reviewed changes

HangyuanLiu previously approved these changes Dec 25, 2025

View reviewed changes

satanson previously approved these changes Dec 25, 2025

View reviewed changes

alvin-celerdata force-pushed the extend-show-usage-resource-groups-with-mem-pool-metrics branch from 080a7ca to c1421a2 Compare December 27, 2025 18:51

alvin-celerdata previously approved these changes Dec 27, 2025

View reviewed changes

cursor bot reviewed Dec 30, 2025

View reviewed changes

arin-mirza added 11 commits December 31, 2025 15:05

Extend result of 'show usage resource groups;' to include mem_pool us…

83ec1ea

…age metrics Signed-off-by: arin-mirza <a.mirza@celonis.com>

Add update mem_limit_bytes

bb7a488

Signed-off-by: arin-mirza <a.mirza@celonis.com>

Add group_version to thrift file and use it directly

9b6115f

Signed-off-by: arin-mirza <a.mirza@celonis.com>

Set group_version correctly

6770289

Signed-off-by: arin-mirza <a.mirza@celonis.com>

Fix format

1f7060e

Signed-off-by: arin-mirza <a.mirza@celonis.com>

Adjust test cases

9cbc124

Signed-off-by: arin-mirza <a.mirza@celonis.com>

Fix clang-format

5d432bb

Signed-off-by: arin-mirza <a.mirza@celonis.com>

Set mem_{limit, used}_bytes) values unconditionally using .value_or(0)

642f1a5

Signed-off-by: arin-mirza <a.mirza@celonis.com>

Extend 'test_get_resource_group_usages' with mem_pool related fields

6b67549

Signed-off-by: arin-mirza <a.mirza@celonis.com>

Extend visitShowResourceGroupUsageStatement with the mem_pool usage c…

23e97f2

…olumns Signed-off-by: arin-mirza <a.mirza@celonis.com>

Adjust testShowResourceGroupUsageStmt to include mem_pool usage columns

a07cc5e

Signed-off-by: arin-mirza <a.mirza@celonis.com>

alvin-celerdata force-pushed the extend-show-usage-resource-groups-with-mem-pool-metrics branch from 8e750b3 to a07cc5e Compare December 31, 2025 15:05

alvin-celerdata merged commit f4a8df5 into StarRocks:main Dec 31, 2025
59 of 62 checks passed

github-actions bot removed the 4.0 label Dec 31, 2025

mergify bot mentioned this pull request Dec 31, 2025

[Enhancement] Extend 'show usage resource groups;' with mem_pool metrics (backport #66690) #67412

Closed

23 tasks

eshishki mentioned this pull request Jan 5, 2026

[BugFix] test isolation workgroup manager #67489

Open

24 tasks

arin-mirza mentioned this pull request Jan 9, 2026

[Enhancement] Add mem_pool_use_ratio metric to be #67701

Closed

25 tasks

farhad-celo pushed a commit to farhad-celo/starrocks that referenced this pull request Jan 22, 2026

[Enhancement] Extend 'show usage resource groups;' with mem_pool metr…

ad5ece6

…ics (StarRocks#66690) Signed-off-by: arin-mirza <a.mirza@celonis.com>

	String res = starRocksAssert.executeShowResourceUsageSql("SHOW USAGE RESOURCE GROUPS;");
	assertThat(res).isEqualTo("Name\|Id\|Backend\|BEInUseCpuCores\|BEInUseMemBytes\|BERunningQueries\n" +
	"default_wg\|2\|be0-host\|3.112\|39\|38\n" +
	"default_mv_wg\|3\|be1-host\|4.11\|49\|48\n" +
	"wg0\|10\|be0-host\|0.112\|9\|8\n" +
	"wg0\|10\|be1-host\|1.11\|19\|18\n" +
	"wg1\|11\|be0-host\|0.1\|0\|0\n" +
	"wg1\|11\|be1-host\|1.1\|0\|0\n" +
	"wg2\|12\|be0-host\|0.12\|7\|6\n" +
	"wg2\|12\|be1-host\|1.12\|17\|16\n" +
	"wg3\|13\|be0-host\|0.03\|0\|0\n" +
	"wg3\|13\|be1-host\|0.13\|0\|0");

	String res = starRocksAssert.executeShowResourceUsageSql("SHOW USAGE RESOURCE GROUPS;");
	assertThat(res).isEqualTo("Name\|Id\|Backend\|BEInUseCpuCores\|BEInUseMemBytes\|BERunningQueries\n" +
	"wg0\|10\|be0-host\|0.21\|29\|28\n" +
	"wg1\|11\|be0-host\|0.2\|0\|0\n" +
	"wg2\|12\|be1-host\|1.22\|27\|26\n" +
	"wg3\|13\|be1-host\|0.23\|0\|0");

[Enhancement] Extend 'show usage resource groups;' with mem_pool metrics #66690

[Enhancement] Extend 'show usage resource groups;' with mem_pool metrics #66690

Uh oh!

Conversation

arin-mirza commented Dec 12, 2025 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why I'm doing:

What I'm doing:

Notes/Discussion

Demo

What type of PR is this:

Checklist:

Bugfix cherry-pick branch check:

Uh oh!

mergify bot commented Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🧪 CI Insights

🟢 All jobs passed!

Uh oh!

alvin-celerdata commented Dec 12, 2025

Uh oh!

Uh oh!

Uh oh!

alvin-celerdata commented Dec 14, 2025

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: Test assertions missing new columns in expected output

Uh oh!

arin-mirza commented Dec 16, 2025

Uh oh!

alvin-celerdata commented Dec 16, 2025

Uh oh!

Uh oh!

Uh oh!

arin-mirza commented Dec 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alvin-celerdata commented Dec 19, 2025

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

✅ Bugbot reviewed your changes and found no bugs!

Uh oh!

alvin-celerdata commented Dec 27, 2025

Uh oh!

mergify bot commented Dec 27, 2025

✅ Branch has been successfully rebased

Uh oh!

alvin-celerdata commented Dec 27, 2025

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

arin-mirza commented Dec 30, 2025

Uh oh!

github-actions bot commented Dec 30, 2025

[FE Incremental Coverage Report]

file detail

Uh oh!

alvin-celerdata commented Dec 31, 2025

Uh oh!

mergify bot commented Dec 31, 2025

✅ Branch has been successfully rebased

Uh oh!

sonarqubecloud bot commented Dec 31, 2025

Quality Gate passed

Uh oh!

github-actions bot commented Dec 31, 2025

[Java-Extensions Incremental Coverage Report]

Uh oh!

Uh oh!

github-actions bot commented Dec 31, 2025

Uh oh!

mergify bot commented Dec 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Backports have been created

Uh oh!

github-actions bot commented Dec 31, 2025

[BE Incremental Coverage Report]

arin-mirza commented Dec 12, 2025 •

edited by cursor bot

Loading

mergify bot commented Dec 12, 2025 •

edited

Loading

arin-mirza commented Dec 19, 2025 •

edited

Loading

mergify bot commented Dec 31, 2025 •

edited

Loading