Commit Graph

43 Commits

Author SHA1 Message Date
Lars Holmberg baa9d23168 add note about --config-users format being experimental. 2024-08-14 14:17:33 +02:00
Lars Holmberg 114144a0cd improve docs for --config-users 2024-08-14 13:54:42 +02:00
Lars Holmberg 909577958d
Merge pull request #2750 from andrewbaldwin44/feature/log-improvements
Send logs from workers to master and improve log viewer tab in the Web UI
2024-06-07 18:17:15 +02:00
Andrew Baldwin 699c1209f6 Add WORKER_LOG_REPORT_INTERVAL as configurable 2024-06-07 07:58:31 -04:00
Sam 8f04a6bcd1
Docs: Import wiki to docs (#2734)
* Straight pandoc migration, no edits

* Minimum edits for the docs to build

- added imports to TOC
- deleted Home.rst
- removed spurious html formatting `li`, `h4` etc
- fixed H1s

Still to do

- rename files
- actually look at content :-p

* Blog post links live in ther forum now

* Move imported files to lowercase, update wiki links to docs links

* Move troubleshooting into installation

* Break out increasing request rate

* Remove duped content

* Remove duped content

* Codespell fixes

* Misc review feedback and fixes

* Just nuke it

* Fix line breaks

* This aint the wiki youre looking for
2024-06-07 11:48:47 +02:00
Andrew Baldwin d416966934 Update docs 2024-05-06 08:25:30 -04:00
Andrew Baldwin 9d6bebe851 Remove legacy UI 2024-05-06 08:25:28 -04:00
Dennis Kroné e57ba6365d Update documentation for new locustfile options 2024-04-29 16:10:54 +02:00
Lars Holmberg 6d11925849 Various grammar fixes in documentation. Remove references to legacy ui in docs. 2024-04-27 09:07:50 +02:00
Lars Holmberg 1a94044651 Fix various documentation issues, mostly spelling 2024-04-21 23:49:31 +02:00
Alexey 54b183075e
Replace toml lib with tomli/tomlib, add custom TOML parser 2024-02-27 00:44:20 +03:00
Alexey 8d4a239fa0
Update documentation for parsing .conf and .toml config files 2024-02-25 01:17:45 +03:00
Lars Holmberg a0aa5eb7cd docs: fix whitespace 2024-02-16 20:58:51 +01:00
Andrew Baldwin e2a453fd00 Update configration docs 2024-02-11 14:51:06 -05:00
Lars Holmberg e4c5d197da Fix some documentation stuff, remove unneeded whitespace... 2024-02-11 17:19:04 +01:00
Dennis Kroné 7e900c4aa9 Add notes about web urls in configuration documentation 2024-02-09 16:45:05 +01:00
Lars Holmberg 8c0cbe47f4 Remove documentation and (already broken?) checks for not loading locustfiles named locust.py 2024-02-07 08:38:44 +01:00
Andrew Baldwin f5e235d487 Add documentation to configuration.rst 2024-01-19 07:45:40 -05:00
fooqoo 29974c309a Capitalize description of parameters in configuration docs 2024-01-16 09:17:58 +09:00
fooqoo 4b5d2ac203 Update configuration docs of PERCENTILES_TO_STATISTICS 2024-01-16 09:14:26 +09:00
fooqoo 3981277b6f Update configuration docs 2024-01-15 21:00:10 +09:00
fooqoo 374e10a060 Correct statics to statistics 2024-01-15 10:06:34 +09:00
fooqoo 7db0504232 Implement user-editable columns in statics screen 2024-01-15 01:28:38 +09:00
Lars Holmberg 611587114b Various updates to the command line help (introduce metavar) and documentation. 2023-11-21 15:06:45 +01:00
Lars Holmberg 28907f87c9 Clean up some documentation. Use "https://" in examples instead of "http://" - this isnt 2010 any more :) 2023-11-20 22:59:59 +01:00
BOCO 0e56a8b5d3
Add PERCENTILES_TO_CHART param in stats.py to make the Response Time Chart configurable (#2313)
* Added command line parameters to speciufy percentiles for chart

Percentiles were originally 50% and 95%. Command line parameter can
specify chart and report percentiles. Defalt value is 50% and 95%.

* Added new command line argument --percentiles

Old parameters --percemtile1 and percentile2 were removed.
Added test case in test_main for -percentiles parameter

* Updated format by black

* Updated web.py format by black

* Removed command line argument for percentiles and test

Updated to get percentiles info from stats.py::

* Added test in test_main. Updated response_time_percentile variable name

* updated response_time_percentile variable name.

* Fixed stats.py format and test_main.py unnecessary comment out

* Grouped stats import and reorderd response_time_percentile variable in
javascript and html file

Modified test in test_main.py

* updated report.html and locust.js "% percentile" to "th percentile" in
response time chart

* updated percentiles related test in test_main.py

* reformated test_main.py

* change order of PERCENTILES_TO_CHART param
2023-03-12 21:06:47 +01:00
Zhang Xingjian d430bd7908 docs: fix caption levels in configuration.rst 2022-12-21 20:34:53 +08:00
Lars Holmberg bca78cd94a Various documentation updates, mainly moved "using multiple locustfiles at once" and "class picker" from Quickstart to Configuration. 2022-10-17 09:24:30 +02:00
Xavier Sosnovsky 8b26da2444 Minor edits to the documentation 2022-07-23 17:13:30 +02:00
Lars Holmberg 1c65699f26 doc improvement 2021-09-13 21:30:07 +02:00
Lars Holmberg b8c526ed42 Update docs, mainly to say that custom arguments are forwarded to the workers. Update the add_command_line_argument.py to actually USE the custom argument. 2021-08-07 23:31:40 +02:00
Lars Holmberg b17da040f3 Various documentation improvements, including a better "hello world" example to get people started. Added Sphinx Substitution Extension in order to be able to add dynamic stuff (version number) into the documentation. 2021-07-27 13:14:55 +02:00
Lars Holmberg 8b3372b108 more documentation stuff 2020-10-12 11:26:03 +02:00
Lars Holmberg eb15f2bf38 Renamed hatch rate to spawn rate. Fixes #1405 2020-08-18 09:18:53 +02:00
Vladimir Stepanov 70e35d1cbd Adding PERCENTILES_TO_REPORT parameter to doc 2020-07-13 17:11:14 +03:00
Vladimir Stepanov 0b53dd1a8f Moving doc section 2020-07-13 17:05:57 +03:00
Vladimir Stepanov e89eb10ae3 Adding doc to configuration section 2020-07-13 16:34:04 +03:00
Lars Holmberg 9d8eb30c38 Revert "Fix corrupted documentation"
This reverts commit ed5311568b.
2020-06-15 10:42:20 +02:00
Lars Holmberg ed5311568b Fix corrupted documentation 2020-06-15 10:29:30 +02:00
Lars Holmberg 50ed08a672 Clarify configuration override order. #1381 2020-06-04 17:13:33 +02:00
Jonatan Heyman e40edfed6e Add config file keys to settings table in the Configuration docs.
Remove advanced configuration examples from Quickstart docs in favor of just linking to the Configuration docs.
2020-05-01 16:27:58 +02:00
Matt Fisher 8ce5129c74 Docs for --config command line argument 2020-04-30 18:38:32 +10:00
Jonatan Heyman 97491e4f3c * Explicitly set environment variable names for command line options.
* Automatically generate documentation for all available environment variables.
* Rename env variables LOCUST_MASTER, LOCUST_MASTER_PORT in order to make it less likely that they collide with env vars automatically added by Kubernetes. Also change the name of LOCUST_WORKER and LOCUST_MASTER_HOST for consistency.
* Rename env variable CSVFILEBASE to LOCUST_CSV.
* Remove --csv-base-name command line option.
2020-04-28 18:41:53 +02:00