Skip to content

Commit 88bbc09

Browse files
committed
added API usage tracer usage to README
1 parent 6e77cc6 commit 88bbc09

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,24 @@ Run-SuiteExecution-BenchmarkExecution?-?;Function altered;Benchmark;Runtime in n
6767

6868
Run gets increased according to json attribute `"runs"`, SuiteExecution according to `"run_duration"`, and BenchmarkExecution according to `"bench_duration"`. Intuitively, `"runs"` defines how often the benchmark suite should be executed, `"run_duration"` defines how long each suite is executed (potentially multiple times), and `"bench_duration"` defines how long each benchmark is executed (potentially multiple times). All values start at 0.
6969

70+
## Tracing of API Asage
71+
72+
### Execution
73+
```bash
74+
goabs -c config.json -t -o trace_out.csv
75+
cd PATH/TO/UNIT_TEST_LIB
76+
go test ./...
77+
```
78+
79+
### Config File
80+
```json
81+
{
82+
"project": "PATH/TO/UNIT_TEST_LIB",
83+
"trace_lib": "PATH/TO/API_TRACE_LIB"
84+
}
85+
```
86+
87+
Use trace aggregator of [JavaAPIUsageTracer](https://github.com/sealuzh/JavaAPIUsageTracer) to sum traces for each function.
88+
89+
Remark: do not forget to set the GOPATH correctly, and retrieve the dependencies og the unit test library before running script.
90+

0 commit comments

Comments
 (0)