GoHammer

GoHammer is a test tool designed to get performance metrics (TPS) of the nodes and operationg system by deploying a smart contract and calling smart contract's methods.
GoHammer provides configurable test profiles created by the user and easy execution of these test profiles. GoHammer inspired by Chainhammer and Quorum Profiling. TIG (Telegraf, InfluxDB, Grafana) stack taken from alekece/tig-stack.

GoHammer deploys number of transactions on the given nodes according to configuration file (config.json) then tps-monitoring tool collects TPS and node metrics and visualizes these data on Grafana (if you want to see node metrics gohammer has to be run on that node, if you are testing a remote node you can't get OS related metrics about these node.)

GoHammer's published paper.

Requirements

• Docker CLI
• Docker-compose
• Go Version 1.15.6

Installation

Docker

sudo apt-get update

sudo apt-get install \
    apt-transport-https \
    ca-certificates \
    curl \
    gnupg \
    lsb-release

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg

echo \
  "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \
  $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

sudo apt-get update

sudo apt-get install docker-ce docker-ce-cli containerd.io

Docker-compose

sudo curl -L https://github.com/docker/compose/releases/download/1.21.2/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose

sudo chmod +x /usr/local/bin/docker-compose

TPS-Monitor

git clone https://github.com/tubuarge/gohammer

cd gohammer/tps-monitor

go build

GoHammer

cd gohammer/gohammer

go build

Usage

Before running gohammer make sure every node in the given test profile config file is running.

Start TPS-Monitor tool on background.

cd gohammer/monitoring

docker-compose up -d

screen -mSL tps-monitor ./tps-monitor --httpendpoint http://localhost:22000 --consensus raft --influxdb --influxdb.token "grafana:grafana" --influxdb.bucket "metrics"

Note About Screen: Screen is a full-screen window manager that multiplexes a physical terminal between several processes. We use it to run tps-monitor on the background, after executing above command, you will see tps-monitor screen. You can deattach this screen by pressing CTRL + a + d key combination on your keyboard. If you want to go back to deattached screen type screen -r tps-monitor to terminal. If you want to close the screen simply type CTRL + c. For more information about Screen refer to this document.

After starting tps-monitor you can access Grafana UI from your browser with this URL http://localhost:3000 with username: admin and password: admin.

cd gohammer/gohammer

./GoHammer --testprofilefile ../temp_config.json --logdir ~/test

When the test finished you can find your test's log under file named <logdirPath>YYYY_MM_DD HH_MM_result.log.

List of Command-Line Arguments

Command	Description
--testprofilefile <config.json>	path of a json file that contains your test config.
--logdir	directory path where you want to store your log files (default is the same directory with gohammer executable).

Test Profile Config File(config.json)

Config file is a json file that consists of test profiles, this is the section where you can construct different types of test profiles.

{
  "profiles": [
    {
      "name": "Test Profile1",
      "concurrent": false,
      "roundRobin": true,
      "callContractMethod": true,
      "nodes": [
        {
         ...
        }
      ]
    },
    {
      "name": "Test Profile2",
      ...
    },
    ...
  ]
}

Profiles

profiles section contains information about how transactios will be run, which nodes will be involved.

key	Value	Type
name	name of the profile	string
concurrent	transaction will be deployed concurrently (NOTE: not implemented yet.)	boolean
roundRobin	a transaction will be deployed on the given nodes one after the other	boolean
callContractMethod	instead of deploying smart contracts, nodes are going to call method of the smart contract	boolean
nodes	nodes where the test profile will be run (for more information check nodes section	json array

Important: If you haven't set any deploy transaction configuration (like roundRobin or concurrent) your transaction will be deployed according to default configuration which is deploying number of transactions on a node then proceeding to other node.

Nodes

nodes section contains information about nodes where transactions will be deployed.

key	Value	type
name	name of the node	string
url	url and port of the node	string
cipher	cipher text of the node (can be found under qdata/dd{x}/keystore/key file)	string
deployCounts	how many transactions will be deployed on the given node	json array
deployInterval	how much time test will be stalled after deploying number of transactions ("10s", "1m" etc.)	string