Package hudson.model

Class OverallLoadStatistics

java.lang.Object

hudson.model.LoadStatistics

hudson.model.OverallLoadStatistics

public class OverallLoadStatistics
extends LoadStatistics

LoadStatistics for the entire system (the master and all the agents combined), and all the jobs that are running on it.

Author:

Kohsuke Kawaguchi

See Also:

• Jenkins.overallLoad
• UnlabeledLoadStatistics

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.LoadStatistics

LoadStatistics.LoadStatisticsSnapshot, LoadStatistics.LoadStatisticsUpdater

Field Summary

Fields

Modifier and Type	Field	Description
final MultiStageTimeSeries	totalQueueLength	Deprecated. as of 1.467 Use LoadStatistics.queueLength.

Fields inherited from class hudson.model.LoadStatistics

availableExecutors, busyExecutors, CLOCK, connectingExecutors, DECAY, definedExecutors, idleExecutors, onlineExecutors, queueLength, totalExecutors

Constructor Summary

Constructors

Constructor	Description
OverallLoadStatistics()

Method Summary

Modifier and Type	Method	Description
int	computeIdleExecutors()	Computes the # of idle executors right now and obtains the snapshot value.
int	computeQueueLength()	Computes the # of queue length right now and obtains the snapshot value.
int	computeTotalExecutors()	Computes the # of total executors right now and obtains the snapshot value.
protected MultiStageTimeSeries.TrendChart	createOverallTrendChart(MultiStageTimeSeries.TimeScale timeScale)	When drawing the overall load statistics, use the total queue length, not LoadStatistics.queueLength, which just shows jobs that are to be run on the master.
protected Iterable<Node>	getNodes()	Returns the Node instances that this statistic counts.
protected boolean	matches(Queue.Item item, SubTask subTask)	Returns true is the specified SubTask from the Queue should be counted.

Methods inherited from class hudson.model.LoadStatistics

computeSnapshot, computeSnapshot, configureRenderer, createChart, createTrendChart, doGraph, getApi, getLatestIdleExecutors, updateCounts, updateExecutorCounts

Methods inherited from class java.lang.Object

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

Field Details

totalQueueLength

@Exported
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@Deprecated
public final MultiStageTimeSeries totalQueueLength

Deprecated.

as of 1.467 Use LoadStatistics.queueLength. Left as an alias here for backward compatibility.

Number of total Queue.BuildableItems that represents blocked builds.

Constructor Details

OverallLoadStatistics

public OverallLoadStatistics()

Method Details

computeIdleExecutors

public int computeIdleExecutors()

Description copied from class: LoadStatistics

Computes the # of idle executors right now and obtains the snapshot value.

Specified by:

computeIdleExecutors in class LoadStatistics

computeTotalExecutors

public int computeTotalExecutors()

Description copied from class: LoadStatistics

Computes the # of total executors right now and obtains the snapshot value.

Specified by:

computeTotalExecutors in class LoadStatistics

computeQueueLength

public int computeQueueLength()

Description copied from class: LoadStatistics

Computes the # of queue length right now and obtains the snapshot value.

Specified by:

computeQueueLength in class LoadStatistics

getNodes

protected Iterable<Node> getNodes()

Description copied from class: LoadStatistics

Returns the Node instances that this statistic counts.

Specified by:

getNodes in class LoadStatistics

Returns:

the Node

matches

protected boolean matches(Queue.Item item,
 SubTask subTask)

Description copied from class: LoadStatistics

Returns true is the specified SubTask from the Queue should be counted.

Specified by:

matches in class LoadStatistics

Parameters:

item - the Queue.Item that the belongs to

subTask - the SubTask

Returns:

true IFF the specified SubTask from the Queue should be counted.

createOverallTrendChart

protected MultiStageTimeSeries.TrendChart createOverallTrendChart(MultiStageTimeSeries.TimeScale timeScale)

When drawing the overall load statistics, use the total queue length, not LoadStatistics.queueLength, which just shows jobs that are to be run on the master.