Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 2.18 KB

README.md

File metadata and controls

63 lines (43 loc) · 2.18 KB
Raw

Bitcoin Core performance monitor 📈

This repository consists of two components

  • a codespeed installation which collects and presents benchmarking results in a web interface, and
  • a haphazard Python script for running high-level Bitcoin Core benchmarks which POSTs results to codespeed.

The benchmarks which are monitored are

  • Build time (make)
  • Unittest duration (make check)
  • Functional test framework duration (test/functional/test_runner.py)
  • Microbenchmarks (bench-bitcoin)
  • IBD up to some height from a local peer
  • Reindex up to some height

Installation

  1. Obtain all the dependencies necessary to build Bitcoin Core. Obtain an up-to-date copy of the chain at some $datadir location.
  2. Install the additional requirements through your package manager: time wget git python3-pip (must be python3.6).
  3. Then, run pip3 install -r runner/requirements.txt.

Starting codespeed

  1. cd codespeed && pip install --user -r requirements.txt
  2. Initialize the codespeed DB: python manage.py migrate
  3. Create an admin user (for posting results): python manage.py createsuperuser
    • If you want ./bin/run_bench to work unmodified, use credentials root/foobar00.
  4. Load required initial data: python manage.py shell < ../bin/initialize_data.py
  5. In a separate terminal window, start the development server: python manage.py runserver 8000
  6. Browse to http://localhost:8000 and ensure codespeed is up.

Starting the synced peer

  1. [assuming you have obtained a relatively up-to-date chain in $datadir]
  2. In a separate terminal window, run ./bin/start_synced $datadir
  3. Ensure the peer is up by running /path/to/bitcoin-cli -rpcport=9001 -rpcuser=foo -rpcpassword=bar getblockchaininfo.

Running the benchmarks

  1. Run ./bin/run_bench.

Running a subset of benches

Use the BENCHES_TO_RUN envvar when invoking runner/run_bench.py to only run certain benchmarks.

Running to a height

Use the BITCOIND_STOPATHEIGHT envvar when invoking runner/run_bench.py to control the height to sync to. This will automatically be reflected in the name of the benchmarks which are generated.