Locust Documentation

Getting started

• What is Locust?
  • Features
  • Name & background
  • Authors
  • License
• Installation
  • Using uvx (alternative)
  • Done!
  • Pre-release builds
  • Install for development
  • Troubleshooting installation
• Your first test
  • 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
  • Examples
  • How to structure your test code

Running your Locust tests

• Configuration
• Increasing the request rate
• Distributed load generation
• Running tests in a debugger
• Running in Docker
• Running without the web UI

Running with Locust Cloud

• Running with Locust Cloud
  • First run
  • Locustfile and mock server
  • Passing options to Locust
  • Automated runs (CI)
  • Extra python packages
  • View dashboard / previous test runs
  • Source IP Addresses

If you have questions or get stuck, feel free to reach out to us at support@locust.cloud.

Other functionalities

• Custom load shapes
  • Example
  • Combining Users with different load profiles
  • Restricting which user types to spawn in each tick
  • Reusing common options in custom shapes
• Retrieve test statistics in CSV format
• Testing other systems/protocols
  • XML-RPC
  • gRPC
  • requests-based libraries/SDKs
  • REST
  • OpenAI
  • Other examples
• Increase performance with a faster HTTP client
  • How to use FastHttpUser
  • Concurrency
  • REST
  • Connection Handling
  • API
• Event hooks
  • Request context
  • Adding Web Routes
  • Extending Web UI
  • Adding Authentication to the Web UI
  • Run a background greenlet
  • Parametrizing locustfiles
  • Test data management
  • More examples
• Logging
  • Options
  • Locust loggers
• Using Locust as a library
  • Skipping monkey patching
  • Full example
• Third party extensions
  • Support for load testing other protocols, reporting etc
  • Report OTEL traces for requests
  • Automatically translate a browser recording (HAR-file) to a locustfile
  • Workers written in other languages than Python

Further reading / knowledgebase

• Developing and Documenting Locust
• Further reading / knowledgebase
• FAQ

API

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

Changelog

• Changelog Highlights
  • 2.37.10
  • 2.37.9
  • 2.37.8
  • 2.37.7
  • 2.37.6
  • 2.37.5
  • 2.37.4
  • 2.37.3
  • 2.37.2
  • 2.37.1
  • 2.37.0
  • 2.36.3
  • 2.36.2
  • 2.36.1
  • 2.36.0
  • 2.35.0
  • 2.34.1
  • 2.34.0
  • 2.33.2
  • 2.33.1
  • 2.33.0
  • 2.32.10
  • 2.32.9
  • 2.32.8
  • 2.32.7
  • 2.32.6
  • 2.32.5
  • 2.32.4
  • 2.32.3
  • 2.32.2
  • 2.32.1
  • 2.32.0
  • 2.31.8
  • 2.31.7
  • 2.31.6
  • 2.31.5
  • 2.31.4
  • 2.31.3
  • 2.31.2
  • 2.31.1
  • 2.31.0
  • 2.30.0
  • 2.29.1
  • 2.29.0
  • 2.28.0
  • 2.27.0
  • 2.26.0
  • 2.25.0
  • 2.24.1
  • 2.24.0
  • 2.23.1
  • 2.23.0
  • 2.22.0
  • 2.21.0
  • 2.20.1
  • 2.20.0
  • 2.19.1
  • 2.19.0
  • 2.18.4
  • 2.18.3
  • 2.18.2
  • 2.18.1
  • 2.18.0
  • 2.17.0
  • 2.16.1
  • 2.16.0
  • 2.15.1
  • 2.15.0
  • 2.14.2
  • 2.14.1
  • 2.14.0
  • 2.13.2
  • 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