Locust
0.13.2
  • What is Locust?
  • Installation
  • Quick start
  • Writing a locustfile
  • Running Locust distributed
  • Running Locust without the web UI
  • Increase Locust’s performance with a faster HTTP client
  • Retrieve test statistics in CSV format
  • Testing other systems using custom clients
  • Extending Locust
  • Logging
  • API
  • Third party tools
  • Changelog Highlights
Locust
  • Docs »
  • Locust Documentation
  • Edit on GitHub

Locust Documentation¶

Everything you need to know about Locust

About locust

Locust is a scalable load testing framework written in Python

  • Website: https://locust.io/
  • Source code: https://github.com/locustio/locust
  • Twitter: @locustio

Getting started¶

  • What is Locust?
    • Features
    • Background
    • Authors
    • License
  • Installation
    • Supported Python Versions
    • Installing Locust on Windows
    • Installing Locust on macOS
    • Increasing Maximum Number of Open Files Limit
  • Quick start
    • Example locustfile.py
    • Start Locust
    • Open up Locust’s web interface

Writing Locust tests¶

  • Writing a locustfile
    • The Locust class
    • TaskSet class
    • TaskSequence class
    • Setups, Teardowns, on_start, and on_stop
    • Making HTTP requests
    • Common libraries

Running your Locust tests¶

  • Running Locust distributed
  • Running Locust without the web UI
  • Increase Locust’s performance with a faster HTTP client

Other functionalities¶

  • Retrieve test statistics in CSV format
  • Testing other systems using custom clients
    • Sample XML-RPC Locust client
  • Extending Locust
    • Adding Web Routes
  • Logging
    • Options

API¶

  • API
    • Locust class
    • HttpLocust class
    • TaskSet class
    • task decorator
    • TaskSequence class
    • seq_task decorator
    • Built in wait_time functions
    • HttpSession class
    • Response class
    • ResponseContextManager class
    • InterruptTaskSet Exception
    • Event hooks
      • Available hooks

Third-party tools¶

  • Third party tools

Changelog¶

  • Changelog Highlights
    • 0.13.2
    • 0.13.1
    • 0.13.0
    • 0.12.2
    • 0.12.1
    • 0.10.0
    • 0.9.0
    • 0.8.1
    • 0.8
    • 0.7.5
    • 0.7.4
    • 0.7.3
    • 0.7.2
    • 0.7.1
    • 0.7
    • 0.6.2
    • 0.6.1
    • 0.6
    • 0.5.1
    • 0.5
    • 0.4
Next

© Copyright Revision 208d240d.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: 0.13.2
Versions
latest
stable
0.13.2
0.13.1
0.13.0
0.12.2
0.12.1
0.10.0
0.9.0
v0.8.1
v0.8
v0.7.5
v0.7.2
v0.7.1
v0.7
v0.6.2
v0.6.1
v0.6
v0.5.1
0.4
Downloads
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.