This repository has been archived by the owner on Mar 3, 2023. It is now read-only.
Add a scoring-based approach to modifying packing plan #1572
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| // Copyright 2016 Twitter. All rights reserved. | ||
| // | ||
| // Licensed 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 com.twitter.heron.packing.builder; | ||
|
|
||
| /** | ||
| * Sorts containers ascending by container id. Id firstId and maxId as passed, starte with | ||
|
There was a problem hiding this comment. a typo: starte -> start |
||
| * container with id firstId and ends with id firstId - 1 | ||
| */ | ||
| public class ContainerIdScorer implements Scorer<Container> { | ||
|
|
||
| private Integer firstId; | ||
| private Integer maxId; | ||
|
|
||
| public ContainerIdScorer() { | ||
| this(0, 0); | ||
| } | ||
|
|
||
| public ContainerIdScorer(Integer firstId, Integer maxId) { | ||
| this.firstId = firstId; | ||
| this.maxId = maxId; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean sortAscending() { | ||
| return true; | ||
| } | ||
|
|
||
| @Override | ||
| public double getScore(Container container) { | ||
| int containerId = container.getContainerId(); | ||
| if (containerId >= firstId) { | ||
| return containerId - firstId; | ||
| } else { | ||
| return containerId + maxId; | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,10 +14,15 @@ | |
| package com.twitter.heron.packing.builder; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Collection; | ||
| import java.util.Collections; | ||
| import java.util.Comparator; | ||
| import java.util.HashMap; | ||
| import java.util.HashSet; | ||
| import java.util.LinkedList; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Queue; | ||
| import java.util.Set; | ||
| import java.util.SortedSet; | ||
| import java.util.TreeSet; | ||
|
|
@@ -107,13 +112,80 @@ public PackingPlanBuilder addInstance(Integer containerId, | |
| return this; | ||
| } | ||
|
|
||
| @SuppressWarnings("JavadocMethod") | ||
| /** | ||
| * Add an instance to the first container possible ranked by score. | ||
| * @return containerId of the container the instance was added to | ||
| * @throws com.twitter.heron.packing.ResourceExceededException if the instance could not be added | ||
| */ | ||
| public int addInstance(Scorer<Container> scorer, | ||
| InstanceId instanceId) throws ResourceExceededException { | ||
| List<Scorer<Container>> scorers = new LinkedList<>(); | ||
| scorers.add(scorer); | ||
| return addInstance(scorers, instanceId); | ||
| } | ||
|
|
||
| @SuppressWarnings("JavadocMethod") | ||
| /** | ||
| * Add an instance to the first container possible ranked by score. If a scoring tie exists, | ||
| * uses the next scorer in the scorers list to break the tie. | ||
| * @return containerId of the container the instance was added to | ||
| * @throws com.twitter.heron.packing.ResourceExceededException if the instance could not be added | ||
| */ | ||
| private int addInstance(List<Scorer<Container>> scorers, InstanceId instanceId) | ||
| throws ResourceExceededException { | ||
| initContainers(); | ||
| for (Container container : sortContainers(scorers, this.containers.values())) { | ||
| try { | ||
| addInstance(container.getContainerId(), instanceId); | ||
| return container.getContainerId(); | ||
| } catch (ResourceExceededException e) { | ||
| // ignore since we'll continue trying | ||
| } | ||
| } | ||
| //Not enough containers. | ||
| throw new ResourceExceededException(String.format( | ||
| "Insufficient resources to add instance %s to any of the %d containers.", | ||
| instanceId, this.containers.size())); | ||
| } | ||
|
|
||
| public boolean removeInstance(Integer containerId, String componentName) { | ||
| initContainers(); | ||
| Optional<PackingPlan.InstancePlan> instancePlan = | ||
| containers.get(containerId).removeAnyInstanceOfComponent(componentName); | ||
| return instancePlan.isPresent(); | ||
| } | ||
|
|
||
| @SuppressWarnings("JavadocMethod") | ||
| /** | ||
| * Remove an instance from the first container possible ranked by score. | ||
| * @return containerId of the container the instance was removed from | ||
| * @throws com.twitter.heron.spi.packing.PackingException if the instance could not be removed | ||
| */ | ||
| public int removeInstance(Scorer<Container> scorer, String componentName) { | ||
| List<Scorer<Container>> scorers = new LinkedList<>(); | ||
| scorers.add(scorer); | ||
| return removeInstance(scorers, componentName); | ||
| } | ||
|
|
||
| @SuppressWarnings("JavadocMethod") | ||
| /** | ||
| * Remove an instance from the first container possible ranked by score. If a scoring tie exists, | ||
| * uses the next scorer in the scorers list to break the tie. | ||
| * @return containerId of the container the instance was removed from | ||
| * @throws com.twitter.heron.spi.packing.PackingException if the instance could not be removed | ||
| */ | ||
| public int removeInstance(List<Scorer<Container>> scorers, String componentName) { | ||
|
There was a problem hiding this comment. In the RCRR implementation, during scale down we do not always start from the first container. For example if we need to scale down 2 components by 1 instance from containers [1...5] and the first component is removed from instance 2 then the removal for the next component will start from container 3. This will help with load balancing. This remove instance method does not capture that. However, it is fine if a good scoring method is used when we change the scale down approach as discussed in the other thread. There was a problem hiding this comment. @billonahill I'm not sure if that is the same. In the previous example if we pass as input to the constructor container id 3 and containrId 5 then the search will stop at 5, right? Wehat we ideally want is to start from 3 and use this sequence: 4,5,1,2. Is that behavior captured? |
||
| initContainers(); | ||
| for (Container container : sortContainers(scorers, this.containers.values())) { | ||
| if (removeInstance(container.getContainerId(), componentName)) { | ||
| return container.getContainerId(); | ||
| } | ||
| } | ||
| throw new PackingException("Cannot remove instance. No more instances of component " | ||
| + componentName + " exist in the containers."); | ||
| } | ||
|
|
||
| // build container plan sets by summing up instance resources | ||
| public PackingPlan build() { | ||
| assertResourceSettings(); | ||
|
|
@@ -133,8 +205,8 @@ private void initContainers() { | |
| if (this.existingPacking == null) { | ||
| newContainerMap = new HashMap<>(); | ||
| for (int containerId = 1; containerId <= numContainers; containerId++) { | ||
| newContainerMap.put(containerId, new Container( | ||
| containerId, this.maxContainerResource, this.requestedContainerPadding)); | ||
| } | ||
| } else { | ||
| newContainerMap = getContainers( | ||
|
|
@@ -146,8 +218,9 @@ private void initContainers() { | |
| SortedSet<Integer> sortedIds = new TreeSet<>(newContainerMap.keySet()); | ||
| int nextContainerId = sortedIds.last() + 1; | ||
| for (int i = 0; i < numContainers - newContainerMap.size(); i++) { | ||
| newContainerMap.put(nextContainerId, new Container(nextContainerId, | ||
| newContainerMap.get(sortedIds.first()).getCapacity(), this.requestedContainerPadding)); | ||
| nextContainerId++; | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -231,27 +304,6 @@ private static Set<PackingPlan.ContainerPlan> buildContainerPlans( | |
| return containerPlans; | ||
| } | ||
|
|
||
| /** | ||
| * Generates the containers that correspond to the current packing plan | ||
| * along with their associated instances. | ||
|
|
@@ -263,18 +315,80 @@ static Map<Integer, Container> getContainers(PackingPlan currentPackingPlan, | |
| int paddingPercentage) { | ||
| Map<Integer, Container> containers = new HashMap<>(); | ||
|
|
||
| Resource capacity = currentPackingPlan.getMaxContainerResources(); | ||
| for (PackingPlan.ContainerPlan currentContainerPlan : currentPackingPlan.getContainers()) { | ||
| Container container = | ||
| new Container(currentContainerPlan.getId(), capacity, paddingPercentage); | ||
| for (PackingPlan.InstancePlan instancePlan : currentContainerPlan.getInstances()) { | ||
| container.add(instancePlan); | ||
| } | ||
| containers.put(currentContainerPlan.getId(), container); | ||
| } | ||
| return containers; | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| static List<Container> sortContainers(List<Scorer<Container>> scorers, | ||
| Collection<Container> containers) { | ||
| List<Container> sorted = new ArrayList<>(containers); | ||
| Collections.sort(sorted, new ChainedContainerComparator<>(scorers)); | ||
| return sorted; | ||
| } | ||
|
|
||
| private static class ChainedContainerComparator<T> implements Comparator<T> { | ||
| private final Comparator<T> comparator; | ||
| private final ChainedContainerComparator<T> tieBreaker; | ||
|
|
||
| ChainedContainerComparator(List<Scorer<T>> scorers) { | ||
| this((Queue<Scorer<T>>) new LinkedList<Scorer<T>>(scorers)); | ||
| } | ||
|
|
||
| ChainedContainerComparator(Queue<Scorer<T>> scorers) { | ||
| if (scorers.isEmpty()) { | ||
| this.comparator = new EqualsComparator<T>(); | ||
| this.tieBreaker = null; | ||
| } else { | ||
| this.comparator = new ContainerComparator<T>(scorers.remove()); | ||
| this.tieBreaker = new ChainedContainerComparator<T>(scorers); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public int compare(T thisOne, T thatOne) { | ||
|
|
||
| int delta = comparator.compare(thisOne, thatOne); | ||
| if (delta != 0 || this.tieBreaker == null) { | ||
| return delta; | ||
| } | ||
| return tieBreaker.compare(thisOne, thatOne); | ||
| } | ||
| } | ||
|
|
||
| private static class ContainerComparator<T> implements Comparator<T> { | ||
| private Scorer<T> scorer; | ||
|
|
||
| ContainerComparator(Scorer<T> scorer) { | ||
| this.scorer = scorer; | ||
| } | ||
|
|
||
| @Override | ||
| public int compare(T thisOne, T thatOne) { | ||
| int sign = 1; | ||
| if (!scorer.sortAscending()) { | ||
| sign = -1; | ||
| } | ||
| return sign * (getScore(thisOne) - getScore(thatOne)); | ||
| } | ||
|
|
||
| private int getScore(T container) { | ||
| return (int) (1000 * scorer.getScore(container)); | ||
| } | ||
| } | ||
|
|
||
| private static class EqualsComparator<T> implements Comparator<T> { | ||
| @Override | ||
| public int compare(T thisOne, T thatOne) { | ||
| return 0; | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is a reverse scorer for instance removal better? IMO, inserting and removing instances among the containers in reverse direct will result in better resource utilization.