Add metrics section to the prod use docs (#352) #494
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Continuous benchmarking with Bencher (https://bencher.dev) | ||
| # | ||
| # PREREQUISITES: | ||
| # 1. Create a project at https://bencher.dev and note its slug. | ||
| # 2. Add the following in GitHub → Settings → Secrets and variables → Actions: | ||
| # - Secret BENCHER_API_TOKEN: API token from bencher.dev | ||
| # - Variable BENCHER_PROJECT: your project slug | ||
| # 3. GITHUB_TOKEN is provided automatically — no setup needed. | ||
| # | ||
| # overhead_bench uses a custom harness (not Criterion). Its --bmf flag | ||
| # outputs Bencher Metric Format directly. | ||
| name: Benchmarks | ||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| pull_request: | ||
| workflow_dispatch: | ||
| permissions: | ||
| checks: write | ||
| pull-requests: write | ||
| jobs: | ||
| # Runs on every push to main to build the statistical baseline. | ||
| benchmark_main: | ||
| if: ${{ false }} # skip job | ||
| name: Benchmark — ${{ matrix.bench.name }} (main baseline) | ||
| if: github.event_name == 'push' || github.event_name == 'workflow_dispatch' | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 30 | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| bench: | ||
| - name: writer_encode | ||
| adapter: rust_criterion | ||
| command: cargo bench --package dial9-tokio-telemetry --bench writer_encode | ||
| - name: codec | ||
| adapter: rust_criterion | ||
| command: cargo bench --package dial9-trace-format --bench codec | ||
| - name: overhead_bench | ||
| adapter: json | ||
| command: cargo bench --bench overhead_bench -- --bmf 10 | ||
| - name: overhead_bench_ctimer | ||
| adapter: json | ||
| command: DIAL9_FORCE_CTIMER=1 cargo bench --bench overhead_bench -- --bmf 10 | ||
| - name: e2e_workload | ||
| adapter: json | ||
| command: cargo bench --bench e2e_workload -- --bmf 10 | ||
| env: | ||
| RUST_BACKTRACE: 1 | ||
| BENCHER_PROJECT: ${{ vars.BENCHER_PROJECT }} | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: dtolnay/rust-toolchain@stable | ||
| - uses: Swatinem/rust-cache@v2 | ||
| - name: Enable perf_event_open and kallsyms | ||
| run: | | ||
| sudo sysctl kernel.perf_event_paranoid=1 | ||
| sudo sysctl kernel.kptr_restrict=0 | ||
| - uses: bencherdev/bencher@0f8f620172ccd6225d40a7590598eb7b41718af8 # v0.6.2 | ||
| - name: Run benchmark | ||
| run: | | ||
| bencher run \ | ||
| --token '${{ secrets.BENCHER_API_TOKEN }}' \ | ||
| --branch '${{ github.ref_name }}' \ | ||
| --testbed ubuntu-latest \ | ||
| --adapter '${{ matrix.bench.adapter }}' \ | ||
| "${{ matrix.bench.command }}" | ||
| # Runs on same-repo PRs. Fork PRs are skipped — they have no access to | ||
| # BENCHER_API_TOKEN, so the job would fail rather than silently skip. | ||
| benchmark_pr: | ||
| if: ${{ false }} # skip job | ||
| name: Benchmark — ${{ matrix.bench.name }} (PR regression check) | ||
| if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 30 | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| bench: | ||
| - name: writer_encode | ||
| adapter: rust_criterion | ||
| command: cargo bench --package dial9-tokio-telemetry --bench writer_encode | ||
| - name: codec | ||
| adapter: rust_criterion | ||
| command: cargo bench --package dial9-trace-format --bench codec | ||
| - name: overhead_bench | ||
| adapter: json | ||
| command: cargo bench --bench overhead_bench -- --bmf 10 | ||
| - name: overhead_bench_ctimer | ||
| adapter: json | ||
| command: DIAL9_FORCE_CTIMER=1 cargo bench --bench overhead_bench -- --bmf 10 | ||
| - name: e2e_workload | ||
| adapter: json | ||
| command: cargo bench --bench e2e_workload -- --bmf 10 | ||
| env: | ||
| RUST_BACKTRACE: 1 | ||
| BENCHER_PROJECT: ${{ vars.BENCHER_PROJECT }} | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: dtolnay/rust-toolchain@stable | ||
| - uses: Swatinem/rust-cache@v2 | ||
| - name: Enable perf_event_open and kallsyms | ||
| run: | | ||
| sudo sysctl kernel.perf_event_paranoid=1 | ||
| sudo sysctl kernel.kptr_restrict=0 | ||
| - uses: bencherdev/bencher@0f8f620172ccd6225d40a7590598eb7b41718af8 # v0.6.2 | ||
| - name: Run benchmark | ||
| run: | | ||
| bencher run \ | ||
| --token '${{ secrets.BENCHER_API_TOKEN }}' \ | ||
| --branch '${{ github.head_ref }}' \ | ||
| --start-point main \ | ||
| --start-point-reset \ | ||
| --testbed ubuntu-latest \ | ||
| --adapter '${{ matrix.bench.adapter }}' \ | ||
| --threshold-measure latency \ | ||
| --threshold-test percentage \ | ||
| --threshold-lower-boundary _ \ | ||
| --threshold-upper-boundary 0.25 \ | ||
| --threshold-measure throughput \ | ||
| --threshold-test percentage \ | ||
| --threshold-lower-boundary 0.25 \ | ||
| --threshold-upper-boundary _ \ | ||
| --error-on-alert \ | ||
| --github-actions '${{ secrets.GITHUB_TOKEN }}' \ | ||
| "${{ matrix.bench.command }}" | ||
