mirror of
https://github.com/corda/corda.git
synced 2024-12-29 09:18:58 +00:00
58 lines
3.3 KiB
Markdown
58 lines
3.3 KiB
Markdown
|
This module contains gradle tasks to make running the JMeter (http://jmeter.apache.org)
|
||
|
|
load generation tool against Corda nodes much easier and more useful. It does this by
|
||
|
|
providing a simple way to launch JMeter with the actual JMeter install coming
|
||
|
|
from downloaded dependencies, and by providing some Samplers that interact with
|
||
|
|
the Corda node via RPC.
|
||
|
|
|
||
|
|
To run up the JMeter UI, using the jmeter.properties in the resources folder,
|
||
|
|
type the following:
|
||
|
|
|
||
|
|
`./gradlew tools:jmeter:run`
|
||
|
|
|
||
|
|
You can then open the example script in "Example Flow Properties.jmx" via the File -> Open menu option. You need to
|
||
|
|
configure the host, ports, user name and password in the Java Sampler that correspond to your chosen target Corda node.
|
||
|
|
Simply running from the UI will result in the RPC client running inside the UI JVM.
|
||
|
|
|
||
|
|
If you wish to pass additional arguments to JMeter, you can do this:
|
||
|
|
|
||
|
|
`./gradlew tools:jmeter:run -PjmeterArgs="['-n', '-Ljmeter.engine=DEBUG']"`
|
||
|
|
|
||
|
|
The intention is to run against a remote Corda node or nodes, hosted on servers rather than desktops. To
|
||
|
|
this end, we leverage the JMeter ability to run remote agents that actually execute the tests, with these
|
||
|
|
reporting results back to the UI (or headless process if you so desire - e.g. for automated benchmarks). This is
|
||
|
|
supplemented with some additional convenience of automatically creating ssh tunnels to the remote nodes
|
||
|
|
(we don't want the JMeter ports open to the internet) in coordination with the jmeter.properties.
|
||
|
|
The remote agents then run close to the nodes, so the latency of RPC calls is minimised.
|
||
|
|
|
||
|
|
A Capsule (http://www.capsule.io) based launchable JAR is created that can be run with the simple command line
|
||
|
|
|
||
|
|
`java -jar jmeter-corda-<version>.jar`
|
||
|
|
|
||
|
|
Embedded in the JAR is all of the corda code for flows and RPC, as well as the jmeter.propeties. This
|
||
|
|
JAR will also include a properties file based on the hostname in the JMeter configuration,
|
||
|
|
so we allocate different SSH tunneled port numbers this way.
|
||
|
|
|
||
|
|
To launch JMeter with the tunnels automatically created:
|
||
|
|
|
||
|
|
`./gradlew tools:jmeter:run -PjmeterHosts="['hostname1', 'hostname2']"`
|
||
|
|
|
||
|
|
The list of hostnames should be of at least length one, with a maximum equal to the length of the remote_hosts
|
||
|
|
option in jmeter.properties. We effectively "zip" together the hostnames and that list to build the SSH tunnels.
|
||
|
|
The remote_hosts property helps define the ports (the hosts should always be local) used
|
||
|
|
for each host listed in jmeterHosts. Some additional ports are also opened based on some other
|
||
|
|
parts of the configuration to access the RMI registry and to allow return traffic
|
||
|
|
from remote agents.
|
||
|
|
|
||
|
|
The SSH tunnels can be started independently with:
|
||
|
|
|
||
|
|
`./gradlew tools:jmeter:runSsh -PjmeterHosts="['hostname1', 'hostname2']"`
|
||
|
|
|
||
|
|
For the ssh tunneling to work, an ssh agent must be running on your local machine with the
|
||
|
|
appropriate private key loaded. If the environment variable `SSH_AUTH_SOCK` is set, the code
|
||
|
|
assumes that a posix sshagent process is being used, if it is not set, it assumes that
|
||
|
|
[Pageant](https://www.ssh.com/ssh/putty/putty-manuals/0.68/Chapter9.html) is in use. If the
|
||
|
|
remote user name is different from the current user name, `-XsshUser <remote user name>`
|
||
|
|
can be used to set this, or in the gradle call:
|
||
|
|
|
||
|
|
`./gradlew tools:jmeter:runSsh -PjmeterHosts="['hostname1', 'hostname2']" -PsshUser="'username'"`
|