README
¶
Mattermost load-test-ng
Mattermost load-test-ng provides a set of tools written in Go to help profiling Mattermost under heavy load, simulating real-world usage of a server installation at scale.
It's a complete rewrite of the previous load-test tool which served as inspiration.
Goals
- Give an estimate on the maximum number of concurrently active users the target system supports.
- Enable more control over the load to generate through the use of Controllers.
- Provide extensive documentation from lower level code details to higher level guides and walk-throughs.
How to use
There are mainly two ways to run a load-test:
- On a Terraform deployment. This is the recommended way to start a load-test for production. Link to the guide
- Locally. This is a good way to getting started and better understand the inner mechanics. Link to the guide
Documentation
Documentation and implementation details can be found in the docs folder.
Code specific documentation can be found on GoDoc.
Development
A sample implementation can be found in the example folder.
Help
If you need any help you can join the Developers: Performance channel and ask developers any question related to this project.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
terraform/ssh
Package ssh is a simple wrapper around an ssh.Client which implements utilities to be performed with a remote server.
|
Package ssh is a simple wrapper around an ssh.Client which implements utilities to be performed with a remote server. |
|
examples
|
|
|
user/websocket
Package websocket is a tiny websocket client purpose-built for load-testing.
|
Package websocket is a tiny websocket client purpose-built for load-testing. |
Click to show internal directories.
Click to hide internal directories.