Skip to content

Commit 2e27841

Browse files
committed
Add README for usage and instructions
1 parent 0db5cce commit 2e27841

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

.evergreen/perfcomp/README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# perfcomp
2+
3+
**perfcomp** is a performance analyzer on a PR commit basis.
4+
5+
## 📦 Installation
6+
7+
To install the latest version:
8+
9+
```bash
10+
go install github.com/mongodb-labs/drivers-evergreen-tools/perfcomp
11+
```
12+
13+
Or build it locally in `bin/perfcomp`:
14+
15+
```bash
16+
bash build.sh
17+
```
18+
19+
## 🔧 Usage
20+
21+
To use `perfcomp`, you should have an analytics node URI env variable called `PERF_URI_PRIVATE_ENDPOINT`. You can request for it from the devprod performance team.
22+
23+
To run in your project repository, you need to create a [performance context](https://performance-monitoring-and-analysis.server-tig.prod.corp.mongodb.com/contexts) that captures all benchmarks in your project. Feel free to refer to the [Go Driver context](https://performance-monitoring-and-analysis.server-tig.prod.corp.mongodb.com/context/name/GoDriver%20perf%20task) as a template. Then, add the context to the `projectToPerfContext` map in `./cmd/perfcomp/compare.go`.
24+
25+
```bash
26+
perfcomp is a cli that reports stat-sig results between evergreen patches with the mainline commit
27+
28+
Usage:
29+
perfcomp [command]
30+
31+
Available Commands:
32+
compare compare evergreen patch to mainline commit
33+
mdreport generates markdown output after run
34+
```
35+
36+
### Commands
37+
38+
#### compare
39+
```bash
40+
compare evergreen patch to mainline commit
41+
42+
Usage:
43+
perfcomp compare [version_id] [flags]
44+
45+
Flags:
46+
--project string specify the name of an existing Evergreen project (default "mongo-go-driver")
47+
```
48+
49+
#### mdreport
50+
```bash
51+
generates markdown output after compare run (must be run after `compare`)
52+
53+
Usage:
54+
perfcomp mdreport
55+
```

0 commit comments

Comments
 (0)