[Apache JMeter Wiki] Updated: UserManual/GettingStarted

[ja...@apache.org]

   Date: 2005-03-07T06:17:10
   Editor: MichaelStover
   Wiki: Apache JMeter Wiki
   Page: UserManual/GettingStarted
   URL: http://wiki.apache.org/jakarta-jmeter/UserManual/GettingStarted

   no comment

Change Log:

------------------------------------------------------------------------------
@@ -58,3 +58,120 @@
 
 [[Anchor(installation)]]
 ==  Installation ==
+
+Installing JMeter is a snap. Specifics depend on which release file you downloaded.
+
+=== Downloading the Latest Release ===
+
+We recommend that most users run the [http://jakarta.apache.org/site/downloads/downloads_jmeter.cgi latest release].
+
+To install a release build, simply unzip the zip/tar file into the directory where you want JMeter to be installed. Provided that you have a JDK correctly installed and the JAVA_HOME environment variable set, there is nothing more for you to do.
+
+=== Downloading Nightly Builds ===
+
+If you do not mind working with beta-quality software, then you can download and run the latest nightly build.
+
+To install a nightly build, unzip the zip/tar file into the directory where you want JMeter to be installed. Then, open a shell or command prompt and change to JMeter's top-level directory. Next, type "build install". Provided that you have a JDK correctly installed and the JAVA_HOME environment variable set, JMeter should be installed successfully.
+[[Anchor(running)]]
+== Running JMeter ==
+
+To run JMeter, run the jmeter.bat (for Windows) or jmeter (for Unix) file.
+[[Anchor(classpath)]]
+===  JMeter's Classpath ===
+
+JMeter automatically finds classes from jars in its /lib and /lib/ext directories. If you want to add other JAR files to JMeter's classpath, then you must copy them to JMeter's "lib" directory. If you have developed new JMeter specific components, then you should jar them and copy the jar into JMeter's /lib/ext directory. JMeter will automatically find JMeter components in any jars found here.
+
+You can also install utility Jar files in $JAVA_HOME/jre/lib/ext
+
+Note that setting the CLASSPATH environment variable will have no effect. This is because JMeter is started with "java -jar", and the java command silently ignores the CLASSPATH variable, and the -classpath/-cp options when -jar is used. [This occurs with all Java programs, not just JMeter.]
+
+=== Using a Proxy Server ===
+
+If you are testing from behind a firewall/proxy server, you may need to provide JMeter with the firewall/proxy server hostname and port number. To do so, run the jmeter.bat/jmeter file from a command line with the following parameters:
+
+    -H [proxy server hostname or ip address]
+
+    -P [proxy server port]
+
+    -u [username for proxy authentication - if required]
+
+    -a [password for proxy authentication - if required]
+
+    {{{jmeter -H my.proxy.server -P 8000 -u username -a password}}}
+
+Alternatively, you can use --proxyHost, --proxyPort, --username, and --password
+
+===  Non-GUI Mode ===
+
+For non-interactive testing, you may choose to run JMeter without the GUI. To do so, use the following command options
+
+    -n This specifies JMeter is to run in non-gui mode
+
+    -t [name of JMX file that contains the Test Plan].
+
+    -l [name of JTL file to log sample results to].
+
+    -r Run all remote servers specified in jmeter.properties (or remote servers specified on command line by overriding properties)
+
+The script also lets you specify the optional firewall/proxy server information:
+
+    -H [proxy server hostname or ip address]
+
+    -P [proxy server port]
+
+    {{{jmeter -n -t my_test.jmx -l log.jtl -H my.proxy.server -P 8000}}}
+
+=== Server Mode ===
+
+For distributed testing , run JMeter in server mode, and then control each server from the GUI.
+
+{{{The jmeter-server/jmeter-server.bat script should start rmiregistry for you with the appropriate classpath. if it fails to do so, [:../Remote: read the details] about starting the jmeter server.}}}
+
+Run jmeter-server/jmeter-server.bat, plus these optional commands:
+
+The script also lets you specify the optional firewall/proxy server information:
+
+    -H [proxy server hostname or ip address]
+
+    -P [proxy server port]
+
+    {{{jmeter-server -H my.proxy.server -P 8000}}}
+
+=== Overriding Properties Via The Command Line ===
+
+Java system properties, JMeter properties, and logging properties can be overriden directly on the command line (instead of modifying jmeter.properties). To do so, use the following options:
+
+    -D[prop_name]=[value] - defines a java system property value.
+
+    -J[prop name]=[value] - overrides a JMeter property.
+
+    -L[category]=[priority] - overrides a logging setting, setting a particular category to the given priority level.
+
+The -L flag can also be used without the category name to set the root logging level.
+
+'''Examples:'''
+
+   {{{jmeter -Duser.dir=/home/mstover/jmeter_stuff -Jremote_hosts=127.0.0.1 -Ljmeter.engine=DEBUG}}}
+
+   {{{jmeter -LDEBUG}}}
+
+The command line properties are processed early in startup, but after the logging system has been set up. Attempts to use the -J flag to update log_level or log_file properties will have no effect.
+
+=== Logging and error messages ===
+
+If JMeter detects an error, a message will be written to the log file. The log file name is defined in the jmeter.properties file. It is normally defined as jmeter.log , and will be found in the JMeter startup directory, i.e. bin.
+
+When running on Windows, the file may appear as just jmeter unless you have set Windows to show file extensions. [Which you should do anyway, to make it easier to detect viruses and other nasties that pretend to be text files...]
+
+As well as recording errors, the jmeter.log file records some information about the test run. For example:
+
+ {{{10/17/2003 12:19:20 PM INFO  - jmeter.JMeter: Version 1.9.20031002
+10/17/2003 12:19:45 PM INFO  - jmeter.gui.action.Load: Loading file: c:\mytestfiles\BSH.jmx
+10/17/2003 12:19:52 PM INFO  - jmeter.engine.StandardJMeterEngine: Running the test!
+10/17/2003 12:19:52 PM INFO  - jmeter.engine.StandardJMeterEngine: Starting 1 threads for group BSH. Ramp up = 1.
+10/17/2003 12:19:52 PM INFO  - jmeter.engine.StandardJMeterEngine: Continue on error
+10/17/2003 12:19:52 PM INFO  - jmeter.threads.JMeterThread: Thread BSH1-1 started
+10/17/2003 12:19:52 PM INFO  - jmeter.threads.JMeterThread: Thread BSH1-1 is done
+10/17/2003 12:19:52 PM INFO  - jmeter.engine.StandardJMeterEngine: Test has ended}}}
+
+The log file can be helpful in determining the cause of an error, as JMeter does not interrupt a test to display an error dialogue.

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