mirror of
https://github.com/Cuprate/cuprate.git
synced 2024-12-23 12:09:52 +00:00
caa08d5eaa
Some checks failed
Architecture mdBook / build (push) Has been cancelled
CI / fmt (push) Has been cancelled
CI / typo (push) Has been cancelled
CI / ci (macos-latest, stable, bash) (push) Has been cancelled
CI / ci (ubuntu-latest, stable, bash) (push) Has been cancelled
CI / ci (windows-latest, stable-x86_64-pc-windows-gnu, msys2 {0}) (push) Has been cancelled
Deny / audit (push) Has been cancelled
Doc / build (push) Has been cancelled
Doc / deploy (push) Has been cancelled
* add readme * readme, basic examples * name changes, bin impl * example, docs * book * add `cuprate-criterion-example` * docs, tracing * fix clippy * docs * lib readme * json-rpc benchmarks * add to crates.md * add `fixme` * fix `cargo b` failing this `cfg()` existing makes a regular workspace `cargo b` fail * fix cargo.toml
27 lines
No EOL
994 B
Markdown
27 lines
No EOL
994 B
Markdown
## `cuprate-benchmark`
|
|
This crate links all benchmarks together into a single binary that can be run as: `cuprate-benchmark`.
|
|
|
|
`cuprate-benchmark` will run all enabled benchmarks sequentially and print data at the end.
|
|
|
|
## Benchmarks
|
|
Benchmarks are opt-in and enabled via features.
|
|
|
|
| Feature | Enables which benchmark crate? |
|
|
|----------|--------------------------------|
|
|
| example | cuprate-benchmark-example |
|
|
| database | cuprate-benchmark-database |
|
|
|
|
## Features
|
|
These are features that aren't for enabling benchmarks, but rather for other things.
|
|
|
|
Since `cuprate-benchmark` is built right before it is ran,
|
|
these features almost act like command line arguments.
|
|
|
|
| Features | Does what |
|
|
|----------|-----------|
|
|
| json | Prints JSON timings instead of a markdown table
|
|
| trace | Use the `trace` log-level
|
|
| debug | Use the `debug` log-level
|
|
| warn | Use the `warn` log-level
|
|
| info | Use the `info` log-level (default)
|
|
| error | Use the `error` log-level |