Flamegraphs

.github/workflows/benchmarking.yml

@@ -4,8 +4,7 @@ on:
   push:
     branches:
       - main
-      - better_ci
-      - iai
+      - flamegraphs
 
 permissions:
   # deployments permission to deploy GitHub pages website
@@ -14,7 +13,7 @@ permissions:
   contents: write
 
 jobs:
-  test:
+  benchmarks:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
@@ -47,8 +46,30 @@ jobs:
         uses: baptiste0928/cargo-install@v1
         with:
           crate: cargo-criterion
+      - name: Install cargo flamegraphs
+        uses: baptiste0928/cargo-install@v1
+        with:
+          crate: flamegraph
       - name: Run search benchmarks
         run: cargo criterion --bench search-benchmarks --message-format=json -- LIGHT 1> search-benchmarks-output.json
+      - name: Generate flamegraphs and flamecharts for profiling
+        run: |
+             if [ "$RUNNER_OS" == "Linux" ]; then
+                  sudo cat /proc/sys/kernel/kptr_restrict
+                  sudo cat /proc/sys/kernel/perf_event_paranoid
+                  echo -1 | sudo tee /proc/sys/kernel/perf_event_paranoid
+                  # Chart == X axis is time
+                  cargo flamegraph --deterministic --flamechart -o flamechart.svg --bench search-benchmarks -- --bench >& flamechart.bin
+                  # Graph == X axis is stack profile population
+                  cargo flamegraph --deterministic --bench search-benchmarks -- --bench >& flamegraph.bin
+             else # PERFILE binary contents spewed on stdout on Linux?: https://github.com/flamegraph-rs/flamegraph/issues/248
+                  cargo flamegraph --deterministic --flamechart -o flamechart.svg --bench search-benchmarks -- --bench
+                  # Graph == X axis is stack profile population
+                  cargo flamegraph --deterministic --bench search-benchmarks -- --bench
+             fi
+        shell: bash
+      - name: Batch flame* results under criterion-rs output
+        run: mkdir -p target/criterion/flameplots && cp flame*.svg flame*.bin target/criterion/flameplots
       - name: Store search benchmark result
         uses: brainstorm/github-action-benchmark@cargo-criterion-v3
         with:

.github/workflows/release.yml

@@ -4,8 +4,7 @@ on:
   push:
     branches:
       - main
-      - better_ci
-      - iai
+      - flamegraphs
 
 jobs:
   release:

.github/workflows/tests.yml

@@ -4,11 +4,10 @@ on:
   push:
     branches:
       - main
-      - better_ci
-      - iai
+      - flamegraphs
 
 jobs:
-  test:
+  tests:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:

.gitignore

@@ -2,6 +2,7 @@ target
 Cargo.lock
 *.code-workspace
 *.vcf.gz
+*.svg
 .vscode
 .idea
 package-lock.json

Cargo.toml

@@ -6,4 +6,8 @@ members = [
     "htsget-lambda",
     "htsget-search",
     "htsget-test",
-]
+]
+
+# Flamegraphs require debuginfo for symbol names.
+[profile.bench]
+debug = true

htsget-search/Cargo.toml

@@ -55,15 +55,17 @@ htsget-test = { version = "0.1.0", path = "../htsget-test", features = ["cors-te
 tempfile = "3.3"
 data-url = "0.2"
 
-# Aws S3 storage dependencies.
+# AWS S3 storage
 anyhow = "1.0"
 s3-server = "0.2"
 aws-types = { version = "0.52", features = ["hardcoded-credentials"] }
 
-# Axum server dependencies
+# Axum server
 reqwest = { version = "0.11", default-features = false, features = ["rustls-tls"] }
 
+# Benchmarking
 criterion = { version = "0.4", features = ["async_tokio"] }
+pprof = { version = "0.11", features = ["criterion", "flamegraph"]}
 
 [[bench]]
 name = "search-benchmarks"

htsget-search/benches/search_benchmarks.rs

@@ -122,4 +122,4 @@ fn criterion_benchmark(c: &mut Criterion) {
 }
 
 criterion_group!(benches, criterion_benchmark);
-criterion_main!(benches);
+criterion_main!(benches);