ci(l2): automate flamegraph tests

.github/scripts/flamegraph_watcher.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+# This script sends 171 * <iterations> transactions to a test account, per defined private key
+# then polls the account balance until the expected balance has been reached
+# and then kills the process. It also measures the elapsed time of the test and
+# outputs it to Github Action's outputs.
+iterations=50
+value=1
+account=0x33c6b73432B3aeA0C1725E415CC40D04908B85fd
+end_val=$((171 * $iterations * $value))
+
+ethrex_l2 test load --path /home/runner/work/ethrex/ethrex/test_data/private_keys.txt -i $iterations -v --value $value --to $account >/dev/null
+
+start_time=$(date +%s)
+output=$(ethrex_l2 info -b -a $account --wei 2>&1)
+while [[ $output -lt $end_val ]]; do
+    sleep 5
+    output=$(ethrex_l2 info -b -a $account --wei 2>&1)
+done
+end_time=$(date +%s)
+elapsed=$((end_time - start_time))
+
+minutes=$((elapsed / 60))
+seconds=$((elapsed % 60))
+output=$(ethrex_l2 info -b -a $account --wei 2>&1)
+echo "Balance of $output reached in $minutes min $seconds s, killing process"
+
+sudo pkill "$PROGRAM"
+
+while pgrep -l "perf" >/dev/null; do
+    sleep 10
+done
+
+# We need this for the following job, to add to the static page
+echo "time=$minutes minutes $seconds seconds" >>"$GITHUB_OUTPUT"

.github/scripts/publish_link_flamegraphs.sh

@@ -0,0 +1,23 @@
+curl -XPOST -H "Content-type: application/json" -d '{
+  "blocks": [
+    {
+      "type": "header",
+      "text": {
+        "type": "plain_text",
+        "text": "Daily Flamegraph Report"
+      }
+    },
+    {
+      "type": "divider"
+    },
+    {
+      "type": "section",
+      "text": {
+        "type": "mrkdwn",
+        "text": "🔥 Flamegraphs are available at *<https://lambdaclass.github.io/ethrex/|lambdaclass.github.io/ethrex/>*\n
+        • *<https://lambdaclass.github.io/ethrex/flamegraph_ethrex.svg/flamegraph_ethrex.svg|Ethrex Flamegraph>*\n
+        • *<https://lambdaclass.github.io/ethrex/flamegraph_reth.svg/flamegraph_reth.svg|Reth Flamegraph>*\n"
+      }
+    }
+  ]
+}' "$url"

.github/workflows/daily_reports.yaml

@@ -189,3 +189,22 @@ jobs:
         env:
           url: ${{ secrets.LEVM_SLACK_WEBHOOK }}
         run: sh .github/scripts/publish_levm_ef_tests_summary.sh
+
+  flamegraphs-page:
+    name: Post to Slack link to Flamegraphs Page
+    runs-on: ubuntu-latest
+    steps:
+      - name: Post results to ethrex L1 slack channel
+        env:
+          url: ${{ secrets.ETHREX_L1_SLACK_WEBHOOK }}
+        run: sh .github/scripts/publish_link_flamegraphs.sh
+
+      - name: Post results to ethrex L2 slack channel
+        env:
+          url: ${{ secrets.ETHREX_L2_SLACK_WEBHOOK }}
+        run: sh .github/scripts/publish_link_flamegraphs.sh
+
+      - name: Post results to levm slack channel
+        env:
+          url: ${{ secrets.LEVM_SLACK_WEBHOOK }}
+        run: sh .github/scripts/publish_link_flamegraphs.sh

.github/workflows/flamegraph_reporter.yaml

@@ -0,0 +1,258 @@
+name: Daily Flamegraph Reporter
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "**" ]
+  workflow_dispatch:
+
+env:
+  RUST_VERSION: 1.84.0
+  RUST_RETH_VERSION: 1.84.0
+
+jobs:
+  flamegraph-ethrex:
+    name: Generate Flamegraph for Ethrex
+    runs-on: ubuntu-latest
+    env:
+      PROGRAM: ethrex
+    outputs:
+      time: ${{steps.generate-flamegraph-ethrex.outputs.time}}
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Rustup toolchain install
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          toolchain: ${{ env.RUST_VERSION }}
+
+      - name: Caching
+        uses: Swatinem/rust-cache@v2
+
+      - name: Cache Cargo binaries
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/bin
+          key: ${{ runner.os }}-cargo-install-${{ hashFiles('cmd/ethrex_l2/Cargo.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-install-
+
+      - name: Change perf settings
+        run: |
+          sudo sysctl kernel.perf_event_paranoid=-1
+          sudo sysctl -w kernel.kptr_restrict=0
+          sudo chmod +r /proc/kallsyms
+          sudo perf list hw
+
+      - name: Checkout gimli addr2line
+        uses: actions/checkout@v4
+        with:
+          repository: gimli-rs/addr2line
+          path: "addr2line"
+
+      - name: Build gimli addr2line
+        working-directory: ./addr2line
+        run: |
+          # Little hack we need else it throws error building
+          echo "[workspace]" >> ./Cargo.toml
+          cargo install --features="bin" addr2line
+
+      - name: Install flamegraph
+        run: |
+          cargo install flamegraph
+          cargo install inferno
+
+      - name: Install ethrex_l2 cli
+        run: |
+          cargo install --path cmd/ethrex_l2
+          ethrex_l2 config create default --default
+          ethrex_l2 config set default
+
+      - name: Build ethrex
+        run: CARGO_PROFILE_RELEASE_DEBUG=true cargo build --release --bin ethrex --features dev
+
+      - id: generate-flamegraph-ethrex
+        name: Generate Flamegraph data for Ethrex
+        shell: bash
+        run: |
+          CARGO_PROFILE_RELEASE_DEBUG=true cargo flamegraph -c "record -o perf.data -F997 --call-graph dwarf,16384 -g" \
+          --bin ethrex --features dev  --  --network /home/runner/work/ethrex/ethrex/test_data/genesis-l2.json --http.port 1729 >/dev/null &
+          echo "waiting to execute load test..."
+          sleep 30 &&
+          echo "executing load test..."
+          bash /home/runner/work/ethrex/ethrex/.github/scripts/flamegraph_watcher.sh &&
+          echo "Load test finished"
+
+      - name: Generate SVG
+        shell: bash
+        run: |
+          PATH=$HOME/.cargo/bin:$PATH which addr2line
+          PATH=$HOME/.cargo/bin:$PATH perf script -v -i /home/runner/work/ethrex/ethrex/perf.data --no-inline > stack.data
+          inferno-collapse-perf -q < stack.data > collapsed.data
+          inferno-flamegraph --title "Ethrex Flamegraph" < collapsed.data > flamegraph_ethrex.svg
+
+      - name: Upload artifacts - flamegraph_ethrex.svg
+        uses: actions/upload-artifact@v4
+        with:
+          name: flamegraph_ethrex.svg
+          path: ./flamegraph_ethrex.svg
+
+  flamegraph-reth:
+    name: Generate Flamegraph for Reth
+    runs-on: ubuntu-latest
+    env:
+      PROGRAM: reth
+    outputs:
+      time: ${{steps.generate-flamegraph-reth.outputs.time}}
+    steps:
+      - name: Cache Cargo binaries
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/bin
+          key: ${{ runner.os }}-cargo-install-${{ hashFiles('cmd/ethrex_l2/Cargo.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-install-
+
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Rustup toolchain install
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          toolchain: ${{ env.RUST_RETH_VERSION }}
+
+      - name: Cache reth repository
+        uses: actions/cache@v4
+        id: cache-reth-repo
+        with:
+          path: reth
+          key: reth-repo-main-${{ hashFiles('reth/Cargo.lock') }}
+          restore-keys: |
+            reth-repo-${{ env.RETH_REF }}-
+            reth-repo-
+
+      - name: Checkout reth
+        if: steps.cache-reth-repo.outputs.cache-hit != 'true'
+        uses: actions/checkout@v4
+        with:
+          repository: paradigmxyz/reth
+          path: "reth"
+          ref: main
+
+      - name: Caching
+        uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: "reth -> target"
+          key: reth-build-main
+
+      - name: Change perf settings
+        run: |
+          sudo sysctl kernel.perf_event_paranoid=-1
+          sudo sysctl -w kernel.kptr_restrict=0
+          sudo chmod +r /proc/kallsyms
+          sudo perf list hw
+
+      - name: Checkout gimli addr2line
+        uses: actions/checkout@v4
+        with:
+          repository: gimli-rs/addr2line
+          path: "addr2line"
+
+      - name: Build gimli addr2line
+        working-directory: ./addr2line
+        run: |
+          # Little hack we need else it throws error building
+          echo "[workspace]" >> ./Cargo.toml
+          cargo install --features="bin" addr2line
+
+      - name: Install flamegraph
+        run: |
+          cargo install flamegraph
+          cargo install inferno
+
+      - name: Install ethrex_l2 cli
+        run: |
+          cargo install --path cmd/ethrex_l2
+          ethrex_l2 config create default --default
+          ethrex_l2 config set default
+
+      - id: generate-flamegraph-reth
+        name: Build and test reth
+        shell: bash
+        # --dev.block-time 1000ms set to 1000ms to match ethrex block generation time
+        run: |
+          cd ./reth
+          CARGO_PROFILE_RELEASE_DEBUG=true cargo flamegraph -c "record -o perf.data -F997 --call-graph dwarf,16384 -g" --bin reth --profile profiling \
+          -- node --chain /home/runner/work/ethrex/ethrex/test_data/genesis-load-test.json --dev \
+          --dev.block-time 1000ms --http.port 1729  --txpool.max-pending-txns 100000000 --txpool.max-new-txns 1000000000 \
+          --txpool.pending-max-count 100000000 --txpool.pending-max-size 10000000000 --txpool.basefee-max-count 100000000000 \
+          --txpool.basefee-max-size 1000000000000 --txpool.queued-max-count 1000000000 >/dev/null &
+          echo "waiting to execute load test..."
+          sleep 1200 &&
+          bash /home/runner/work/ethrex/ethrex/.github/scripts/flamegraph_watcher.sh &&
+          echo "Load test finished"
+
+      - name: Generate SVG
+        shell: bash
+        run: |
+          PATH=$HOME/.cargo/bin:$PATH which addr2line
+          PATH=$HOME/.cargo/bin:$PATH perf script -v -i /home/runner/work/ethrex/ethrex/reth/perf.data --no-inline > stack.data
+          inferno-collapse-perf -q < stack.data > collapsed.data
+          inferno-flamegraph --title "Reth Flamegraph" < collapsed.data > flamegraph_reth.svg
+
+      - name: Upload artifacts - flamegraph_reth.svg
+        uses: actions/upload-artifact@v4
+        with:
+          name: flamegraph_reth.svg
+          path: ./flamegraph_reth.svg
+
+  upload-static-page:
+    name: Upload artifacts for static page
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: [ flamegraph-ethrex, flamegraph-reth ]
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Download ethrex flamegraph artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: flamegraph_ethrex.svg
+          path: flamegraph_ethrex.svg
+
+      - name: Download reth flamegraph artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: flamegraph_reth.svg
+          path: flamegraph_reth.svg
+
+      - name: Update static page locally with new data
+        shell: bash
+        run: |
+          cp -r flamegraph_ethrex.svg pages/
+          cp -r flamegraph_reth.svg pages/
+          sed -i "s/{{LAST_UPDATE}}/$(TZ='Etc/GMT+3' date +'%Y-%m-%dT%H:%M:%S')/g" pages/index.html
+          sed -i "s/{{ETHREX_TIME}}/${{ needs.flamegraph-ethrex.outputs.time }}/g" pages/index.html
+          sed -i "s/{{RETH_TIME}}/${{ needs.flamegraph-reth.outputs.time }}/g" pages/index.html
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "pages/"
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -20,6 +20,7 @@ ethereum-package/
 
 **/.DS_Store
 **/.vscode
+**/.idea
 
 
 # EVM Mlir stuff

Makefile

@@ -196,3 +196,10 @@ load-node: install-cli ## 🚧 Runs a load-test. Run make start-node-with-flameg
 
 rm-test-db:  ## 🛑 Removes the DB used by the ethrex client used for testing
 	sudo cargo run --release --bin ethrex -- removedb --datadir test_ethrex
+
+flamegraph:
+	sudo -E CARGO_PROFILE_RELEASE_DEBUG=true cargo flamegraph --bin ethrex --features dev  --  --network test_data/genesis-l2.json --http.port 1729 >/dev/null &
+	bash scripts/flamegraph.sh
+
+test-load:
+	ethrex_l2 test load --path ./test_data/private_keys.txt -i 1000 -v  --value 10000000 --to 0xFCbaC0713ACf16708aB6BC977227041FA1BC618D