Locust Documentation

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
  • Name & background
  • Authors
  • License
• Installation
  • Pre-release builds
  • Install for development
• Getting started
  • Locust’s web interface
  • Direct command line usage / headless
  • More options
  • Next steps

Writing Locust tests

• Writing a locustfile
  • Auto-generating a locustfile
  • User class
  • Tasks
  • Events
  • HttpUser class
  • TaskSets
  • How to structure your test code

Running your Locust tests

• Configuration
• Running without the web UI
• Using multiple Locustfiles at once
• Running Locust with User class UI picker
• Distributed load generation
• Running tests in a debugger
• Running in Docker
• Running Locust distributed with Terraform/AWS
• Running without the web UI

Other functionalities

• Custom load shapes
  • Example
  • Combining Users with different load profiles
  • Restricting which user types to spawn in each tick
• Retrieve test statistics in CSV format
• Testing non-HTTP systems
  • Example: writing an XML-RPC User/client
  • Example: writing a gRPC User/client
• Testing Requests based SDKs
• Increase performance with a faster HTTP client
  • How to use FastHttpUser
  • Concurrency
  • API
• Event hooks
  • Request context
  • Adding Web Routes
  • Extending Web UI
  • Run a background greenlet
  • Parametrizing locustfiles
  • Test data management
  • More examples
• Logging
  • Options
  • Locust loggers
• Using Locust as a library
  • Full example

Further reading / knowledgebase

• Developing Locust
• Further reading / knowledgebase

API

• API
  • User class
  • HttpUser class
  • TaskSet class
  • task decorator
  • tag decorator
  • SequentialTaskSet class
  • Built in wait_time functions
  • HttpSession class
  • Response class
  • ResponseContextManager class
  • Exceptions
  • Environment class
  • Event hooks
    • EventHook class
  • Runner classes
  • Web UI class
  • Other

Changelog

• Changelog Highlights
  • 2.13.1
  • 2.13.0
  • 2.12.1
  • 2.12.0
  • 2.11.1
  • 2.11.0
  • 2.10.2
  • 2.10.1
  • 2.10.0
  • 2.9.0
  • 2.8.6
  • 2.8.5
  • 2.8.4
  • 2.8.3
  • 2.8.2
  • 2.8.1
  • 2.8.0
  • 2.7.3
  • 2.7.2
  • 2.7.1
  • 2.7.0
  • 2.6.1
  • 2.6.0
  • 2.5.1
  • 2.5.0
  • 2.4.3
  • 2.4.2
  • 2.4.1
  • 2.4.0
  • 2.3.0
  • 2.2.3
  • 2.2.2
  • 2.2.1
  • 2.2.0
  • 2.1.0
  • 2.0.0
  • 1.6.0
  • 1.5.3
  • 1.5.2
  • 1.5.1
  • 1.5.0
  • 1.4.4
  • 1.4.3
  • 1.4.2
  • 1.4.1
  • 1.4.0
  • 1.3.2
  • 1.3.1
  • 1.3.0
  • 1.2.3
  • 1.2.2
  • 1.2.1
  • 1.2
  • 1.1.1
  • 1.1
  • 1.0.3
  • 1.0.2
  • 1.0, 1.0.1
  • 0.14.6
  • 0.14.0
  • 0.13.5
  • 0.13.4
  • 0.13.3
  • 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