Skip to content

Commit

Permalink
Add links to other benches from benches (#125)
Browse files Browse the repository at this point in the history
* Add links to other benches from `benches`

The README explains the top level `benches` are Rust ones, this adds links to find the other benches, since each of them has different folder structure and naming.

* Add links to kotlin bench readme too
  • Loading branch information
skeet70 authored May 6, 2024
1 parent 815ab28 commit 94d1e64
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
4 changes: 4 additions & 0 deletions benches/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,7 @@ Since ironcore-alloy is a library that interacts with a back-end service (TSP),
In general, operation latency is a function of latency to the TSP + latency to the tenant's KMS (if key-leasing is disabled).

The TSP's tenant logging mechanism has some tunable limits. By default, a TSP should be able to sustain 500 ops/sec/tenant, with the ability to burst higher for a limited time. The benchmark is using a single tenant, and (depending on your machine and benchmark config) can easily be executing a few thousand ops/sec. If you run a benchmark long enough you will overwhelm the TSP. In a real application, you would scale-out the TSP at this point. See [the TSP documentation](https://ironcorelabs.com/docs/saas-shield/tenant-security-proxy/deployment/) for more details.

## Other Languages

There are also benchmarks available in [Kotlin](https://github.com/IronCoreLabs/ironcore-alloy/tree/main/kotlin/benchmarks/src) and [Python](https://github.com/IronCoreLabs/ironcore-alloy/blob/main/python/ironcore-alloy/bench.py).
4 changes: 4 additions & 0 deletions kotlin/benchmarks/src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,7 @@ Since ironcore-alloy is a library that interacts with a back-end service (TSP),
In general, operation latency is a function of latency to the TSP + latency to the tenant's KMS (if key-leasing is disabled).

The benchmark is using a single tenant, and (depending on your machine and benchmark config) can easily be executing a few thousand ops/sec. If you run the benchmark long enough you can overwhelm the TSP. In a real application, you would scale-out the TSP at this point. See [the TSP documentation](https://ironcorelabs.com/docs/saas-shield/tenant-security-proxy/deployment/) for more details.

## Other Languages

There are also benchmarks available in [Rust](https://github.com/IronCoreLabs/ironcore-alloy/tree/main/benches) and [Python](https://github.com/IronCoreLabs/ironcore-alloy/blob/main/python/ironcore-alloy/bench.py).

0 comments on commit 94d1e64

Please sign in to comment.