Package jp.ikedam.jenkins.plugins.scoringloadbalancer

Class ScoringLoadBalancer

java.lang.Object

hudson.model.LoadBalancer

jp.ikedam.jenkins.plugins.scoringloadbalancer.ScoringLoadBalancer

All Implemented Interfaces:

ExtensionPoint, Describable<ScoringLoadBalancer>

public class ScoringLoadBalancer
extends LoadBalancer
implements Describable<ScoringLoadBalancer>

LoadBalancer using scores of nodes. Decides the nodes to execute tasks depending on scores of nodes. Scoring is performed by ScoringRules enabled in System Configuration page.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScoringLoadBalancer.DescriptorImpl	Descriptor for ScoringLoadBalancer Manages views and holds configuration for ScoringLoadBalancer.
static class	ScoringLoadBalancer.NodesScore	Holds scores of nodes.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.LoadBalancer

CONSISTENT_HASH, DEFAULT

Constructor Summary

Constructors

Constructor	Description
ScoringLoadBalancer(LoadBalancer fallback)	Constructor.

Method Summary

Modifier and Type	Method	Description
ScoringLoadBalancer.DescriptorImpl	getDescriptor()	Returns the instance of ScoringLoadBalancer.DescriptorImpl.
LoadBalancer	getFallback()
List<ScoringRule>	getScoringRuleList()
int	getSimultaneousBuildsWorkaroundThrottleTime()	Returns the throttle time of the workaround for simultaneous builds, which only allows a single build to start within the amount of milliseconds that is returned by this method.
static void	installLoadBalancer()	Replaces LoadBalancer registered to Jenkins to ScoringLoadBalancer.
boolean	isEnabled()	Return whether this LoadBalancer is enabled.
boolean	isReportScoresEnabled()	Returns whether to log calculated scores.
boolean	isSimultaneousBuildsWorkaroundEnabled()	Returns whether to enable the workaround for simultaneous builds, which throttles builds / only allows a single build to start within a certain time.
MappingWorksheet.Mapping	map(Queue.Task task, MappingWorksheet worksheet)	Decides nodes to run tasks on.
protected void	reportScores(MappingWorksheet.WorkChunk wc, List<MappingWorksheet.ExecutorChunk> executors, ScoringLoadBalancer.NodesScore nodesScore)	Log scores.
protected void	sortExecutors(List<MappingWorksheet.ExecutorChunk> executors, ScoringLoadBalancer.NodesScore nodesScore)	sort MappingWorksheet.ExecutorChunks (that is, nodes) by scores.

Methods inherited from class hudson.model.LoadBalancer

sanitize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScoringLoadBalancer

public ScoringLoadBalancer(LoadBalancer fallback)

Constructor.

Parameters:

fallback - LoadBalancer to fall back. Specify originally registered LoadBalancer.

Method Details

installLoadBalancer

@Initializer(after=PLUGINS_STARTED,
             fatal=false)
public static void installLoadBalancer()

Replaces LoadBalancer registered to Jenkins to ScoringLoadBalancer. The LoadBalancer originally registered are used as one to fall back.

getFallback

public LoadBalancer getFallback()

Returns:

LoadBalancer to fall back

getScoringRuleList

public List<ScoringRule> getScoringRuleList()

Returns:

list of ScoringRules

isEnabled

public boolean isEnabled()

Return whether this LoadBalancer is enabled. If disabled, simply call LoadBalancer to fall back.

Returns:

whether this LoadBalancer is enabled.

isReportScoresEnabled

public boolean isReportScoresEnabled()

Returns whether to log calculated scores.

Returns:

whether to log calculated scores.

isSimultaneousBuildsWorkaroundEnabled

public boolean isSimultaneousBuildsWorkaroundEnabled()

Returns whether to enable the workaround for simultaneous builds, which throttles builds / only allows a single build to start within a certain time.

Returns:

whether to enable the workaround and throttle builds.

getSimultaneousBuildsWorkaroundThrottleTime

public int getSimultaneousBuildsWorkaroundThrottleTime()

Returns the throttle time of the workaround for simultaneous builds, which only allows a single build to start within the amount of milliseconds that is returned by this method.

Returns:

the throttle time in milliseconds of the workaround.

map

public MappingWorksheet.Mapping map(Queue.Task task,
 MappingWorksheet worksheet)

Decides nodes to run tasks on.

Specified by:

map in class LoadBalancer

Parameters:

task - the root task.

worksheet - an object containing information of subtasks to execute and nodes tasks can execute on.

Returns:

mapping from subtasks to nodes.

See Also:

• LoadBalancer.map(hudson.model.Queue.Task, hudson.model.queue.MappingWorksheet)

sortExecutors

protected void sortExecutors(List<MappingWorksheet.ExecutorChunk> executors,
 ScoringLoadBalancer.NodesScore nodesScore)

sort MappingWorksheet.ExecutorChunks (that is, nodes) by scores.

Parameters:

executors -

nodesScore -

reportScores

protected void reportScores(MappingWorksheet.WorkChunk wc,
 List<MappingWorksheet.ExecutorChunk> executors,
 ScoringLoadBalancer.NodesScore nodesScore)

Log scores. For diagnostics purpose.

Parameters:

executors -

nodesScore -

getDescriptor

public ScoringLoadBalancer.DescriptorImpl getDescriptor()

Returns the instance of ScoringLoadBalancer.DescriptorImpl.

Specified by:

getDescriptor in interface Describable<ScoringLoadBalancer>

Returns:

the instance of ScoringLoadBalancer.DescriptorImpl.

See Also:

• Describable.getDescriptor()