jmeter-prometheus-plugin
A JMeter plugin that exposes performance test results as Prometheus metrics via an HTTP API.
What is jmeter-prometheus-plugin?
jmeter-prometheus-plugin is a plugin for Apache JMeter that exposes performance test results as Prometheus metrics. It solves the problem of integrating JMeter load test data into Prometheus-based monitoring stacks by providing an HTTP API endpoint that Prometheus can scrape, enabling real-time visualization and alerting on test results.
Performance engineers and developers who use JMeter for load testing and want to integrate test results into Prometheus monitoring systems for real-time analysis and dashboarding.
Developers choose this plugin because it provides a seamless bridge between JMeter and Prometheus, offering highly configurable metric definitions, support for JMeter variables as labels, and specialized metrics like success ratios that handle edge cases properly.
Overview
A Prometheus Listener for Apache JMeter that exposes results in an http API
Use Cases
Best For
- Integrating JMeter load test results into Prometheus monitoring stacks
- Creating custom performance dashboards in Grafana using JMeter data
- Real-time monitoring of application performance during load tests
- Tracking success/failure ratios of API endpoints under load
- Measuring response time distributions across different test scenarios
- Exporting JMeter thread and JVM metrics to Prometheus
Not Ideal For
- Projects using non-Prometheus monitoring stacks like InfluxDB or ELK, as the plugin is specifically designed for Prometheus integration.
- Teams needing immediate, pre-configured dashboards without additional setup in Grafana or similar tools.
- Simple load testing scenarios where JMeter's built-in listeners or basic reporting tools are sufficient.
- Environments where exposing an HTTP endpoint for metric scraping poses security or network constraints.
Pros & Cons
Pros
Allows users to define metrics with custom names, types (histogram, summary, counter, gauge, success ratio), and labels, as detailed in the listener configuration matrix and examples like the simple_prometheus_example.jmx file.
Supports JMeter variables as label values, enabling contextual tagging based on test dynamics, shown in examples where variables like 'category' are used to generate label values in exposed metrics.
Special success ratio metric prevents NaN issues by ensuring zero values for success and failure counters, addressing a common monitoring problem as explained in the README's success ratio section.
Configuration element allows advanced users to interact with Prometheus metrics programmatically in test scripts, leveraging the Prometheus Java client API, as demonstrated in the config element examples.
Cons
The README admits that gauges were added without a clear use case, stating 'I'm not quite sure how Gauges make sense,' which can confuse users and limit practical application.
Requires users to manually define all metrics in listeners or config elements, which can be complex and time-consuming compared to plugins with pre-defined metric sets, as noted in the flexibility trade-off.
Lacks out-of-the-box visualization; users must create Grafana dashboards from scratch using provided examples, increasing setup effort for immediate monitoring needs.
Frequently Asked Questions
Related Projects
InfluxDB Community Template for JMeterInfluxDB Community Templates: Quickly collect & analyze time series data from a range of sources: Kubernetes, MySQL, Postgres, AWS, Nginx, Jenkins, and more.
jmeter-influxdb2-listener-pluginInflux DB v2.0 listener plugin for Apache JMeter. Provides the possibility to see the online dashboard (aggregation table, errors, the response body of failures).
jmeter-elasticsearch-backend-listenerJMeter plugin that lets you send sample results to an ElasticSearch engine to enable live monitoring of load tests.
JMeter-InfluxBD-Writer PluginPlugin for JMeter that allows to write load test data on-the-fly to influxDB.
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.