Skip to content

[improvement](fe) Add cloud tablet rebalancer metrics #66576

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
deardeng merged 1 commit into from
Aug 10, 2026
Merged

[improvement](fe) Add cloud tablet rebalancer metrics #66576

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
80 changes: 48 additions & 32 deletions fe/fe-core/src/main/java/org/apache/doris/cloud/catalog/CloudTabletRebalancer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,9 @@
public class CloudTabletRebalancer extends MasterDaemon {
private static final Logger LOG = LogManager.getLogger(CloudTabletRebalancer.class);

private final CloudTabletRebalancerMetrics rebalancerMetrics;
private long currentRoundTabletScanCount;

private volatile ConcurrentHashMap<Long, Set<Long>> beToTabletsGlobal =
new ConcurrentHashMap<Long, Set<Long>>();

Expand Down Expand Up @@ -245,8 +248,14 @@ private boolean isComputeGroupBalanceChanged(String clusterId) {
}

public CloudTabletRebalancer(CloudSystemInfoService cloudSystemInfoService) {
this(cloudSystemInfoService, CloudTabletRebalancerMetrics.create());
}

CloudTabletRebalancer(CloudSystemInfoService cloudSystemInfoService,
CloudTabletRebalancerMetrics rebalancerMetrics) {
super("cloud tablet rebalancer", Config.cloud_tablet_rebalancer_interval_second * 1000);
this.cloudSystemInfoService = cloudSystemInfoService;
this.rebalancerMetrics = rebalancerMetrics;
}

private void initializeWarmupExecutorsIfNeeded() {
Expand Down Expand Up @@ -505,45 +514,51 @@ protected void runAfterCatalogReady() {
}

LOG.info("cloud tablet rebalance begin");
long start = System.currentTimeMillis();
refreshActiveTabletIdsIfNeeded();
globalBalanceTypeEnum = BalanceTypeEnum.getCloudWarmUpForRebalanceTypeEnum();
CloudTabletRebalancerMetrics.Round metricRound = rebalancerMetrics.startRound();
currentRoundTabletScanCount = 0L;
try {
long start = System.currentTimeMillis();
refreshActiveTabletIdsIfNeeded();
globalBalanceTypeEnum = BalanceTypeEnum.getCloudWarmUpForRebalanceTypeEnum();

buildClusterToBackendMap();
if (!completeRouteInfo()) {
return;
}
buildClusterToBackendMap();
if (!completeRouteInfo()) {
return;
}

statRouteInfo();
boolean migrated = migrateTabletsForSmoothUpgrade();
if (migrated) {
statRouteInfo();
}
boolean migrated = migrateTabletsForSmoothUpgrade();
if (migrated) {
statRouteInfo();
}

indexBalanced = true;
tableBalanced = true;
indexBalanced = true;
tableBalanced = true;

performBalancing();
performBalancing();

checkDecommissionState(clusterToBes);
inited = true;
long sleepSeconds = Config.cloud_tablet_rebalancer_interval_second;
if (sleepSeconds < 0L) {
LOG.warn("cloud tablet rebalance interval second is negative, change it to default 1s");
sleepSeconds = 1L;
}
long balanceEnd = System.currentTimeMillis();
if (DebugPointUtil.isEnable("CloudTabletRebalancer.balanceEnd.tooLong")) {
LOG.info("debug pointCloudTabletRebalancer.balanceEnd.tooLong");
// slower the balance end time to trigger next balance immediately
balanceEnd += (Config.cloud_tablet_rebalancer_interval_second + 10L) * 1000L;
}
if (balanceEnd - start > Config.cloud_tablet_rebalancer_interval_second * 1000L) {
sleepSeconds = 1L;
checkDecommissionState(clusterToBes);
inited = true;
long sleepSeconds = Config.cloud_tablet_rebalancer_interval_second;
if (sleepSeconds < 0L) {
LOG.warn("cloud tablet rebalance interval second is negative, change it to default 1s");
sleepSeconds = 1L;
}
long balanceEnd = System.currentTimeMillis();
if (DebugPointUtil.isEnable("CloudTabletRebalancer.balanceEnd.tooLong")) {
LOG.info("debug pointCloudTabletRebalancer.balanceEnd.tooLong");
// slower the balance end time to trigger next balance immediately
balanceEnd += (Config.cloud_tablet_rebalancer_interval_second + 10L) * 1000L;
}
if (balanceEnd - start > Config.cloud_tablet_rebalancer_interval_second * 1000L) {
sleepSeconds = 1L;
}
setInterval(sleepSeconds * 1000L);
LOG.info("finished to rebalancer. cost: {} ms, rebalancer sche interval {} s",
(System.currentTimeMillis() - start), sleepSeconds);
} finally {
rebalancerMetrics.finishRound(metricRound, currentRoundTabletScanCount);
}
setInterval(sleepSeconds * 1000L);
LOG.info("finished to rebalancer. cost: {} ms, rebalancer sche interval {} s",
(System.currentTimeMillis() - start), sleepSeconds);
}

private void buildClusterToBackendMap() {
Expand Down Expand Up @@ -1277,6 +1292,7 @@ public void loopCloudReplica(Operator operator) {
for (MaterializedIndex index : partition.getMaterializedIndices(IndexExtState.VISIBLE, true)) {
for (Map.Entry<String, List<Long>> entry : clusterToBes.entrySet()) {
String cluster = entry.getKey();
currentRoundTabletScanCount += index.getTablets().size();
operator.op(db, table, partition, index, cluster);
}
} // end for indices
Expand Down
78 changes: 78 additions & 0 deletions fe/fe-core/src/main/java/org/apache/doris/cloud/catalog/CloudTabletRebalancerMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

package org.apache.doris.cloud.catalog;

import org.apache.doris.metric.MetricRepo;

import java.lang.management.ManagementFactory;
import java.util.concurrent.TimeUnit;
import java.util.function.LongSupplier;

final class CloudTabletRebalancerMetrics {
private static final long ALLOCATED_BYTES_UNAVAILABLE = -1L;

private final LongSupplier nanoTimeSupplier;
private final LongSupplier allocatedBytesSupplier;

CloudTabletRebalancerMetrics(LongSupplier nanoTimeSupplier, LongSupplier allocatedBytesSupplier) {
this.nanoTimeSupplier = nanoTimeSupplier;
this.allocatedBytesSupplier = allocatedBytesSupplier;
}

static CloudTabletRebalancerMetrics create() {
com.sun.management.ThreadMXBean threadMxBean =
ManagementFactory.getPlatformMXBean(com.sun.management.ThreadMXBean.class);
return new CloudTabletRebalancerMetrics(System::nanoTime, createAllocatedBytesSupplier(threadMxBean));
}

Round startRound() {
return new Round(nanoTimeSupplier.getAsLong(), allocatedBytesSupplier.getAsLong());
}

void finishRound(Round round, long tabletScanCount) {
long durationMs = TimeUnit.NANOSECONDS.toMillis(nanoTimeSupplier.getAsLong() - round.startNanos);
long currentAllocatedBytes = allocatedBytesSupplier.getAsLong();
long allocatedBytes = round.startAllocatedBytes < 0L || currentAllocatedBytes < 0L
? ALLOCATED_BYTES_UNAVAILABLE : currentAllocatedBytes - round.startAllocatedBytes;
MetricRepo.updateCloudTabletRebalancerMetrics(durationMs, allocatedBytes, tabletScanCount);
}

static LongSupplier createAllocatedBytesSupplier(com.sun.management.ThreadMXBean threadMxBean) {
if (threadMxBean == null || !threadMxBean.isThreadAllocatedMemorySupported()) {
return () -> ALLOCATED_BYTES_UNAVAILABLE;
}
if (!threadMxBean.isThreadAllocatedMemoryEnabled()) {
try {
threadMxBean.setThreadAllocatedMemoryEnabled(true);
} catch (SecurityException | UnsupportedOperationException e) {
return () -> ALLOCATED_BYTES_UNAVAILABLE;
}
}
return threadMxBean::getCurrentThreadAllocatedBytes;
}

static final class Round {
private final long startNanos;
private final long startAllocatedBytes;

private Round(long startNanos, long startAllocatedBytes) {
this.startNanos = startNanos;
this.startAllocatedBytes = startAllocatedBytes;
}
}
}
37 changes: 37 additions & 0 deletions fe/fe-core/src/main/java/org/apache/doris/metric/CloudMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,13 @@ public class CloudMetrics {
protected static AutoMappedMetric<LongCounterMetric> CLUSTER_CLOUD_WARM_UP_CACHE_BALANCE_NUM;
protected static AutoMappedMetric<LongCounterMetric> VIRTUAL_COMPUTE_GROUP_SWITCH_COUNTER;

protected static LongCounterMetric CLOUD_TABLET_REBALANCER_ROUND_TOTAL;
protected static LongCounterMetric CLOUD_TABLET_REBALANCER_ALLOCATED_BYTES_TOTAL;
protected static GaugeMetricImpl<Long> CLOUD_TABLET_REBALANCER_LAST_ROUND_ALLOCATED_BYTES;
protected static LongCounterMetric CLOUD_TABLET_REBALANCER_DURATION_MS_TOTAL;
protected static GaugeMetricImpl<Long> CLOUD_TABLET_REBALANCER_LAST_ROUND_DURATION_MS;
protected static LongCounterMetric CLOUD_TABLET_REBALANCER_TABLET_SCAN_TOTAL;

// Per-method meta-service RPC metrics
public static AutoMappedMetric<LongCounterMetric> META_SERVICE_RPC_TOTAL;
public static AutoMappedMetric<LongCounterMetric> META_SERVICE_RPC_FAILED;
Expand Down Expand Up @@ -151,6 +158,8 @@ protected static void init() {
"virtual_compute_group_switch_total", MetricUnit.NOUNIT,
"virtual compute group active standby switch count"));

initCloudTabletRebalancerMetrics();

// Per-method meta-service RPC metrics
META_SERVICE_RPC_TOTAL = MetricRepo.addLabeledMetrics("method", () ->
new LongCounterMetric("meta_service_rpc_total", MetricUnit.NOUNIT,
Expand Down Expand Up @@ -202,4 +211,32 @@ protected static void init() {
MetricUnit.NOUNIT, "meta service RPC requests per second (all methods)", 0.0);
MetricRepo.DORIS_METRIC_REGISTER.addMetrics(META_SERVICE_RPC_ALL_PER_SECOND);
}

static void initCloudTabletRebalancerMetrics() {
CLOUD_TABLET_REBALANCER_ROUND_TOTAL = new LongCounterMetric(
"cloud_tablet_rebalancer_round_total", MetricUnit.OPERATIONS,
"total cloud tablet rebalancer rounds");
CLOUD_TABLET_REBALANCER_ALLOCATED_BYTES_TOTAL = new LongCounterMetric(
"cloud_tablet_rebalancer_allocated_bytes_total", MetricUnit.BYTES,
"total bytes allocated by cloud tablet rebalancer rounds");
CLOUD_TABLET_REBALANCER_LAST_ROUND_ALLOCATED_BYTES = new GaugeMetricImpl<>(
"cloud_tablet_rebalancer_last_round_allocated_bytes", MetricUnit.BYTES,
"bytes allocated by the last cloud tablet rebalancer round, or -1 when unavailable", -1L);
CLOUD_TABLET_REBALANCER_DURATION_MS_TOTAL = new LongCounterMetric(
"cloud_tablet_rebalancer_duration_ms_total", MetricUnit.MILLISECONDS,
"total cloud tablet rebalancer round duration in milliseconds");
CLOUD_TABLET_REBALANCER_LAST_ROUND_DURATION_MS = new GaugeMetricImpl<>(
"cloud_tablet_rebalancer_last_round_duration_ms", MetricUnit.MILLISECONDS,
"duration of the last cloud tablet rebalancer round in milliseconds", 0L);
CLOUD_TABLET_REBALANCER_TABLET_SCAN_TOTAL = new LongCounterMetric(
"cloud_tablet_rebalancer_tablet_scan_total", MetricUnit.OPERATIONS,
"total tablet route entries scanned by cloud tablet rebalancer rounds");

MetricRepo.DORIS_METRIC_REGISTER.addMetrics(CLOUD_TABLET_REBALANCER_ROUND_TOTAL);
MetricRepo.DORIS_METRIC_REGISTER.addMetrics(CLOUD_TABLET_REBALANCER_ALLOCATED_BYTES_TOTAL);
MetricRepo.DORIS_METRIC_REGISTER.addMetrics(CLOUD_TABLET_REBALANCER_LAST_ROUND_ALLOCATED_BYTES);
MetricRepo.DORIS_METRIC_REGISTER.addMetrics(CLOUD_TABLET_REBALANCER_DURATION_MS_TOTAL);
MetricRepo.DORIS_METRIC_REGISTER.addMetrics(CLOUD_TABLET_REBALANCER_LAST_ROUND_DURATION_MS);
MetricRepo.DORIS_METRIC_REGISTER.addMetrics(CLOUD_TABLET_REBALANCER_TABLET_SCAN_TOTAL);
}
}
15 changes: 15 additions & 0 deletions fe/fe-core/src/main/java/org/apache/doris/metric/MetricRepo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2253,6 +2253,21 @@ public static void updateClusterCloudBalanceNum(String clusterName, String clust
MetricRepo.DORIS_METRIC_REGISTER.addMetrics(counter);
}

public static void updateCloudTabletRebalancerMetrics(long durationMs, long allocatedBytes,
long tabletScanCount) {
if (!MetricRepo.isInit || Config.isNotCloudMode()) {
return;
}
CloudMetrics.CLOUD_TABLET_REBALANCER_ROUND_TOTAL.increase(1L);
CloudMetrics.CLOUD_TABLET_REBALANCER_DURATION_MS_TOTAL.increase(durationMs);
CloudMetrics.CLOUD_TABLET_REBALANCER_LAST_ROUND_DURATION_MS.setValue(durationMs);
CloudMetrics.CLOUD_TABLET_REBALANCER_TABLET_SCAN_TOTAL.increase(tabletScanCount);
CloudMetrics.CLOUD_TABLET_REBALANCER_LAST_ROUND_ALLOCATED_BYTES.setValue(allocatedBytes);
if (allocatedBytes >= 0L) {
CloudMetrics.CLOUD_TABLET_REBALANCER_ALLOCATED_BYTES_TOTAL.increase(allocatedBytes);
}
}

public static void increaseVirtualComputeGroupSwitch(String virtualComputeGroupId, String virtualComputeGroupName,
String srcComputeGroupId, String srcComputeGroupName,
String dstComputeGroupId, String dstComputeGroupName) {
Expand Down
90 changes: 90 additions & 0 deletions ...e-core/src/test/java/org/apache/doris/cloud/catalog/CloudTabletRebalancerMetricsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

package org.apache.doris.cloud.catalog;

import org.apache.doris.metric.MetricRepo;

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.mockito.MockedStatic;
import org.mockito.Mockito;

import java.util.concurrent.atomic.AtomicLong;
import java.util.function.LongSupplier;

public class CloudTabletRebalancerMetricsTest {

@Test
public void testCreateUsesCurrentJvmThreadAllocationSupport() {
CloudTabletRebalancerMetrics metrics = CloudTabletRebalancerMetrics.create();
Assertions.assertNotNull(metrics.startRound());
}

@Test
public void testAllocatedBytesSupplierHandlesJvmCapabilities() {
com.sun.management.ThreadMXBean unsupported = Mockito.mock(com.sun.management.ThreadMXBean.class);
Mockito.when(unsupported.isThreadAllocatedMemorySupported()).thenReturn(false);
LongSupplier unsupportedSupplier = CloudTabletRebalancerMetrics.createAllocatedBytesSupplier(unsupported);
Assertions.assertEquals(-1L, unsupportedSupplier.getAsLong());

com.sun.management.ThreadMXBean denied = Mockito.mock(com.sun.management.ThreadMXBean.class);
Mockito.when(denied.isThreadAllocatedMemorySupported()).thenReturn(true);
Mockito.when(denied.isThreadAllocatedMemoryEnabled()).thenReturn(false);
Mockito.doThrow(new SecurityException()).when(denied).setThreadAllocatedMemoryEnabled(true);
LongSupplier deniedSupplier = CloudTabletRebalancerMetrics.createAllocatedBytesSupplier(denied);
Assertions.assertEquals(-1L, deniedSupplier.getAsLong());

com.sun.management.ThreadMXBean enabled = Mockito.mock(com.sun.management.ThreadMXBean.class);
Mockito.when(enabled.isThreadAllocatedMemorySupported()).thenReturn(true);
Mockito.when(enabled.isThreadAllocatedMemoryEnabled()).thenReturn(true);
Mockito.when(enabled.getCurrentThreadAllocatedBytes()).thenReturn(1234L);
LongSupplier enabledSupplier = CloudTabletRebalancerMetrics.createAllocatedBytesSupplier(enabled);
Assertions.assertEquals(1234L, enabledSupplier.getAsLong());
}

@Test
public void testFinishRoundRecordsDurationAllocationAndWork() {
AtomicLong nanoTime = new AtomicLong(1_000_000_000L);
AtomicLong allocatedBytes = new AtomicLong(10_000L);
CloudTabletRebalancerMetrics metrics =
new CloudTabletRebalancerMetrics(nanoTime::get, allocatedBytes::get);

CloudTabletRebalancerMetrics.Round round = metrics.startRound();
nanoTime.set(1_012_000_000L);
allocatedBytes.set(10_777L);

try (MockedStatic<MetricRepo> metricRepo = Mockito.mockStatic(MetricRepo.class)) {
metrics.finishRound(round, 42L);
metricRepo.verify(() -> MetricRepo.updateCloudTabletRebalancerMetrics(12L, 777L, 42L));
}
}

@Test
public void testFinishRoundMarksAllocationUnavailable() {
AtomicLong nanoTime = new AtomicLong(2_000_000_000L);
CloudTabletRebalancerMetrics metrics = new CloudTabletRebalancerMetrics(nanoTime::get, () -> -1L);

CloudTabletRebalancerMetrics.Round round = metrics.startRound();
nanoTime.set(2_003_000_000L);

try (MockedStatic<MetricRepo> metricRepo = Mockito.mockStatic(MetricRepo.class)) {
metrics.finishRound(round, 7L);
metricRepo.verify(() -> MetricRepo.updateCloudTabletRebalancerMetrics(3L, -1L, 7L));
}
}
}
Loading
Loading