The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

JMeter Load Testing in the Cloud for CI/CD by LoadFocus

View this plugin on the Plugins site

loadfocusJMeterTest: Run a LoadFocus JMeter load test

  • testId : String
    The LoadFocus JMeter test to run. The dropdown shows each test's name and last run id. In a Pipeline, pass the test name: loadfocusJMeterTest testId: 'my-test', useVerdict: true.
  • credentialsId : String (optional)
    The LoadFocus API key to use: a "LoadFocus.com API key" credential or a standard "Secret text" credential holding the key. "Default API Key" uses the key selected in Manage Jenkins > System.
  • errorFailedThreshold : int (optional)
  • errorRatePct : double (optional)
  • errorUnstableThreshold : int (optional)
  • minRps : double (optional)
  • p95Ms : int (optional)
    Pass/fail thresholds for the whole run, managed from Jenkins. When any of P95, P99, error rate or minimum throughput is set, they are saved to the test on loadfocus.com before the run (replacing the thresholds configured there; the ones left empty are cleared) and the LoadFocus verdict is checked afterwards. Leave all empty to keep managing thresholds on loadfocus.com.
  • p99Ms : int (optional)
  • releaseTag : String (optional)
    Custom label for the run, e.g. a version or commit (${GIT_COMMIT} is expanded). Max 64 characters.
  • responseTimeFailedThreshold : int (optional)
  • responseTimeUnstableThreshold : int (optional)
  • shareReport : boolean (optional)
    Create a public share link for the finished run and show it on the build's LoadFocus.com Results page. Anyone with the link can view the report. When unchecked, the build links to the results page on loadfocus.com, which requires a LoadFocus login.
  • tagRun : boolean (optional)
    Label the LoadFocus run with the Jenkins build that started it (default "Jenkins <job> #<build>", linking back to the build), so runs can be matched to builds on the LoadFocus results and trend pages.
  • timeoutMinutes : int (optional)
    Fail the build if the load test has not finished within this many minutes. Default: 120.
  • useVerdict : boolean (optional)
    After the run, ask LoadFocus for its pass/fail verdict against the thresholds configured for this test on loadfocus.com (P95/P99 response time, error rate, minimum throughput, Core Web Vitals budgets). A failing verdict, or a threshold that could not be evaluated, marks the build FAILURE. If no thresholds are enabled for the test, the build is marked UNSTABLE. Can be combined with the error percentage and response time thresholds above; the worst result wins.

step([$class: 'LoadPublisher']): JMeter Load Testing in Cloud by LoadFocus

  • testId : String
    The LoadFocus JMeter test to run. The dropdown shows each test's name and last run id. In a Pipeline, pass the test name: loadfocusJMeterTest testId: 'my-test', useVerdict: true.
  • credentialsId : String (optional)
    The LoadFocus API key to use: a "LoadFocus.com API key" credential or a standard "Secret text" credential holding the key. "Default API Key" uses the key selected in Manage Jenkins > System.
  • errorFailedThreshold : int (optional)
  • errorRatePct : double (optional)
  • errorUnstableThreshold : int (optional)
  • minRps : double (optional)
  • p95Ms : int (optional)
    Pass/fail thresholds for the whole run, managed from Jenkins. When any of P95, P99, error rate or minimum throughput is set, they are saved to the test on loadfocus.com before the run (replacing the thresholds configured there; the ones left empty are cleared) and the LoadFocus verdict is checked afterwards. Leave all empty to keep managing thresholds on loadfocus.com.
  • p99Ms : int (optional)
  • releaseTag : String (optional)
    Custom label for the run, e.g. a version or commit (${GIT_COMMIT} is expanded). Max 64 characters.
  • responseTimeFailedThreshold : int (optional)
  • responseTimeUnstableThreshold : int (optional)
  • shareReport : boolean (optional)
    Create a public share link for the finished run and show it on the build's LoadFocus.com Results page. Anyone with the link can view the report. When unchecked, the build links to the results page on loadfocus.com, which requires a LoadFocus login.
  • tagRun : boolean (optional)
    Label the LoadFocus run with the Jenkins build that started it (default "Jenkins <job> #<build>", linking back to the build), so runs can be matched to builds on the LoadFocus results and trend pages.
  • timeoutMinutes : int (optional)
    Fail the build if the load test has not finished within this many minutes. Default: 120.
  • useVerdict : boolean (optional)
    After the run, ask LoadFocus for its pass/fail verdict against the thresholds configured for this test on loadfocus.com (P95/P99 response time, error rate, minimum throughput, Core Web Vitals budgets). A failing verdict, or a threshold that could not be evaluated, marks the build FAILURE. If no thresholds are enabled for the test, the build is marked UNSTABLE. Can be combined with the error percentage and response time thresholds above; the worst result wins.

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.