Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Locust UI as a Module #2804

Merged
merged 31 commits into from
Aug 1, 2024
Merged
Changes from 1 commit
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
e8336d3
Add locust lib build
andrewbaldwin44 Jul 10, 2024
f48a915
Configure LocustUi exports, props, and types
andrewbaldwin44 Jul 12, 2024
5412e28
Update with correct types
andrewbaldwin44 Jul 15, 2024
0be8bb5
Provide additional exports
andrewbaldwin44 Jul 15, 2024
73040d1
Add documentation
andrewbaldwin44 Jul 15, 2024
098a6ba
Remove react-redux dependency
andrewbaldwin44 Jul 15, 2024
982cc5f
Fix build
andrewbaldwin44 Jul 15, 2024
847621d
Fix tests
andrewbaldwin44 Jul 15, 2024
7f3bf8d
Update documentation
andrewbaldwin44 Jul 15, 2024
be810c2
Update docs
andrewbaldwin44 Jul 16, 2024
582d05b
Remove example
andrewbaldwin44 Jul 16, 2024
f0b8dbf
Argument parser
andrewbaldwin44 Jul 16, 2024
d2fe8ac
Update README.md
andrewbaldwin44 Jul 16, 2024
a69221c
Remove example
andrewbaldwin44 Jul 16, 2024
c120a5a
Frontend tests
andrewbaldwin44 Jul 16, 2024
b729da0
Fix build path
andrewbaldwin44 Jul 16, 2024
e6afb3d
precommit
andrewbaldwin44 Jul 17, 2024
5e6b25a
precommit
andrewbaldwin44 Jul 17, 2024
91f6aec
Add LICENSE
andrewbaldwin44 Jul 18, 2024
0eb95a9
Update vite lib config
andrewbaldwin44 Jul 18, 2024
aa74d48
Update exports
andrewbaldwin44 Jul 18, 2024
df76527
Add repository to package.json
andrewbaldwin44 Jul 18, 2024
77349a2
Remove private flag
andrewbaldwin44 Jul 18, 2024
0602266
Update README
andrewbaldwin44 Jul 18, 2024
33cfef3
Add generic to LineChart
andrewbaldwin44 Jul 25, 2024
a18cb04
Allow for using locust MUI theme in lib
andrewbaldwin44 Jul 29, 2024
66b3277
Add chart formatting
andrewbaldwin44 Jul 29, 2024
50fa56c
Add immediate
andrewbaldwin44 Jul 29, 2024
7becbd3
Add swarm_start
andrewbaldwin44 Jul 29, 2024
7feee72
Update chartFormatter type
andrewbaldwin44 Jul 31, 2024
f265537
Update README
andrewbaldwin44 Aug 1, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update README
andrewbaldwin44 committed Aug 1, 2024
commit f265537aeb1ff76899276d4abbd67460aab859e5
7 changes: 7 additions & 0 deletions locust/webui/README.md
Original file line number Diff line number Diff line change
@@ -4,6 +4,8 @@ The Locust UI is used for viewing stats, reports, and information on your curren

## Locust UI as a Library

**Using the Locust UI as a library should be considered an experimental feature**

The Locust UI may be extended to fit your needs. If you only need limited extensibility, you may do so in your Locustfile, see the [extend_web_ui example](https://github.com/locustio/locust/blob/master/examples/extend_web_ui.py).

However, you may want to further extend certain functionalities. To do so, you may replace the default Locust UI with your own React application. Start by installing the locust-ui in your React application:
@@ -62,6 +64,11 @@ For Locust to be able to pass data to your React frontend, place the following s
</script>
```

To load the favicon, place the link in your head:
```html
<link rel="icon" href="./assets/favicon.ico" />
```

Lastly, you must configure Locust to point to your own React build output. To achieve this, you can use the flag `--build-path` and provide the **absolute** path to your build directory.

```sh