Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/tubuarge/gohammer

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/tubuarge/gohammer
Owner: tubuarge
License: gpl-3.0
Created: 2020-12-28T13:18:59.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2021-11-12T09:36:56.000Z (over 2 years ago)
Last Synced: 2024-02-07T00:06:48.827Z (5 months ago)
Language: Go
Size: 365 KB
Stars: 15
Watchers: 5
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-quorum - gohammer - Quorum and Besu TPS performance tool written in golang. Based on scenario configuration to load transactions to your network. (Software components / Performances)

README

# 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](https://github.com/drandreaskrueger/chainhammer) and [Quorum Profiling](https://github.com/ConsenSys/quorum-profiling). TIG (Telegraf, InfluxDB, Grafana) stack taken from [alekece/tig-stack](https://github.com/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](https://dergipark.org.tr/en/pub/ject/issue/64442/980118).

## Requirements
* Docker CLI
* Docker-compose
* Go Version 1.15.6

## Installation

### Docker
```bash
sudo apt-get update
```

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

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

```bash
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
```
```bash
sudo apt-get update
```
```bash
sudo apt-get install docker-ce docker-ce-cli containerd.io
```

### Docker-compose
```bash
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
```
```bash
sudo chmod +x /usr/local/bin/docker-compose
```

### TPS-Monitor
```bash
git clone https://github.com/tubuarge/gohammer
```
```bash
cd gohammer/tps-monitor
```
```bash
go build
```

### GoHammer
```bash
cd gohammer/gohammer
```
```bash
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.
```bash
cd gohammer/monitoring
```
```bash
docker-compose up -d
```
```bash
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](https://www.gnu.org/software/screen/manual/screen.html).

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

```bash
cd gohammer/gohammer
```
```bash
./GoHammer --testprofilefile ../temp_config.json --logdir ~/test
```
When the test finished you can find your test's log under file named `YYYY_MM_DD HH_MM_result.log`.

## 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.

```json
{
"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 |