Skip to content
Tutorials Center
My learning

Topics

Lesson 5 of 37 ยท Concepts and Setup

The JMeter GUI Tour: Tree, Toolbar, Menus and Log

Tour the Apache JMeter interface: the test plan tree, toolbar buttons, menus, templates, search, the log viewer, the function helper and keyboard shortcuts that speed up work.

JMeter's window has a small number of parts, and once you know what each one is for, building plans becomes fast. The interface is plain rather than pretty, but it hides several time-savers: templates, drag and drop, disable toggles, search, and a function helper. This lesson walks through all of them.

Honesty note. The GUI cannot run here, so menus and buttons are described from the documented interface. Exact icons and a few menu positions vary slightly between versions. The runnable block is a stand-in that models a plan tree and shows how enabling and disabling nodes works.

The main window

The window is split into three areas:

  1. The tree (left). Every element of your plan: Test Plan, Thread Groups, samplers, listeners. Right-click a node to add children, cut, copy, paste, duplicate, disable, or save it as a separate file ("Save Selection As...").
  2. The editor (right). Selecting a node shows its settings panel. Every element has a Name and Comments field: use them. A plan full of nodes called "HTTP Request" is unreadable.
  3. The toolbar (top). Icons for New, Templates, Open, Save, Cut/Copy/Paste, Expand/Collapse, Toggle, Start, Start no pauses, Stop, Shutdown, Clear, Clear All, Search, Reset Search, Function Helper, and Help. Top right: the warning/error counter, a small clock with the elapsed time, and the active threads / total threads counter.

Two nodes are always present besides your Test Plan: WorkBench (older versions) and the new Non-Test Elements area, which holds things that are not part of the plan itself, such as the HTTP(S) Test Script Recorder.

The menus

Menu What you use it for
File New, Templates, Open, Merge, Save, Save As, Save Test Fragment As, Revert
Edit Add elements, Cut/Copy/Paste, Duplicate, Remove, Disable, Open recently used
Search Find text in the plan, replace in all elements
Run Start, Start no pauses, Validate, Stop, Shutdown, Remote Start/Stop, Clear, Clear All
Options Look and Feel, Choose Language, Log viewer, Function Helper dialog, SSL Manager, Plugins Manager
Tools Create HTML report, Import from cURL, Load/Reload Test Plan listeners, Check for updates
Help Online documentation, About

Useful details:

  • Start respects timers and pauses; Start no pauses ignores timers, which is handy when debugging a long think time.
  • Validate runs one iteration with every Thread Group set to a single thread, ignoring timers and loop counts.
  • Stop ends threads immediately (interrupting running requests); Shutdown waits for current samples to finish. Prefer Shutdown for clean results.
  • Tools > Import from cURL turns a copied curl command (from browser dev tools) into an HTTP Request sampler. A great way to build requests for APIs.
  • File > Templates offers starter plans, including a "Recording" template and a simple web test.

Working with the tree

flowchart TD
  TP["Test Plan"] --> TG["Thread Group"]
  TP --> NT["Non-Test Elements"]
  TG --> S1["HTTP Request: Home"]
  TG --> S2["HTTP Request: Search"]
  S2 --> A["Response Assertion"]
  TG --> LS["Listener: Summary Report"]

The tree defines both the order of samplers and the scope of everything else.

Habits that save time:

  • Drag and drop nodes to reorder them or move them into other parents. Order matters: samplers run top to bottom.
  • Ctrl+C / Ctrl+V copies an element with all its children; Ctrl+Shift+C duplicates a node.
  • Toggle (Ctrl+T) disables or enables a node. A disabled node and its children are shown greyed out and are skipped at run time but kept in the file.
  • Ctrl+Shift+Up / Down moves a node; Ctrl+Left / Right collapses or expands a branch.
  • Rename with a clear pattern, for example 01 Login, 02 Search, 03 Add to cart. These names become the labels in reports.

The log and warning counter

JMeter writes a log (jmeter.log in the folder where you started it). In the GUI the yellow triangle at the top right shows how many warnings or errors were logged; click it to open the Log Viewer panel. Checking it after a run is a good habit: script errors, JSR223 exceptions and missing files show up there before they show in results.

In non-GUI mode use -j run.log to choose the log file, and change log verbosity with -L org.apache.jmeter=DEBUG (use sparingly: debug logs are huge).

Function Helper and searching

Options > Function Helper Dialog lets you pick a function, such as __Random or __time, fill in its parameters and copy the finished expression (for example ${__Random(1,100,)}) to paste into a field. It is the fastest way to learn function syntax; see Variables, properties and functions.

Ctrl+F searches the plan for text, such as an old hostname. Replace All edits matching text across every element's fields, which is powerful and worth checking afterwards.

Keyboard shortcuts worth learning

Shortcut Action
Ctrl+S Save
Ctrl+R Start test
Ctrl+Shift+S Start without pauses
Ctrl+. Stop
Ctrl+, Shutdown
Ctrl+E Clear (selected listener)
Ctrl+Shift+E Clear All
Ctrl+T Toggle (enable/disable)
Ctrl+Shift+C Duplicate

Menu items show the shortcut next to them on your platform, which is the reliable reference since some keys differ on macOS.

Stand-in: a plan tree with disabled nodes

The block below builds a tiny plan tree as data, marks one node disabled, and walks it the way JMeter's engine does, skipping disabled branches and keeping depth-first, top-to-bottom order.

JS Stand-in: walk a plan tree, skipping disabled nodes

Press Run (or Ctrl + Enter) to see the console output here.

No output.

Preferences worth setting

In user.properties: set jmeter.save.saveservice.output_format=csv (the default) for compact result files, and consider jmeter.save.saveservice.response_data=false to avoid storing huge response bodies in result files during load. Through Options > Look and Feel pick a theme you can read for hours.

Check your understanding

Quick check ยท 4 questions

of 4 answered You scored / 4 ยท perfect!

  1. 1. Which action ends a run gracefully, letting running samples complete?

    Shutdown waits for current samples to finish. Stop interrupts threads right away.
  2. 2. What does disabling a node with Toggle do?

    Disabled nodes are greyed out and ignored during the run, but stay in the plan.
  3. 3. Which tool turns a copied curl command into a sampler?

    Import from cURL converts a curl command (for example from browser dev tools) into an HTTP Request.
  4. 4. Why give every element a clear name?

    Sampler names are the labels in listeners, JTL files and the HTML dashboard.

Summary

  • The window has a tree (structure), an editor (settings) and a toolbar (run controls and counters).
  • Prefer Shutdown over Stop, use Validate for a quick single-thread check.
  • Drag, copy, duplicate and toggle nodes; name them clearly with a numbering scheme.
  • The Log Viewer and the warning counter reveal script problems early.
  • Function Helper and Import from cURL save typing and mistakes.

Next: Test Plan Elements and Execution Order