search

NatoliChris / diablo-benchmark

The "DIstributed Analytical BLOckchain" Benchmark Framework. (Diablo). Measures blockchains with a focus on real-world applications and workload generation.
Apache License 2.0
11 stars 8 forks source link

readme

UNMAINTAINED REPOSITORY

The ownership of this repository has been moved to: https://github.com/blockchain-benchmarking/diablo

The main/master branch has also been decommissioned, as it has been superceded by develop and v2 by the diablo team. I am unfortunately no longer involved in the project so this repository will be archived.

Diablo: Distributed Analytical BLOckchain Benchmark Framework

Diablo, an analytical blockchain benchmark framework focusing on distributed clients performing real-world workloads. The focus of this benchmark is to provide a benchmark framework with a focus on truly distributed clients performing realistic workloads to evaluate and analyse different blockchain systems.

Other Sections

Workloads

Architecture

Since the benchmark is developed with distributed clients, the architecture can become quite complex. The main goal is to limit the required implementation details to allow for easy adoption of new chains. We also focus on providing ease of workload definition, which can help provide a pathway for new workloads to be designed in future.

docs/architecture

The communication between aspects is as follows:

docs/communication

Configurations

Benchmark

The benchmark configuration defines the workload, the number of client machines and the number of worker threads running on the client. This is where the main aspect of the benchmark is defined.

Chain

The chain configuration defines the information about the blockchain network. It provides the list of blockchain node addresses and provides information about keys and accounts. The keys are optional, but required if a genesis already exists, or, the blockchain is currently already running.

Primary

This is the main Diablo node, it orchestrates the benchmark to be run. It generates and distributes the workload to the secondaries, and sends commands to run and retrieve results from the benchmark.

Secondary

The secondary clients are acting as clients interacting with the blockchain. Each secondary communicates with the primary to recieve commands and run the related work. It may control a group of worker threads, or just run one thread. It connects with the blockchain node and executes the transactions to the connected node.

Getting Started

Requirements

Installation

  1. Clone this repository
  2. Run go mod download in this repository to install dependencies.
  3. Build the benchmark using the Makefile or directly calling go build main/diablo.go

Running the Benchmark

  1. Start the primary benchmark node:

    ./diablo primary -c /path/to/benchmark/config -cc /path/to/chain/config -a "<listen_address>:<port>"

    for example:

    ./diablo primary -c  scripts/sample/workloads/sample_simple.yaml -cc scripts/sample/blockchain-configs/ganache-basic-accounts.yaml -a "0.0.0.0:8323"

  2. Once you see the "ready to connect", start the secondaries on their respective machines:

    ./diablo secondary -m "<Primary IP>:<port>" -cc /path/to/chain/config -c /path/to/config

    for example:

    ./diablo secondary -m "127.0.0.1:8323" --chain-config scripts/sample/blockchain-configs/ganache-basic-accounts.yaml --config scripts/sample/workloads/sample-simple.yaml

If you would like to run the sample benchmark for seeing how diablo operates, please see Sample Example.

It will then run through the benchmark and perform the relevant analysis.

Reading Material (for development)