README.md 2.17 KB
Newer Older
1
# GitLab Performance Tool
Ramya Authappan's avatar
Ramya Authappan committed
2

3
The GitLab Performance Tool (`gpt`) is built and maintained by the GitLab Quality Enablement team to provide performance testing of any GitLab instance. The tool has been built upon the industry leading open source tool [k6](https://k6.io) and provides numerous tests that are designed to effectively performance test GitLab.
Ramya Authappan's avatar
Ramya Authappan committed
4

Nailia Iskhakova's avatar
Nailia Iskhakova committed
5
The tool can be used both manually and automatically, with us doing the latter for automated testing of reference environments via [Pipelines](https://gitlab.com/gitlab-org/quality/performance/pipeline_schedules).
6

7
GPT is used by the GitLab Quality Enablement team to continuously performance test GitLab on environments based on our [Reference Architectures](https://docs.gitlab.com/ee/administration/reference_architectures/) that have been built with the [GitLab Environment Toolkit](https://gitlab.com/gitlab-org/quality/gitlab-environment-toolkit). For more information please refer to our blog post - [How our QA team leverages GitLab’s performance testing tool (and you can too)](https://about.gitlab.com/blog/2020/02/18/how-were-building-up-performance-testing-of-gitlab/).
8

Grant Young's avatar
Grant Young committed
9
## Documentation
10

11
Documentation on how to use the tool can be found in the [`docs/`](/docs/README.md) folder:
12

13
14
* [Preparing the Environment](docs/environment_prep.md)
* [Running the Tests](docs/k6.md)
Ramya Authappan's avatar
Ramya Authappan committed
15

16
**Note:** These docs are for GPT `v2`. For GPT `v1` please refer to the docs [here](https://gitlab.com/gitlab-org/quality/performance/-/blob/v1-master/README.md).
17

18
19
20
21
22
## Test Details

To get more detailed information about the current test list that is run by GPT you can refer to the [Current Test Details wiki page](https://gitlab.com/gitlab-org/quality/performance/wikis/current-test-details).

## Test Results
Ramya Authappan's avatar
Ramya Authappan committed
23

24
The GitLab Quality team uses this Tool in frequent automated pipelines to continuously measure the performance of GitLab. The results are uploaded to this project's wiki and made available for anyone to see:
Ramya Authappan's avatar
Ramya Authappan committed
25

26
27
* Test runs against reference environments - https://gitlab.com/gitlab-org/quality/performance/wikis/Benchmarks/Latest
* Test runs comparing results of different GitLab versions - https://gitlab.com/gitlab-org/quality/performance/wikis/Benchmarks/GitLab-Versions