org.perfcake.message.generator

Class RampUpDownGenerator

java.lang.Object

org.perfcake.message.generator.AbstractMessageGenerator

org.perfcake.message.generator.DefaultMessageGenerator

org.perfcake.message.generator.RampUpDownGenerator

All Implemented Interfaces:

MessageGenerator

public class RampUpDownGenerator
extends DefaultMessageGenerator

Generates maximal load using a variable number of threads.

The generating starts with the number of threads set to the value of the preThreadCount property. It continues to execute for the duration set by the preDuration property. The period is called the PRE phase. When PRE phase ends, the RAMP UP phase starts.

In the RAMP UP phase the number of threads is changed by the value of the rampUpStep property each period set by the rampUpStepPeriod until it reaches the number of threads set by the value of the mainThreadCount property.

In that moment MAIN phase starts and the execution continues for the duration set by the mainDuration property, after which the RAMP DOWN phase starts.

In the RAMP DOWN phase the number of threads is again changed but this time in the opposite direction than in the RAMP UP phase. It changes by the value of the rampDownStep property each period specified by the rampDownStepPeriod property until the final number of threads is reached. By that moment the final phase called POST starts.

The POST phase ends by the end of the scenario execution.

The outer borders of the number of threads and the duration is set by the maximum number of threads specified by the threads attribute of the generator and by the maximum duration set by the run element.

Author:

Pavel Macík

Constructor Summary

Constructors

Constructor and Description
RampUpDownGenerator()

Method Summary

Modifier and Type	Method and Description
void	generate() Generates the messages.
long	getMainDuration() Gets a duration period for which the MAIN phase lasts.
int	getMainThreadCount() Gets a maximal number of threads - the number of threads used in the MAIN phase.
int	getPostThreadCount() Gets a final number of threads - the number of threads in the POST phase.
long	getPreDuration() Gets duration period of the PRE phase, before the RAMP UP phase starts.
int	getPreThreadCount() Gets an initial number of threads - the number of threads in the PRE phase.
int	getRampDownStep() Gets a number by which the number of threads is changed in the RAMP DOWN phase.
long	getRampDownStepPeriod() Gets a duration period after which the number of threads is changed in RAMP DOWN phase.
int	getRampUpStep() Gets a number by which the number of threads is changed in the RAMP UP phase.
long	getRampUpStepPeriod() Gets a duration period after which the number of threads is changed in RAMP UP phase.
void	init(MessageSenderManager messageSenderManager, List<MessageTemplate> messageStore) Initializes the generator.
RampUpDownGenerator	setMainDuration(long mainDuration) Sets a duration period for which the MAIN phase lasts.
RampUpDownGenerator	setMainThreadCount(int mainThreadCount) Sets a maximal number of threads - the number of threads used in the MAIN phase.
RampUpDownGenerator	setPostThreadCount(int postThreadCount) Sets a final number of threads - the number of threads in the POST phase.
RampUpDownGenerator	setPreDuration(long preDuration) Sets duration period of the PRE phase, before the RAMP UP phase starts.
RampUpDownGenerator	setPreThreadCount(int preThreadCount) Sets a final number of threads - the number of threads in the PRE phase.
RampUpDownGenerator	setRampDownStep(int rampDownStep) Sets a number by which the number of threads is changed in the RAMP DOWN phase.
RampUpDownGenerator	setRampDownStepPeriod(long rampDownStepPeriod) Sets a duration period after which the number of threads is changed in RAMP DOWN phase.
RampUpDownGenerator	setRampUpStep(int rampUpStep) Sets a number by which the number of threads is changed in the RAMP UP phase.
RampUpDownGenerator	setRampUpStepPeriod(long rampUpStepPeriod) Sets a duration period after which the number of threads is changed in RAMP UP phase.

Methods inherited from class org.perfcake.message.generator.DefaultMessageGenerator

getDuration, getMonitoringPeriod, getSenderTaskQueueSize, getShutdownPeriod, setMonitoringPeriod, setReportManager, setSenderTaskQueueSize, setShutdownPeriod

Methods inherited from class org.perfcake.message.generator.AbstractMessageGenerator

close, getActiveThreadsCount, getTasksInQueue, getThreads, interrupt, isFailFast, setCorrelator, setRunInfo, setSequenceManager, setThreads, setValidationManager

Methods inherited from class java.lang.Object

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

Constructor Detail

RampUpDownGenerator

public RampUpDownGenerator()

Method Detail

init

public void init(MessageSenderManager messageSenderManager,
                 List<MessageTemplate> messageStore)
          throws PerfCakeException

Description copied from class: AbstractMessageGenerator

Initializes the generator. During the initialization the AbstractMessageGenerator.messageSenderManager is initialized as well.

Specified by:

init in interface MessageGenerator

Overrides:

init in class AbstractMessageGenerator

Parameters:

messageSenderManager - Message sender manager.

messageStore - Message store where the messages are taken from.

Throws:

PerfCakeException - When it was not possible to initialize the generator.

generate

public void generate()
              throws Exception

Description copied from class: AbstractMessageGenerator

Generates the messages. This actually executes the whole performance test.

Specified by:

generate in interface MessageGenerator

Overrides:

generate in class DefaultMessageGenerator

Throws:

Exception - When it was not possible to generate the messages.

getPreThreadCount

public int getPreThreadCount()

Gets an initial number of threads - the number of threads in the PRE phase.

Returns:

The final number of threads.

setPreThreadCount

public RampUpDownGenerator setPreThreadCount(int preThreadCount)

Sets a final number of threads - the number of threads in the PRE phase.

Parameters:

preThreadCount - The initial number of threads.

Returns:

Instance of this to support fluent API.

getPostThreadCount

public int getPostThreadCount()

Gets a final number of threads - the number of threads in the POST phase.

Returns:

The final number of threads.

setPostThreadCount

public RampUpDownGenerator setPostThreadCount(int postThreadCount)

Sets a final number of threads - the number of threads in the POST phase.

Parameters:

postThreadCount - The final number of threads.

Returns:

Instance of this to support fluent API.

getPreDuration

public long getPreDuration()

Gets duration period of the PRE phase, before the RAMP UP phase starts.

Returns:

PRE phase duration period in the units of run type.

setPreDuration

public RampUpDownGenerator setPreDuration(long preDuration)

Sets duration period of the PRE phase, before the RAMP UP phase starts.

Parameters:

preDuration - PRE phase duration period in the units of run type.

Returns:

Instance of this to support fluent API.

getRampUpStep

public int getRampUpStep()

Gets a number by which the number of threads is changed in the RAMP UP phase.

Returns:

The size of the step.

setRampUpStep

public RampUpDownGenerator setRampUpStep(int rampUpStep)

Sets a number by which the number of threads is changed in the RAMP UP phase.

Parameters:

rampUpStep - The size of the step.

Returns:

Instance of this to support fluent API.

getRampUpStepPeriod

public long getRampUpStepPeriod()

Gets a duration period after which the number of threads is changed in RAMP UP phase.

Returns:

The RAMP UP step duration period in a units of run type.

setRampUpStepPeriod

public RampUpDownGenerator setRampUpStepPeriod(long rampUpStepPeriod)

Sets a duration period after which the number of threads is changed in RAMP UP phase.

Parameters:

rampUpStepPeriod - The RAMP UP step duration period in a units of run type.

Returns:

Instance of this to support fluent API.

getRampDownStep

public int getRampDownStep()

Gets a number by which the number of threads is changed in the RAMP DOWN phase.

Returns:

The size of the step.

setRampDownStep

public RampUpDownGenerator setRampDownStep(int rampDownStep)

Sets a number by which the number of threads is changed in the RAMP DOWN phase.

Parameters:

rampDownStep - The size of the step.

Returns:

Instance of this to support fluent API.

getRampDownStepPeriod

public long getRampDownStepPeriod()

Gets a duration period after which the number of threads is changed in RAMP DOWN phase.

Returns:

The RAMP DOWN step duration period in a units of run type.

setRampDownStepPeriod

public RampUpDownGenerator setRampDownStepPeriod(long rampDownStepPeriod)

Sets a duration period after which the number of threads is changed in RAMP DOWN phase.

Parameters:

rampDownStepPeriod - The RAMP DOWN step duration period in a units of run type.

Returns:

Instance of this to support fluent API.

getMainDuration

public long getMainDuration()

Gets a duration period for which the MAIN phase lasts.

Returns:

The MAIN phase duration period in the units of run type.

setMainDuration

public RampUpDownGenerator setMainDuration(long mainDuration)

Sets a duration period for which the MAIN phase lasts.

Parameters:

mainDuration - The MAIN phase duration period in the units of run type.

Returns:

Instance of this to support fluent API.

getMainThreadCount

public int getMainThreadCount()

Gets a maximal number of threads - the number of threads used in the MAIN phase.

Returns:

The maximal number of threads.

setMainThreadCount

public RampUpDownGenerator setMainThreadCount(int mainThreadCount)

Sets a maximal number of threads - the number of threads used in the MAIN phase.

Parameters:

mainThreadCount - The maximal number of threads.

Returns:

Instance of this to support fluent API.