Skip to content

Add benchmarking section #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 28, 2025
Merged

Add benchmarking section #51

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions MAINTAINERS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,28 @@ This compiles the extension in release mode using Cargo. The resulting
shared library is placed under
`ext/native_tracer/target/release/` and is loaded by `src/native_trace.rb`.

## Running tests and benchmarks
## Running tests

Execute the full test suite with:

```bash
just test
```


The tests run several sample programs from `test/programs` and compare
the generated traces with the fixtures under `test/fixtures`.

Benchmarks can be executed with:
## Benchmarking

Run the heavy\_work benchmark with:

```bash
just bench heavy_work
```

Passing a second argument writes a report instead of printing the runtime:
Provide a path as a second argument to write a report instead of
printing the runtime:

```bash
just bench heavy_work reports/bench.svg
Expand Down
Loading