locust README

The project's README from github.com/locustio/locust. As one markdown file: README.md.

Locust

PyPI Supported Python Versions Downloads GitHub contributors Support Ukraine Badge inspect.software

Locust is an open source performance/load testing tool for HTTP and other protocols. Its developer-friendly approach lets you define your tests in regular Python code.

Locust tests can be run from command line or using its web-based UI. Throughput, response times and errors can be viewed in real time and/or exported for later analysis.

You can import regular Python libraries into your tests, and with Locust's pluggable architecture it is infinitely expandable. Unlike when using most other tools, your test design will never be limited by a GUI or domain-specific language.

To get started right away, head over to the documentation.

Features

Write user test scenarios in plain old Python

If you want your users to loop, perform some conditional behaviour or do some calculations, you just use the regular programming constructs provided by Python. Locust runs every user inside its own greenlet (a lightweight process/coroutine). This enables you to write your tests like normal (blocking) Python code instead of having to use callbacks or some other mechanism. Because your scenarios are “just python” you can use your regular IDE, and version control your tests as regular code (as opposed to some other tools that use XML or binary formats)

from locust import HttpUser, task, between

class QuickstartUser(HttpUser):
    wait_time = between(1, 2)

    def on_start(self):
        self.client.post("/login", json={"username":"foo", "password":"bar"})

    @task
    def hello_world(self):
        self.client.get("/hello")
        self.client.get("/world")

    @task(3)
    def view_item(self):
        for item_id in range(10):
            self.client.get(f"/item?id={item_id}", name="/item")

Distributed & Scalable - supports hundreds of thousands of users

Locust makes it easy to run load tests distributed over multiple machines. It is event-based (using gevent), which makes it possible for a single process to handle many thousands concurrent users. While there may be other tools that are capable of doing more requests per second on a given hardware, the low overhead of each Locust user makes it very suitable for testing highly concurrent workloads.

Web-based UI

Locust has a user friendly web interface that shows the progress of your test in real-time. You can even change the load while the test is running. It can also be run without the UI, making it easy to use for CI/CD testing.

Locust UI charts Locust UI stats Locust UI workers Locust UI start test

Can test any system

Even though Locust primarily works with web sites/services, it can be used to test almost any system or protocol. Just write a client for what you want to test, or explore some created by the community.

Hackable

Locust's code base is intentionally kept small and doesn't solve everything out of the box. Instead, we try to make it easy to adapt to any situation you may come across, using regular Python code. There is nothing stopping you from:

VS Code extension

Microsoft has built an excellent VS Code extension that uses Copilot to help you create and run Locust tests. Here's a video to get you started:

Youtube video

Azure Load Testing

Azure offers a managed load-testing service that lets you run and scale Locust tests easily.

Authors

Special thanks

Microsoft contributes to and sponsors the continued maintenance of Locust ❤️

License

Open source licensed under the MIT license (see LICENSE file for details).

locust (locustio/locust)

Searching Database…

28.2K ·GitHub
Locust
Что это такое?Locust — это инструмент с открытым исходным кодом для нагрузочного тестирования и тестирования производительности HTTP и других протоколов: тесты вы описываете обычным кодом на Python и запускаете из командной строки или через веб-интерфейс.
То есть мне нужно кликать по графическому интерфейсу или писать код?Вы пишете сценарии тестов на обычном Python (циклы, условия, вычисления — всё как обычно), а запускаете их из командной строки или через веб-интерфейс. Тесты хранятся в виде кода, поэтому IDE и система контроля версий работают как обычно.
Как мне запустить свой первый тест?Установите пакет командой pip install locust, опишите сценарий пользователя в Python-файле и выполните команду locust — она поднимет веб-интерфейс, где вы запустите «рой» виртуальных пользователей и настроите его параметры. Подробное руководство — на docs.locust.io.
В чём подвох — что у него не очень хорошо получается?Некоторые другие инструменты на том же железе выдают больше запросов в секунду — зато накладные расходы на каждого виртуального пользователя здесь очень низкие, что идеально для сценариев с высокой конкурентностью. К тому же кодовая база намеренно небольшая и не решает все задачи «из коробки».
Как он имитирует тысячи пользователей одновременно?Каждый виртуальный пользователь работает внутри собственного greenlet — лёгкой корутины, поэтому сценарии вы пишете как обычный блокирующий код на Python, а не возитесь с колбэками.
Есть ли поддержка редакторов или IDE для написания тестов?Да — Microsoft сделала расширение для VS Code, которое с помощью Copilot помогает создавать и запускать тесты Locust; кроме того, Microsoft участвует в разработке и спонсирует поддержку проекта.
Могу ли я запускать тесты в управляемом облачном сервисе?Azure Load Testing сам запускает и масштабирует тесты Locust — размещать инфраструктуру не нужно; он может сопоставлять результаты с метриками ресурсов, чтобы находить узкие места, и интегрируется с Azure DevOps и CI-пайплайнами GitHub.
What are similar projects?vegeta, k6, oha, wrk, hey, goreplay, ava, workflow
Which topics is it in?load-testing, socket-io, benchmarking, concurrency, http, distributed-systems, testing, devops, performance, framework, tool, docker
Creator
locustio
Size
39.1 MB
Stars
28.2K
Updated
CommitOct 17Release2.46.7Oct 04
Age
15y
Commits · 90 Days