UbikLoadPack Observability Plugin for JMeter

May 6, 2023 · View on GitHub

UbikLoadPack observability plugin is a Free and Open-Source plugin for Apache JMeter which allows you to monitor a Non GUI/Cli performance test (Standalone or distributed) from your favority browser.

It also exposes an Open Metrics endpoint so that OpenMetrics compatible tools like Prometheus can scrape it and make metrics of your performance test available in these tools.

It is easily installable through JMeter-Plugins manager:

 ./PluginsManagerCMD.sh install ulp-observability-plugin

See in this blog the pre-requisites to install any plugin this way.

Metrics displayed:

  • Name of the Sampler used for the load test
  • Number of requests
  • % Error
  • Average time
  • Percentiles 1 (aggregate_rpt_pct1 property)
  • Percentiles 2 (aggregate_rpt_pct2 property)
  • Percentiles 3 (aggregate_rpt_pct3 property)
  • Max time
  • Throughput in req/s

JMeter Plugin configuration

Blog showing installation procedure

Screenshots


Observability Listener JMeter Control Panel

Logs by the plugin in console



Example of metrics summary in non-graphical mode

Browser view

Screenshots


Example of a metric chart

  • Left y-axis: metric of each group of samples
  • Right y-axis: cumulative number of threads in each group of samples
  • Graphs currently implemented for: average response, maximum response, percentiles, error percentage and throughput


Example summary of total metrics

Connecting the plugin to Prometheus

Legende

Blog

Blog showing how to connect Prometheus to plugin

### Install Prometheus

  • If you haven't installed prometheus on your device yet, Download the latest release of Prometheus for your platform, then extract it.
  • If you use Windows, add the extracted directory to the PATH env variable.
  • If you use Linux, add it to the $PATH variable. Add it to the .bashrc file to make it permanent.

Configure Prometheus

Inside the directory of your JMeter test plan, add the following prometheus.yml file :

global:
  scrape_interval:     15s # By default, scrape targets every 15 seconds.

  # Attach these labels to any time series or alerts when communicating with
  # external systems (federation, remote storage, Alertmanager).
  external_labels:
    monitor: 'codelab-monitor'

# A Configuration containing Observability plugin endpoint to scrape:

scrape_configs:
  - job_name: 'observability-plugin'
    scrape_interval: 5s
    metrics_path: /ulp-o-metrics

    static_configs:
      - targets: ['localhost:9090']

Change 'localhost:9090' above to match the host:port where plugin is running and listening.

Endpoint content exposed by the plugin



Sample response from Jetty server for sample metrics in OpenMetrics format

### Launch Prometheus

  • cd to the test plan directory
  • then enter this command to start using prometheus (on port 9095, change it with the one you prefer) :
prometheus  --web.enable-admin-api   --web.listen-address=:9095 --config.file=prometheus.yml
  • You can then access Prometheus from this url

Roadmap

See our repository issues

Want to contribute

Read our Contributor documentation