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
See the user workflow guide for details.
FAQ
Answers to frequently asked questions and troubleshooting for common issues can be found in the FAQ section.
Documentation
Documentation and implementation details can be found in the docs folder.
Code specific documentation can be found on GoDoc.
Development
Information about the development workflow and release process can be found in Developer's workflow.
A guide on how to add load-test coverage for new or missing functionality can be found in Adding functionality.
Help
If you need any help you can join the Developers: Performance channel and ask developers any question related to this project.