org.gridgain.grid.spi.loadbalancing.adaptive
Class GridAdaptiveBenchmarkLoadProbe

java.lang.Object
  org.gridgain.grid.spi.loadbalancing.adaptive.GridAdaptiveBenchmarkLoadProbe

All Implemented Interfaces:

GridAdaptiveLoadProbe

public class GridAdaptiveBenchmarkLoadProbe
extends Object
implements GridAdaptiveLoadProbe

Probe that uses GridLocalNodeBenchmark for specifying load for every node. In order to use this probe, use should configure every grid node to start with GridLocalNodeBenchmark as attribute (see GridConfiguration.getUserAttributes() for more information).

You can initialize local node benchmarks by adding/uncommenting the following section in GridGain Spring XML file:

 <property name="userAttributes">
     <map>
         <entry key="grid.node.benchmark">
             <bean class="org.gridgain.grid.benchmarks.GridLocalNodeBenchmark" init-method="start"/>
         </entry>
     </map>
 </property>
 

Here is an example of how load balancing SPI would be configured from Spring XML configuration:

 <property name="loadBalancingSpi">
     <bean class="org.gridgain.grid.spi.loadbalancing.adaptive.GridAdaptiveLoadBalancingSpi">
         <property name="loadProbe">
             <bean class="org.gridgain.grid.spi.loadbalancing.adaptive.GridAdaptiveBenchmarkLoadProbe">
                 <!-- Specify name of benchmark node attribute (the same as above). -->
                 <property name="benchmarkAttributeName" value="grid.node.benchmark"/>

                 <!-- Benchmarks scores to use. -->
                 <property name="useIntegerScore" value="true"/>
                 <property name="useLongScore" value="true"/>
                 <property name="useDoulbeScore" value="true"/>
                 <property name="useIoScore" value="false"/>
                 <property name="useTrigonometryScore" value="false"/>
             </bean>
         </property>
     </bean>
 </property>
 

Please make sure to properly initialize this probe to use exactly the scores you need in your grid. For example, if your jobs don't do any I/O, then you probably should disable I/O score. If you are not doing any trigonometry calculations, then you should disable trigonometry score.



See Also:

Documentation
Email Support
Online Forums
Issue Tracking

Author: 2005-2008 Copyright © GridGain Systems. All Rights Reserved. ver. 2.0.3

	Nikita Ivanov, GridGain Systems nivanov@gridgain.com
	Dmitriy Setrakyan, GridGain Systems dsetrakyan@gridgain.com
	Alexander Magdenko, GridGain Systems amagdenko@gridgain.com
	Boris Suchodoev, GridGain Systems bsuchodoev@gridgain.com
	Denis Kharlamov, GridGain Systems dkharlamov@gridgain.com
	close

Field Summary

static String

DFLT_BENCHMARK_ATTR Default node attribute name for storing node benchmarks (value is 'grid.node.benchmark').

Constructor Summary

GridAdaptiveBenchmarkLoadProbe()
Creates benchmark probe with all defaults.

GridAdaptiveBenchmarkLoadProbe(boolean useIntScore, boolean useLongScore, boolean useDoubleScore, boolean useTrigScore, boolean useIoScore)
Creates benchmark probe which allows use to specify which scores to use.

GridAdaptiveBenchmarkLoadProbe(boolean useIntScore, boolean useLongScore, boolean useDoubleScore, boolean useTrigScore, boolean useIoScore, String benchmarkAttr)
Creates benchmark probe which allows use to specify which scores to use.

Method Summary

String	getBenchmarkAttributeName() Gets name of node attribute by which node benchmarks should be accessed.
double	getLoad(GridNode node, int jobsSentSinceLastUpdate) Calculates load value for a given node.
boolean	isUseDoulbeScore() Gets flag indicating whether double score should be used for calculation of node load.
boolean	isUseIntegerScore() Gets flag indicating whether integer score should be used for calculation of node load.
boolean	isUseIoScore() Gets flag indicating whether I/O score should be used for calculation of node load.
boolean	isUseLongScore() Gets flag indicating whether long score should be used for calculation of node load.
boolean	isUseTrigonometryScore() Gets flag indicating whether trigonometry score should be used for calculation of node load.
void	setBenchmarkAttributeName(String benchmarkAttr) Sets name of node attribute by which node benchmarks should be accessed.
void	setUseDoulbeScore(boolean useDoubleScore) Sets flag indicating whether double score should be used for calculation of node load.
void	setUseIntegerScore(boolean useIntScore) Sets flag indicating whether integer score should be used for calculation of node load.
void	setUseIoScore(boolean useIoScore) Sets flag indicating whether I/O score should be used for calculation of node load.
void	setUseLongScore(boolean useLongScore) Sets flag indicating whether long score should be used for calculation of node load.
void	setUseTrigonometryScore(boolean useTrigScore) Sets flag indicating whether trigonometry score should be used for calculation of node load.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DFLT_BENCHMARK_ATTR

public static final String DFLT_BENCHMARK_ATTR

Default node attribute name for storing node benchmarks (value is 'grid.node.benchmark'). See GridNode.getAttribute(String) for more information.

See Also:

Constant Field Values

Constructor Detail

GridAdaptiveBenchmarkLoadProbe

public GridAdaptiveBenchmarkLoadProbe()

Creates benchmark probe with all defaults. By default, all scores provided in GridLocalNodeBenchmark class will be used.

GridAdaptiveBenchmarkLoadProbe

public GridAdaptiveBenchmarkLoadProbe(boolean useIntScore,
                                      boolean useLongScore,
                                      boolean useDoubleScore,
                                      boolean useTrigScore,
                                      boolean useIoScore)

Creates benchmark probe which allows use to specify which scores to use. See GridLocalNodeBenchmark for more information on which scores are available and how they are calculated.

Parameters:

useIntScore - Flag indicating whether to use integer score.

useLongScore - Flag indicating whether to use long score.

useDoubleScore - Flag indicating whether to use double score.

useTrigScore - Flag indicating whether to use trigonometry score.

useIoScore - Flag indicating whether to use I/O score.

GridAdaptiveBenchmarkLoadProbe

public GridAdaptiveBenchmarkLoadProbe(boolean useIntScore,
                                      boolean useLongScore,
                                      boolean useDoubleScore,
                                      boolean useTrigScore,
                                      boolean useIoScore,
                                      String benchmarkAttr)

Creates benchmark probe which allows use to specify which scores to use. See GridLocalNodeBenchmark for more information on which scores are available and how they are calculated.

This constructor also allows to specify the name of node attribute by which node benchmarks should be accessed.

Parameters:

useIntScore - Flag indicating whether to use integer score.

useLongScore - Flag indicating whether to use long score.

useDoubleScore - Flag indicating whether to use double score.

useTrigScore - Flag indicating whether to use trigonometry score.

useIoScore - Flag indicating whether to use I/O score.

benchmarkAttr - Name of node attribute by which node benchmarks should be accessed.

Method Detail

getBenchmarkAttributeName

public String getBenchmarkAttributeName()

Gets name of node attribute by which node benchmarks should be accessed. By default GridAdaptiveBenchmarkLoadProbe.DFLT_BENCHMARK_ATTR name is used.

Returns:

Name of node attribute by which node benchmarks should be accessed.

setBenchmarkAttributeName

public void setBenchmarkAttributeName(String benchmarkAttr)

Sets name of node attribute by which node benchmarks should be accessed. By default GridAdaptiveBenchmarkLoadProbe.DFLT_BENCHMARK_ATTR name is used.

Parameters:

benchmarkAttr - Name of node attribute by which node benchmarks should be accessed.

isUseIntegerScore

public boolean isUseIntegerScore()

Gets flag indicating whether integer score should be used for calculation of node load.

Returns:

Flag indicating whether integer score should be used for calculation of node load.

setUseIntegerScore

public void setUseIntegerScore(boolean useIntScore)

Sets flag indicating whether integer score should be used for calculation of node load.

Parameters:

useIntScore - Flag indicating whether integer score should be used for calculation of node load.

isUseLongScore

public boolean isUseLongScore()

Gets flag indicating whether long score should be used for calculation of node load.

Returns:

Flag indicating whether long score should be used for calculation of node load.

setUseLongScore

public void setUseLongScore(boolean useLongScore)

Sets flag indicating whether long score should be used for calculation of node load.

Parameters:

useLongScore - Flag indicating whether long score should be used for calculation of node load.

isUseDoulbeScore

public boolean isUseDoulbeScore()

Gets flag indicating whether double score should be used for calculation of node load.

Returns:

Flag indicating whether double score should be used for calculation of node load.

setUseDoulbeScore

public void setUseDoulbeScore(boolean useDoubleScore)

Sets flag indicating whether double score should be used for calculation of node load.

Parameters:

useDoubleScore - Flag indicating whether double score should be used for calculation of node load.

isUseTrigonometryScore

public boolean isUseTrigonometryScore()

Gets flag indicating whether trigonometry score should be used for calculation of node load.

Returns:

Flag indicating whether trigonometry score should be used for calculation of node load.

setUseTrigonometryScore

public void setUseTrigonometryScore(boolean useTrigScore)

Sets flag indicating whether trigonometry score should be used for calculation of node load.

Parameters:

useTrigScore - Flag indicating whether trigonometry score should be used for calculation of node load.

isUseIoScore

public boolean isUseIoScore()

Gets flag indicating whether I/O score should be used for calculation of node load.

Returns:

Flag indicating whether I/O score should be used for calculation of node load.

setUseIoScore

public void setUseIoScore(boolean useIoScore)

Sets flag indicating whether I/O score should be used for calculation of node load.

Parameters:

useIoScore - Flag indicating whether I/O score should be used for calculation of node load.

getLoad

public double getLoad(GridNode node,
                      int jobsSentSinceLastUpdate)

Calculates load value for a given node. Specific implementations would usually take into account some of the values provided by GridNode.getMetrics() method. For example, load can be calculated based on job execution time or number of active jobs, or CPU/Heap utilization.

Note that if GridAdaptiveLoadProbe.getLoad(GridNode, int) returns a value of 0, then implementation will assume that load value is simply not available and will try to calculate an average of load values for other nodes. If such average cannot be obtained (all node load values are 0), then a value of 1 will be used.

Specified by:

getLoad in interface GridAdaptiveLoadProbe

Parameters:

node - Grid node to calculate load for.

jobsSentSinceLastUpdate - Number of jobs sent to this node since last metrics update. This parameter may be useful when implementation takes into account the current job count on a node.

Returns:

Non-negative load value for the node (zero and above).

toString

public String toString()

Overrides:

toString in class Object