Skip to main content

Developer friendly load testing framework

Project description

Locust

Build Status codecov license PyPI PyPI GitHub contributors

Locust is an easy to use, scriptable and scalable performance testing tool. You define the behaviour of your users in regular Python code, instead of using a clunky UI or domain specific language. This makes Locust infinitely expandable and very developer friendly.

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 is small and very flexible and we intend to keep it that way. If you want to send reporting data to that database & graphing system you like, wrap calls to a REST API to handle the particulars of your system or run a totally custom load pattern, there is nothing stopping you!

Links

Authors

License

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

locust-mboutet2-2.0.0.0b0.tar.gz (770.0 kB view details)

Uploaded Source

Built Distribution

locust_mboutet2-2.0.0.0b0-py3-none-any.whl (792.4 kB view details)

Uploaded Python 3

File details

Details for the file locust-mboutet2-2.0.0.0b0.tar.gz.

File metadata

  • Download URL: locust-mboutet2-2.0.0.0b0.tar.gz
  • Upload date:
  • Size: 770.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.6

File hashes

Hashes for locust-mboutet2-2.0.0.0b0.tar.gz
Algorithm Hash digest
SHA256 cc1a7057c9c92fc2d4c2edfbb83ba12a3c3418c40a51656bf8e07de97e8118fd
MD5 a4e5624742f26a238ba96ffb601b1827
BLAKE2b-256 81adf1df5e8285d931d63da64c7818d2bbec14d23cb50eea8938e765994a0ac0

See more details on using hashes here.

File details

Details for the file locust_mboutet2-2.0.0.0b0-py3-none-any.whl.

File metadata

  • Download URL: locust_mboutet2-2.0.0.0b0-py3-none-any.whl
  • Upload date:
  • Size: 792.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.6

File hashes

Hashes for locust_mboutet2-2.0.0.0b0-py3-none-any.whl
Algorithm Hash digest
SHA256 8c87e0277ab7e5990ec31e8c5937f916ba59cdce69b5280d1525051c501ecb43
MD5 4f3dea5627c6f9c408d78994e52422e2
BLAKE2b-256 c95d7a94e0c1c4af967e6e5d4f88b199a1cb43e906876557c0817126c7ffa8e3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page