Constant throughput timer

Fri, 15 Nov 2002 03:42:57 -0800

Hi.

I'm attaching the code for a new Timer I've created which allows you to put the server under pre-specified load.

I've found this useful when the performance requirement to test against is in the lines of "the system should be able to serve X pages per minute with latencies lower than Y milliseconds." (Which is probably one of the best ways to express performance requirements).

To use it:

- Drop the two attached files in
src/components/org/apache/jmeter/timers/ConstantThroughputTimer.java
src/components/org/apache/jmeter/timers/gui/ConstantThroughputTimerGui.java

- Add the following resources to ./src/core/org/apache/jmeter/resources/messages.properties (and the corresponding translations, of course):
constant_throughput_timer_memo=Add a delay between sampling to attain constant throughput
constant_throughput_timer_title=Constant Throughput Timer
constant_throughput_timer_throughput=Thread Throughput (in samples per minute):

- Create your test, adding a Constant Throughput Timer to the Thread Group. (I've not tested the behaviour of this timer when placed at other levels, nor when combined with other timers).

- Run your test. Sampling will happen at the specified rate -- or as fast as possible if the system is not fast enough to attain that rate.

Note the rate is for the ensemble of all threads: adding more threads will cause each of them to run slower.

One difficulty I've encountered when writing this is that there's no method to signal a test component when the test is starting. I've assumed that a new timer object is created (or cloned) for every test run. The timer seems to behave as expected, so looks like this assumption is correct...

Salut,

Jordi.
/*
 * ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in
 * the documentation and/or other materials provided with the
 * distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 * if any, must include the following acknowledgment:
 * "This product includes software developed by the
 * Apache Software Foundation (http://www.apache.org/)."
 * Alternately, this acknowledgment may appear in the software itself,
 * if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 * "Apache JMeter" must not be used to endorse or promote products
 * derived from this software without prior written permission. For
 * written permission, please contact [EMAIL PROTECTED]
 *
 * 5. Products derived from this software may not be called "Apache",
 * "Apache JMeter", nor may "Apache" appear in their name, without
 * prior written permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

package org.apache.jmeter.timers;

import java.util.*;
import java.io.*;

import org.apache.jmeter.util.JMeterUtils;
import org.apache.jmeter.testelement.AbstractTestElement;

/************************************************************
 *  This class implements a constant throughput timer with its own panel and
 *  fields for value update and user interaction.
 *
 *@author     <a href="mailto:stefano@;apache.org">Stefano Mazzocchi</a>
 *@created    $Date: 2002/08/11 19:24:41 $
 *@version    $Revision: 1.1 $ $Date: 2002/08/11 19:24:41 $
 ***********************************************************/

public class ConstantThroughputTimer extends AbstractTestElement implements Timer, Serializable
{
	public final static String THROUGHPUT = "ConstantThroughputTimer.throughput";
	private static List addableList = new LinkedList();

	// The target time for the start of the next request:
	private long targetTime= 0;

	// Ideal interval between two requests to get the desired throughput:
	private long delay;

	/************************************************************
	 *  !ToDo (Constructor description)
	 ***********************************************************/
	public ConstantThroughputTimer()
	{
	}

	/************************************************************
	 *  !ToDo (Method description)
	 *
	 *@param  throughput  !ToDo (Parameter description)
	 ***********************************************************/
	public void setThroughput(long throughput)
	{
		setProperty(THROUGHPUT,new Long(throughput));
		delay= 60000/throughput;
	}

	public void setRange(double range) { }
	public double getRange() { return (double)0; }
	public void setDelay(long delay) { }
	public long getDelay() { return 0; }


	/************************************************************
	 *  !ToDoo (Method description)
	 *
	 *@return    !ToDo (Return description)
	 ***********************************************************/
	public long getThroughput()
	{
		Object throughput = getProperty(THROUGHPUT);
		if(throughput instanceof Long)
		{
			return ((Long)throughput).longValue();
		}
		else
		{
			return Long.parseLong((String)throughput);
		}
	}

	/************************************************************
	 *  !ToDo (Method description)
	 *
	 *@return    !ToDo (Return description)
	 ***********************************************************/
	public synchronized long delay()
	{
		long currentTime= System.currentTimeMillis();
		long currentTarget= targetTime==0 ? currentTime : targetTime;
		targetTime=currentTarget+delay;
		if (currentTime > currentTarget) return 0;
		return currentTarget-currentTime;
	}

	/************************************************************
	 *  !ToDo (Method description)
	 *
	 *@return    !ToDo (Return description)
	 ***********************************************************/
	public String toString()
	{
		return JMeterUtils.getResString("constant_throughput_timer_memo");
	}

	public Object clone() {
	  ConstantThroughputTimer result= (ConstantThroughputTimer)super.clone();
	  result.targetTime= 0;
	  return result;
	}
}

/*
 * ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in
 * the documentation and/or other materials provided with the
 * distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 * if any, must include the following acknowledgment:
 * "This product includes software developed by the
 * Apache Software Foundation (http://www.apache.org/)."
 * Alternately, this acknowledgment may appear in the software itself,
 * if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 * "Apache JMeter" must not be used to endorse or promote products
 * derived from this software without prior written permission. For
 * written permission, please contact [EMAIL PROTECTED]
 *
 * 5. Products derived from this software may not be called "Apache",
 * "Apache JMeter", nor may "Apache" appear in their name, without
 * prior written permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */
package org.apache.jmeter.timers.gui;
import java.awt.Font;
import java.awt.event.KeyEvent;
import java.awt.event.KeyListener;

import javax.swing.JComponent;
import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JTextField;
import javax.swing.border.Border;
import javax.swing.border.EmptyBorder;

import org.apache.jmeter.testelement.TestElement;
import org.apache.jmeter.timers.ConstantThroughputTimer;
import org.apache.jmeter.util.JMeterUtils;
import org.apache.jorphan.gui.layout.VerticalLayout;

/****************************************
 * Title: JMeter Description: Copyright: Copyright (c) 2000 Company: Apache
 *
 *@author    Michael Stover
 *@created   $Date: 2002/10/17 19:47:15 $
 *@version   1.0
 ***************************************/

public class ConstantThroughputTimerGui extends AbstractTimerGui implements KeyListener
{
	private final String DEFAULT_THROUGHPUT = "60";

	private final String THROUGHPUT_FIELD = "Throughput Field";
	private JTextField throughputField;

	/****************************************
	 * !ToDo (Constructor description)
	 ***************************************/
	public ConstantThroughputTimerGui()
	{
		init();
	}

	/****************************************
	 * !ToDo (Method description)
	 *
	 *@param e        !ToDo (Parameter description)
	 *@param thrower  !ToDo (Parameter description)
	 ***************************************/
	public static void error(Exception e, JComponent thrower)
	{
		JOptionPane.showMessageDialog(thrower, e, "Error", JOptionPane.ERROR_MESSAGE);
	}

	public String getStaticLabel()
	{
		return JMeterUtils.getResString("constant_throughput_timer_title");
	}

	public TestElement createTestElement()
	{
		ConstantThroughputTimer timer = new ConstantThroughputTimer();
		this.configureTestElement(timer);
		timer.setThroughput(Long.parseLong(throughputField.getText()));
		return timer;
	}

	public void configure(TestElement el)
	{
		super.configure(el);
		throughputField.setText(((ConstantThroughputTimer)el).getThroughput()+"");
	}

	/****************************************
	 * !ToDo (Method description)
	 *
	 *@param e  !ToDo (Parameter description)
	 ***************************************/
	public void keyReleased(KeyEvent e)
	{
		String n = e.getComponent().getName();
		if(n.equals(THROUGHPUT_FIELD))
		{
			try
			{
				Long.parseLong(throughputField.getText());
			}
			catch(NumberFormatException nfe)
			{
				if(throughputField.getText().length() > 0)
				{
					JOptionPane.showMessageDialog(this, "You must enter a valid number",
							"Invalid data", JOptionPane.WARNING_MESSAGE);
					// We reset the text to be an empty string instead
					// of the default value. If we reset it to the
					// default value, then the user has to delete
					// that value and reenter his/her own. That's
					// too much trouble for the user.
				}
			}
		}
	}

	/****************************************
	 * !ToDo (Method description)
	 *
	 *@param e  !ToDo (Parameter description)
	 ***************************************/
	public void keyPressed(KeyEvent e) { }

	/****************************************
	 * !ToDo (Method description)
	 *
	 *@param e  !ToDo (Parameter description)
	 ***************************************/
	public void keyTyped(KeyEvent e) { }

	private void init()
	{
		this.setLayout(new VerticalLayout(5, VerticalLayout.LEFT, VerticalLayout.TOP));

		// MAIN PANEL
		JPanel mainPanel = new JPanel();
		Border margin = new EmptyBorder(10, 10, 5, 10);
		mainPanel.setBorder(margin);
		mainPanel.setLayout(new VerticalLayout(5, VerticalLayout.LEFT));

		// TITLE
		JLabel panelTitleLabel = new JLabel(JMeterUtils.getResString("constant_throughput_timer_title"));
		Font curFont = panelTitleLabel.getFont();
		int curFontSize = curFont.getSize();
		curFontSize += 4;
		panelTitleLabel.setFont(new Font(curFont.getFontName(), curFont.getStyle(), curFontSize));
		mainPanel.add(panelTitleLabel);

		// NAME
		mainPanel.add(getNamePanel());

		// throughput
		JPanel throughputPanel = new JPanel();
		JLabel throughputLabel = new JLabel(JMeterUtils.getResString("constant_throughput_timer_throughput"));
		throughputPanel.add(throughputLabel);
		throughputField = new JTextField(6);
		throughputField.setText(DEFAULT_THROUGHPUT);
		throughputPanel.add(throughputField);
		mainPanel.add(throughputPanel);

		throughputField.addKeyListener(this);
		throughputField.setName(THROUGHPUT_FIELD);

		this.add(mainPanel);
	}
}


--
To unsubscribe, e-mail:   <mailto:jmeter-dev-unsubscribe@;jakarta.apache.org>
For additional commands, e-mail: <mailto:jmeter-dev-help@;jakarta.apache.org>

Reply via email to