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

• 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 a locustfile
  • The Locust class
    • The task_set attribute
    • The min_wait and max_wait attributes
    • The weight attribute
    • The host attribute
  • TaskSet class
    • Declaring tasks
    • tasks attribute
    • TaskSets can be nested
    • Referencing the Locust instance, or the parent TaskSet instance
  • TaskSequence class
  • Setups, Teardowns, on_start, and on_stop
    • Setups and Teardowns
    • The on_start and on_stop methods
    • Order of events
  • Making HTTP requests
    • Using the HTTP client
    • Safe mode
    • Manually controlling if a request should be considered successful or a failure
    • Grouping requests to URLs with dynamic parameters
  • Common libraries

• Running Locust distributed
  • Example
  • Options
    • --master
    • --slave
    • --master-host=X.X.X.X
    • --master-port=5557
    • --master-bind-host=X.X.X.X
    • --master-bind-port=5557
    • --expect-slaves=X
  • Running Locust distributed without the web UI
• Running Locust without the web UI
  • Setting a time limit for the test
  • Running Locust distributed without the web UI

• Retrieve test statistics in CSV format
• Testing other systems using custom clients
  • Sample XML-RPC Locust client
• API
  • Locust class
  • HttpLocust class
  • TaskSet class
  • task decorator
  • TaskSequence class
  • seq_task decorator
  • HttpSession class
  • Response class
  • ResponseContextManager class
  • InterruptTaskSet Exception
  • Event hooks
    • Available hooks
• Extending Locust
  • Adding Web Routes

• Third party tools
  • Using other languages
    • Golang
    • Java

• Changelog Highlights
  • 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
    • HTTP client functionality moved to HttpLocust
    • msgpack for serializing master/slave data
    • requests updated to version 2.2
    • gevent updated to version 1.0
    • Big refactoring of request statistics code
    • Removed support for avg_wait
    • Removed support for ramping
    • Locust Event hooks now takes keyword argument
    • Other changes
  • 0.6.2
  • 0.6.1
  • 0.6
    • SubLocust replaced by TaskSet and Locust class behaviour changed
    • Locust now uses Requests
      • Gzip encoding turned on by default
      • Improved HTTP client
      • HttpSession methods’ catch_response argument improved and allow_http_error argument removed
    • Other improvements and bug fixes
    • Smaller API Changes
  • 0.5.1
  • 0.5
    • API changes
    • Improvements and bug fixes
  • 0.4
    • API changes
    • Improvements and bug fixes