Skip to content

Release Tags and Run Annotations

A release tag is a short label, usually a version number like v2.3.1, attached to one run of a load test. Tagged runs stand out on the Trend tab charts, so when response times or error rates shift between runs you can see at a glance which release the change lines up with.

Each annotation has two parts:

  • a Release tag: required, up to 64 characters
  • a Link: optional, an http:// or https:// URL, for example the release notes, the pull request, or the CI build

Release tags work for all three engines: cloud Load Testing, JMeter Load Testing and k6 Load Testing.

  1. Open a test result and switch to the Trend tab.
  2. Fill in the Release tag field (placeholder: e.g. v2.3.1) and, if you want, the Link (optional) field.
  3. Click Save. The status next to the button confirms with "Saved".

The form always annotates the run you are currently viewing. To tag an older run, open that run's result page first, then save the tag from its Trend tab.

To change a tag, edit the fields and save again. To remove it, clear the Release tag field and save; an empty tag deletes the annotation.

A pipeline can tag each run it starts through the Load Testing API. Start the test, wait until the new run number appears in the test list, then send testrunname, testrunid, label (the release tag) and optionally url as form fields to POST /api/test/general/run-annotation for a cloud test, or to /api/test/jmeter/run-annotation or /api/test/k6/run-annotation, with your API key in the loadfocus-auth header and your team id in team-id. An empty label removes the tag. The execute requests also accept releaseTag and releaseUrl, but they only take effect when the request carries the run's testrunid as well, which a new run does not have yet.

The Trend tab plots three charts across your recent runs: P95 response time, Error rate and Throughput. On each chart:

  • a run with a release tag is drawn as a larger diamond marker, while untagged runs are plain dots
  • hovering a tagged run shows the tag in the tooltip, with "click to open" when a link was saved
  • clicking a tagged point opens its link in a new tab

Marker colors keep their usual meaning from pass/fail thresholds; the diamond shape is what marks a release.

Annotations are stored per team, so everyone on the team sees the same tags on the same runs. Team members with a view-only role can see tags but cannot save or delete them.

  1. Your pipeline runs a load test on every deploy and tags the run with the version it deploys, for example v2.4.0.
  2. A week later the P95 trend jumps. On the Trend tab, the jump starts exactly at the v2.4.0 diamond.
  3. Click the marker to open the release notes and find the change that caused it, then compare the two runs with a baseline comparison.