From ce6b0d1780681091ce8452fdcea457100b294fc0 Mon Sep 17 00:00:00 2001 From: Chris Riccomini Date: Fri, 13 Dec 2024 13:11:30 -0800 Subject: [PATCH] git diff --- .github/workflows/publish.yaml | 1 + docs/performance.md | 14 +++++++++++--- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index 6d511b1..8dd8b39 100644 --- a/.github/workflows/publish.yaml +++ b/.github/workflows/publish.yaml @@ -32,3 +32,4 @@ jobs: with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./build + keep_files: true diff --git a/docs/performance.md b/docs/performance.md index 0e3861f..613db85 100644 --- a/docs/performance.md +++ b/docs/performance.md @@ -14,12 +14,20 @@ SlateDB comes with a [bencher](https://github.com/slatedb/slatedb/tree/main/src/ ### Nightly -We run this tool in nightly, and publish the results [here](https://slatedb.io/performance/benchmarks/main). We have configured the job to use a [LocalFilesystem](https://docs.rs/object_store/latest/object_store/local/struct.LocalFileSystem.html) instead of S3, so the results don't reflect performance against a real S3 bucket. We plan to use S3 with this benchmark in the future. +We run this tool in nightly and publish the results [here](https://slatedb.io/performance/benchmarks/main). The benchmark runs on [WarpBuild](https://warpbuild.com)'s [warp-ubuntu-latest-x64-16x](https://docs.warpbuild.com/cloud-runners) runners. - +:::warning + +We have configured the job to use a [LocalFilesystem](https://docs.rs/object_store/latest/object_store/local/struct.LocalFileSystem.html) instead of S3, so the results don't reflect performance against a real S3 bucket. We plan to use S3 with this benchmark in the future. + +::: + + ## Microbenchmarks We use [Criterion](https://bheisler.github.io/criterion.rs/) to run microbenchmarks (located in [benches](https://github.com/slatedb/slatedb/tree/main/benches)) for specific interanl SlateDB functions. A comment is left on all PRs where a > 200% regression is detected. -Microbenchmarks also run nightly with the [pprof-rs](https://github.com/tikv/pprof-rs) profiler. The results profiler protobuf files are published [here](https://github.com/slatedb/slatedb-website/tree/gh-pages/performance/microbenchmark-pprofs/main). We highly recommend using [pprof.me](https://pprof.me/) to view the results, though any [pprof](https://github.com/google/pprof) compatible tool may be used. \ No newline at end of file +Microbenchmarks also run nightly with the [pprof-rs](https://github.com/tikv/pprof-rs) profiler. The results profiler protobuf files are published [here](https://github.com/slatedb/slatedb-website/tree/gh-pages/performance/microbenchmark-pprofs/main). The microbenchmarks run on [standard Linux Github action runners](https://docs.github.com/en/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners#standard-github-hosted-runners-for-public-repositories). + +We highly recommend using [pprof.me](https://pprof.me/) to view the `.pb` files, though any [pprof](https://github.com/google/pprof) compatible tool may be used. \ No newline at end of file