Skip to content

Commit

Permalink
added API usage tracer usage to README
Browse files Browse the repository at this point in the history
  • Loading branch information
chrstphlbr committed Mar 14, 2018
1 parent 6e77cc6 commit 88bbc09
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,24 @@ Run-SuiteExecution-BenchmarkExecution?-?;Function altered;Benchmark;Runtime in n

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.

## Tracing of API Asage

### Execution
```bash
goabs -c config.json -t -o trace_out.csv
cd PATH/TO/UNIT_TEST_LIB
go test ./...
```

### Config File
```json
{
"project": "PATH/TO/UNIT_TEST_LIB",
"trace_lib": "PATH/TO/API_TRACE_LIB"
}
```

Use trace aggregator of [JavaAPIUsageTracer](https://github.com/sealuzh/JavaAPIUsageTracer) to sum traces for each function.

Remark: do not forget to set the GOPATH correctly, and retrieve the dependencies og the unit test library before running script.

0 comments on commit 88bbc09

Please sign in to comment.