Locust
2.12.1
What is Locust?
Installation
Getting started
Writing a locustfile
Configuration
Distributed load generation
Running tests in a debugger
Running in Docker
Running Locust distributed with Terraform/AWS
Running without the web UI
Custom load shapes
Retrieve test statistics in CSV format
Testing non-HTTP systems
Testing Requests based SDKs
Increase performance with a faster HTTP client
Event hooks
Logging
Using Locust as a library
Developing Locust
Further reading / knowledgebase
API
Changelog Highlights
Locust
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
W
_
__init__() (HttpSession method)
A
abstract (HttpUser attribute)
(User attribute)
app (WebUI attribute)
assign_equal_weights() (Environment method)
auth_required_if_enabled() (WebUI method)
available_shape_classes (Environment attribute)
available_user_classes (Environment attribute)
B
between() (in module locust.wait_time)
C
catch_exceptions (Environment attribute)
client (HttpUser attribute)
(SequentialTaskSet property)
(TaskSet property)
client_pool (FastHttpUser attribute)
concurrency (FastHttpUser attribute)
connection_timeout (FastHttpUser attribute)
constant() (in module locust.wait_time)
constant_pacing() (in module locust.wait_time)
constant_throughput() (in module locust.wait_time)
content (FastResponse property)
context() (User method)
cpu_warning (Events attribute)
create_local_runner() (Environment method)
create_master_runner() (Environment method)
create_web_ui() (Environment method)
create_worker_runner() (Environment method)
D
delete() (HttpSession method)
E
Environment (class in locust.env)
environment (User attribute)
EventHook (class in locust.event)
Events (class in locust.event)
events (Environment attribute)
exclude_tags (Environment attribute)
F
failure() (ResponseContextManager method)
FastHttpSession (class in locust.contrib.fasthttp)
FastHttpUser (class in locust.contrib.fasthttp)
FastResponse (class in locust.contrib.fasthttp)
fixed_count (User attribute)
G
get() (FastHttpSession method)
(HttpSession method)
(RequestStats method)
greenlet (WebUI attribute)
H
head() (FastHttpSession method)
(HttpSession method)
headers (FastResponse attribute)
host (Environment attribute)
HttpSession (class in locust.clients)
HttpUser (class in locust)
I
init (Events attribute)
init_command_line_parser (Events attribute)
insecure (FastHttpUser attribute)
interrupt() (SequentialTaskSet method)
(TaskSet method)
InterruptTaskSet
J
json() (FastResponse method)
L
LocalRunner (class in locust.runners)
locust.wait_time
module
locustfile (Environment attribute)
M
MasterRunner (class in locust.runners)
max_redirects (FastHttpUser attribute)
max_retries (FastHttpUser attribute)
module
locust.wait_time
N
network_timeout (FastHttpUser attribute)
O
on_start() (SequentialTaskSet method)
(TaskSet method)
(User method)
on_stop() (SequentialTaskSet method)
(TaskSet method)
(User method)
options() (FastHttpSession method)
(HttpSession method)
P
parent (SequentialTaskSet property)
(TaskSet property)
parsed_options (Environment attribute)
patch() (FastHttpSession method)
(HttpSession method)
post() (FastHttpSession method)
(HttpSession method)
process_exit_code (Environment attribute)
put() (FastHttpSession method)
(HttpSession method)
Q
quit (Events attribute)
quit() (Runner method)
quitting (Events attribute)
R
register_message() (MasterRunner method)
(WorkerRunner method)
report_to_master (Events attribute)
request (Events attribute)
request() (FastHttpSession method)
(HttpSession method)
request_failure (Events attribute)
request_success (Events attribute)
RequestStats (class in locust.stats)
RescheduleTask
RescheduleTaskImmediately
reset_stats (Environment attribute)
(Events attribute)
ResponseContextManager (class in locust.clients)
run_single_user() (in module locust.debug)
Runner (class in locust.runners)
runner (Environment attribute)
S
schedule_task() (SequentialTaskSet method)
(TaskSet method)
send_message() (MasterRunner method)
(WorkerRunner method)
SequentialTaskSet (class in locust)
server (WebUI attribute)
shape_class (Environment attribute)
spawning_complete (Events attribute)
stats (Environment attribute)
StatsEntry (class in locust.stats)
stop() (Runner method)
(WebUI method)
stop_timeout (Environment attribute)
success() (ResponseContextManager method)
T
tag() (in module locust)
tags (Environment attribute)
task() (in module locust)
tasks (TaskSet attribute)
(User attribute)
TaskSet (class in locust)
template_args (WebUI attribute)
test_start (Events attribute)
test_stop (Events attribute)
test_stopping (Events attribute)
text (FastResponse property)
U
User (class in locust)
user (SequentialTaskSet property)
(TaskSet property)
user_classes (Environment attribute)
user_count (Runner property)
user_error (Events attribute)
W
wait() (TaskSet method)
(User method)
wait_time() (SequentialTaskSet method)
(TaskSet method)
(User method)
web_ui (Environment attribute)
WebUI (class in locust.web)
weight (User attribute)
worker_report (Events attribute)
WorkerRunner (class in locust.runners)
Read the Docs
v: 2.12.1
Versions
latest
stable
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.1
2.8.0
2.7.4
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.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
1.0
1.0b2
0.14.6
0.14.5
0.14.4
0.14.3
0.14.2
0.14.1
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
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