JMXPress

Getting started#

From an account you have just been given, to a finished report. Nothing here assumes you have used JMXPress before.

1. Sign in#

Open your installation's address and sign in with the email and password you were given. If you registered yourself rather than being added by an administrator, your account may be waiting for approval — see Accounts and access.

You will be asked to change your password on first sign-in if the account was created with a temporary one.

2. Find your way around#

The bar across the top is the whole product:

  • Dashboard — what has run, what is running, and the machines tests can run on.
  • APM Tools — connections to your monitoring, and dashboards built from them.
  • Projects — a plan kept with its environments, variables and test data.
  • Recording — capturing a journey through a browser.
  • Utilities — converters, editors and analysers.
  • Execution — project configuration, the Run page, and history.
  • Report — report generation, comparisons and the JTL analyzer.

3. Get a test plan#

You need a JMeter plan. There are three ways to get one, and they are all covered in their own pages:

  1. Record one. Open Recording, start a session, and walk through the journey in the browser it opens. See Recording a journey.
  2. Convert something you already have. A Postman collection, a HAR file, a cURL command, an OpenAPI specification, a LoadRunner or NeoLoad project. See Converting what you have.
  3. Bring a .jmx file. If you already have one, you can upload it straight on the Run page.

4. Run it#

Open Execution → Run. Choose a plan from a project, or drop a .jmx onto the page.

Set the load: threads, ramp-up and either a loop count or a duration. Leaving a box empty uses whatever the plan itself says, which is usually what you want the first time.

If the plan reads a CSV, JMXPress tells you which files it needs by name before anything runs, so a missing file is caught then rather than by a test that quietly sends ${username} to your application.

Press Run test.

5. Watch it#

The Live results panel appears once the run starts. It has two halves:

  • Client-side metrics — samples, errors, throughput and percentiles, read from the results file as JMeter writes it.
  • Server-side metrics — figures from your APM provider, if you switched monitoring on before starting.

See Live results for what each figure means and why the two halves will not match exactly.

6. Keep the report#

When the run finishes you can generate a report from the results file: charts, tables and the summary, in a form you can send to somebody who was not watching. See Reports.

If the run was monitored, the APM figures collected for its window are kept with it and can be opened from the run's report.