locust-plugins

What it is and what it does

Locust Plugins is a curated collection of extensions that fill gaps in Locust's core load-testing toolkit. Locust itself is intentionally minimal—it handles HTTP well but leaves protocol support, data ingestion, and result reporting to users. This package bundles solutions for common needs: listeners that send results to TimescaleDB, Grafana, Azure Application Insights, or JMeter-compatible files; user classes for Playwright, Selenium, Kafka, and FTP; data readers for CSV and MongoDB; and utility functions for wait times, transaction logging, and distributed test-data management.

The package is designed to evolve faster than Locust core by staying separate, allowing developers to add plugins without bloating the main tool. It supports Python 3.10, 3.11, and 3.12, and is actively maintained. Installation is straightforward, and most configuration happens in code, with some options exposed as command-line arguments.

Use it for:

• Load test non-HTTP systems (Kafka, FTP, WebSocket) by using protocol-specific user classes instead of writing custom clients.
• Feed test data from CSV or MongoDB into load tests while maintaining order across distributed workers.
• Monitor load test results in real-time dashboards (Grafana + TimescaleDB) or export to JMeter format.
• Aggregate multi-step workflows as transactions and log them separately from individual requests.
• Set performance gates using command-line checks (e.g., fail if RPS or error rate thresholds are exceeded).
• Distribute test data from a master node to worker nodes while preserving order for stateful tests.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Extends Locust with plugins for load testing non-HTTP protocols, reading test data, listening to results, and command-line tools to reduce boilerplate in performance test scripts.

Yes. Low install friction, active maintenance, permissive Apache-2.0 license, and no known vulnerabilities. Install if you use Locust and need any of its plugins (non-HTTP protocols, data readers, result listeners, or command-line checks). Skip only if your load tests are purely HTTP and you have no need for the bundled extensions.

Install

locust-plugins on PyPI

pip install locust-plugins

uv add locust-plugins

poetry add locust-plugins

Installing locust-plugins

Before you install

Low friction installation as a pure-Python wheel. Active maintenance with a recent release and repository activity. Depends only on locust and typing-extensions.

License in practice

Licensed under Apache-2.0 (permissive). You may use, modify, and distribute freely in commercial and private projects, provided you include a copy of the license and state material changes.

Quickstart

pip install locust-plugins

from locust_plugins.users import WebdriverUser
from locust import task

class MyUser(WebdriverUser):
    @task
    def my_task(self):
        self.client.get('https://example.com')

Requires Python 3.10 or later. Some plugins require additional system dependencies or packages beyond the base install.

Verify before relying

• Whether all advertised plugins are included in version 5.0.3 or require separate optional dependencies.
• Compatibility of specific plugins with versions of locust beyond the base dependency specification.
• Performance overhead or resource requirements when using multiple plugins in a single test run.

Package facts

Evidence: locust_plugins-5.0.3-py3-none-any.whl

Tags

More Traffic Generation packages