Skip to content

Batch-load VM details in CapacityManagerImpl.updateCapacityForHost to eliminate N+1 queries #13410

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

Open
vishesh92 wants to merge 1 commit into
base: 4.22
Choose a base branch
from
+166 −11
Open

Batch-load VM details in CapacityManagerImpl.updateCapacityForHost to eliminate N+1 queries #13410

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
2 changes: 2 additions & 0 deletions engine/schema/src/main/java/org/apache/cloudstack/resourcedetail/ResourceDetailsDao.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@ public interface ResourceDetailsDao<R extends ResourceDetail> extends GenericDao

Map<String, String> listDetailsKeyPairs(long resourceId, List<String> keys);

Map<Long, Map<String, String>> listDetailsKeyPairs(List<Long> resourceIds, List<String> keys);

Map<String, String> listDetailsKeyPairs(long resourceId, boolean forDisplay);

Map<String, Boolean> listDetailsVisibility(long resourceId);
Expand Down
26 changes: 26 additions & 0 deletions engine/schema/src/main/java/org/apache/cloudstack/resourcedetail/ResourceDetailsDaoBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
import javax.inject.Inject;

public abstract class ResourceDetailsDaoBase<R extends ResourceDetail> extends GenericDaoBase<R, Long> implements ResourceDetailsDao<R> {
private static final int IN_CLAUSE_BATCH_SIZE = 1000;

@Inject
private ConfigurationDao configDao;
Expand Down Expand Up @@ -122,6 +123,31 @@ public Map<String, String> listDetailsKeyPairs(long resourceId, List<String> key
return results.stream().collect(Collectors.toMap(R::getName, R::getValue));
}

@Override
public Map<Long, Map<String, String>> listDetailsKeyPairs(List<Long> resourceIds, List<String> keys) {
if (CollectionUtils.isEmpty(resourceIds)) {
return new HashMap<>();
}
SearchBuilder<R> sb = createSearchBuilder();
sb.and("resourceId", sb.entity().getResourceId(), SearchCriteria.Op.IN);
sb.and("name", sb.entity().getName(), SearchCriteria.Op.IN);
sb.done();

Map<Long, Map<String, String>> result = new HashMap<>(resourceIds.size());
for (int i = 0; i < resourceIds.size(); i += IN_CLAUSE_BATCH_SIZE) {
List<Long> batch = resourceIds.subList(i, Math.min(i + IN_CLAUSE_BATCH_SIZE, resourceIds.size()));
SearchCriteria<R> sc = sb.create();
sc.setParameters("resourceId", batch.toArray());
sc.setParameters("name", keys.toArray());
List<R> results = search(sc, null);
for (R r : results) {
result.computeIfAbsent(r.getResourceId(), k -> new HashMap<>())
.put(r.getName(), r.getValue());
}
}
return result;
}

public Map<String, Boolean> listDetailsVisibility(long resourceId) {
SearchCriteria<R> sc = AllFieldsSearch.create();
sc.setParameters("resourceId", resourceId);
Expand Down
42 changes: 31 additions & 11 deletions server/src/main/java/com/cloud/capacity/CapacityManagerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
import static com.cloud.utils.NumbersUtil.toHumanReadableSize;

import java.net.URI;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
Expand Down Expand Up @@ -668,13 +670,19 @@ protected ServiceOfferingVO getServiceOffering(long id) {
return serviceOfferingVO;
}

private static final List<String> VM_DETAIL_KEYS_FOR_CAPACITY = List.of(
VmDetailConstants.CPU_OVER_COMMIT_RATIO,
VmDetailConstants.MEMORY_OVER_COMMIT_RATIO,
UsageEventVO.DynamicParameters.memory.name(),
UsageEventVO.DynamicParameters.cpuNumber.name(),
UsageEventVO.DynamicParameters.cpuSpeed.name());

protected Map<String, String> getVmDetailsForCapacityCalculation(long vmId) {
return _vmInstanceDetailsDao.listDetailsKeyPairs(vmId,
List.of(VmDetailConstants.CPU_OVER_COMMIT_RATIO,
VmDetailConstants.MEMORY_OVER_COMMIT_RATIO,
UsageEventVO.DynamicParameters.memory.name(),
UsageEventVO.DynamicParameters.cpuNumber.name(),
UsageEventVO.DynamicParameters.cpuSpeed.name()));
return _vmInstanceDetailsDao.listDetailsKeyPairs(vmId, VM_DETAIL_KEYS_FOR_CAPACITY);
}

protected Map<Long, Map<String, String>> batchGetVmDetailsForCapacityCalculation(List<Long> vmIds) {
return _vmInstanceDetailsDao.listDetailsKeyPairs(vmIds, VM_DETAIL_KEYS_FOR_CAPACITY);
}

@DB
Expand All @@ -698,14 +706,29 @@ public void updateCapacityForHost(final Host host) {
logger.debug("Found {} VMs are Migrating from {}", vosMigrating.size(), host);
vms.addAll(vosMigrating);


List<VMInstanceVO> vmsByLastHostId = _vmDao.listByLastHostId(host.getId());
logger.debug("Found {} VM, not running on {}", vmsByLastHostId.size(), host);

List<Long> allVmIds = new ArrayList<>(vms.size() + vmsByLastHostId.size());
for (VMInstanceVO vm : vms) {
allVmIds.add(vm.getId());
}
for (VMInstanceVO vm : vmsByLastHostId) {
allVmIds.add(vm.getId());
}
Map<Long, Map<String, String>> allVmDetails = allVmIds.isEmpty()
? Collections.emptyMap()
: batchGetVmDetailsForCapacityCalculation(allVmIds);

Pair<String, String> clusterValues =
clusterValuesCache.get(host.getClusterId());
Float clusterCpuOvercommitRatio = Float.parseFloat(clusterValues.first());
Float clusterRamOvercommitRatio = Float.parseFloat(clusterValues.second());
for (VMInstanceVO vm : vms) {
Float cpuOvercommitRatio = 1.0f;
Float ramOvercommitRatio = 1.0f;
Map<String, String> vmDetails = getVmDetailsForCapacityCalculation(vm.getId());
Map<String, String> vmDetails = allVmDetails.getOrDefault(vm.getId(), Collections.emptyMap());
String vmDetailCpu = vmDetails.get(VmDetailConstants.CPU_OVER_COMMIT_RATIO);
String vmDetailRam = vmDetails.get(VmDetailConstants.MEMORY_OVER_COMMIT_RATIO);
// if vmDetailCpu or vmDetailRam is not null it means it is running in a overcommitted cluster.
Expand Down Expand Up @@ -736,16 +759,13 @@ public void updateCapacityForHost(final Host host) {
}
}

List<VMInstanceVO> vmsByLastHostId = _vmDao.listByLastHostId(host.getId());
logger.debug("Found {} VM, not running on {}", vmsByLastHostId.size(), host);

for (VMInstanceVO vm : vmsByLastHostId) {
Float cpuOvercommitRatio = 1.0f;
Float ramOvercommitRatio = 1.0f;
long lastModificationTime = Optional.ofNullable(vm.getUpdateTime()).orElse(vm.getCreated()).getTime();
long secondsSinceLastUpdate = (DateUtil.currentGMTTime().getTime() - lastModificationTime) / 1000;
if (secondsSinceLastUpdate < _vmCapacityReleaseInterval) {
Map<String, String> vmDetails = getVmDetailsForCapacityCalculation(vm.getId());
Map<String, String> vmDetails = allVmDetails.getOrDefault(vm.getId(), Collections.emptyMap());
String vmDetailCpu = vmDetails.get(VmDetailConstants.CPU_OVER_COMMIT_RATIO);
String vmDetailRam = vmDetails.get(VmDetailConstants.MEMORY_OVER_COMMIT_RATIO);
if (vmDetailCpu != null) {
Expand Down
107 changes: 107 additions & 0 deletions server/src/test/java/com/cloud/capacity/CapacityManagerImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,23 @@
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.anyList;
import static org.mockito.ArgumentMatchers.anyLong;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.any;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.cloudstack.utils.bytescale.ByteScaleUtils;
import org.apache.cloudstack.utils.cache.LazyCache;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
Expand All @@ -41,20 +45,33 @@
import org.mockito.Spy;
import org.mockito.junit.MockitoJUnitRunner;

import com.cloud.capacity.dao.CapacityDao;
import com.cloud.dc.ClusterDetailsDao;
import com.cloud.host.Host;
import com.cloud.host.HostVO;
import com.cloud.host.dao.HostDao;
import com.cloud.offering.ServiceOffering;
import com.cloud.service.ServiceOfferingVO;
import com.cloud.service.dao.ServiceOfferingDao;
import com.cloud.utils.Pair;
import com.cloud.event.UsageEventVO;
import com.cloud.resource.ResourceState;
import com.cloud.vm.VMInstanceVO;
import com.cloud.vm.VmDetailConstants;
import com.cloud.vm.dao.VMInstanceDao;

@RunWith(MockitoJUnitRunner.class)
public class CapacityManagerImplTest {
@Mock
ClusterDetailsDao clusterDetailsDao;
@Mock
ServiceOfferingDao serviceOfferingDao;
@Mock
CapacityDao capacityDao;
@Mock
HostDao hostDao;
@Mock
VMInstanceDao vmInstanceDao;

@Spy
@InjectMocks
Expand All @@ -64,6 +81,7 @@ public class CapacityManagerImplTest {
private Host host;
private ServiceOffering offering;
private static final long CLUSTER_ID = 1L;
private static final long HOST_ID = 100L;
private static final int OFFERING_CPU = 4;
private static final int OFFERING_CPU_SPEED = 2000;
private static final int OFFERING_MEMORY = 4096;
Expand Down Expand Up @@ -179,4 +197,93 @@ public void testCheckIfHostHasCpuCapabilityButNoCapacity() {
eq(ByteScaleUtils.mebibytesToBytes(OFFERING_MEMORY)),
eq(false), eq(cpuOvercommit), eq(memoryOvercommit), eq(false));
}

@Test
public void testUpdateCapacityForHostMixedStaticAndDynamic() throws Exception {
HostVO testHost = mock(HostVO.class);
when(testHost.getId()).thenReturn(HOST_ID);
when(testHost.getClusterId()).thenReturn(CLUSTER_ID);
when(testHost.getResourceState()).thenReturn(ResourceState.Enabled);
when(testHost.getCpus()).thenReturn(16);
when(testHost.getSpeed()).thenReturn(2000L);
when(testHost.getTotalMemory()).thenReturn(32L * 1024 * 1024 * 1024);

Pair<String, String> clusterOvercommit = new Pair<>("2.0", "1.5");
doReturn(clusterOvercommit).when(capacityManager).getClusterValues(CLUSTER_ID);
java.lang.reflect.Field cacheField = CapacityManagerImpl.class.getDeclaredField("clusterValuesCache");
cacheField.setAccessible(true);
cacheField.set(capacityManager, new LazyCache<>(128, 60, capacityManager::getClusterValues));

long staticVmId = 1L;
long dynamicVmId = 2L;
long staticOfferingId = 10L;
long dynamicOfferingId = 20L;

VMInstanceVO staticVm = mock(VMInstanceVO.class);
when(staticVm.getId()).thenReturn(staticVmId);
when(staticVm.getServiceOfferingId()).thenReturn(staticOfferingId);

VMInstanceVO dynamicVm = mock(VMInstanceVO.class);
when(dynamicVm.getId()).thenReturn(dynamicVmId);
when(dynamicVm.getServiceOfferingId()).thenReturn(dynamicOfferingId);

when(vmInstanceDao.listIdServiceOfferingForUpVmsByHostId(HOST_ID))
.thenReturn(new ArrayList<>(List.of(staticVm, dynamicVm)));
when(vmInstanceDao.listIdServiceOfferingForVmsMigratingFromHost(HOST_ID))
.thenReturn(Collections.emptyList());
when(vmInstanceDao.listByLastHostId(HOST_ID))
.thenReturn(Collections.emptyList());

ServiceOfferingVO staticOffering = mock(ServiceOfferingVO.class);
when(staticOffering.isDynamic()).thenReturn(false);
when(staticOffering.getCpu()).thenReturn(2);
when(staticOffering.getSpeed()).thenReturn(2000);
when(staticOffering.getRamSize()).thenReturn(2048);

ServiceOfferingVO dynamicOffering = mock(ServiceOfferingVO.class);
when(dynamicOffering.isDynamic()).thenReturn(true);

doReturn(staticOffering).when(capacityManager).getServiceOffering(staticOfferingId);
doReturn(dynamicOffering).when(capacityManager).getServiceOffering(dynamicOfferingId);

Map<Long, Map<String, String>> batchDetails = new HashMap<>();
batchDetails.put(staticVmId, Map.of(
VmDetailConstants.CPU_OVER_COMMIT_RATIO, "2.0",
VmDetailConstants.MEMORY_OVER_COMMIT_RATIO, "1.5"));
batchDetails.put(dynamicVmId, Map.of(
VmDetailConstants.CPU_OVER_COMMIT_RATIO, "2.0",
VmDetailConstants.MEMORY_OVER_COMMIT_RATIO, "1.5",
UsageEventVO.DynamicParameters.cpuNumber.name(), "4",
UsageEventVO.DynamicParameters.cpuSpeed.name(), "2500",
UsageEventVO.DynamicParameters.memory.name(), "4096"));
doReturn(batchDetails).when(capacityManager).batchGetVmDetailsForCapacityCalculation(anyList());

CapacityVO cpuCapVO = new CapacityVO(HOST_ID, 1L, 1L, CLUSTER_ID, 0, 16 * 2000L, Capacity.CAPACITY_TYPE_CPU);
cpuCapVO.setReservedCapacity(0);
CapacityVO memCapVO = new CapacityVO(HOST_ID, 1L, 1L, CLUSTER_ID, 0, 32L * 1024 * 1024 * 1024, Capacity.CAPACITY_TYPE_MEMORY);
memCapVO.setReservedCapacity(0);
CapacityVO cpuCoreCapVO = new CapacityVO(HOST_ID, 1L, 1L, CLUSTER_ID, 0, 16L, CapacityVO.CAPACITY_TYPE_CPU_CORE);
cpuCoreCapVO.setReservedCapacity(0);

when(capacityDao.listByHostIdTypes(eq(HOST_ID), anyList()))
.thenReturn(List.of(cpuCapVO, memCapVO, cpuCoreCapVO));
when(capacityDao.update(anyLong(), any(CapacityVO.class))).thenReturn(true);

capacityManager.updateCapacityForHost(testHost);

// static VM: cpu = (2 * 2000 / 2.0) * 2.0 = 4000, mem = (2048 * 1024 * 1024 / 1.5) * 1.5 = 2048MB
// dynamic VM: cpu = (4 * 2500 / 2.0) * 2.0 = 10000, mem = (4096 * 1024 * 1024 / 1.5) * 1.5 = 4096MB
long expectedUsedCpu = 4000 + 10000;
long expectedUsedMem = (2048L + 4096L) * 1024 * 1024;
long expectedUsedCpuCore = 2 + 4;

assertEquals(expectedUsedCpu, cpuCapVO.getUsedCapacity());
assertEquals(expectedUsedMem, memCapVO.getUsedCapacity());
assertEquals(expectedUsedCpuCore, cpuCoreCapVO.getUsedCapacity());
assertEquals(0, cpuCapVO.getReservedCapacity());
assertEquals(0, memCapVO.getReservedCapacity());

verify(capacityManager).batchGetVmDetailsForCapacityCalculation(anyList());
verify(capacityManager, never()).getVmDetailsForCapacityCalculation(anyLong());
}
}
Loading