https://github.com/drish/ben

Your benchmark assistant, written in Go.
https://github.com/drish/ben

benchmark benchmark-framework golang

Last synced: 27 days ago
JSON representation

Your benchmark assistant, written in Go.

• Host: GitHub
• URL: https://github.com/drish/ben
• Owner: drish
• License: mit
• Created: 2017-12-03T17:01:01.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-01-02T04:07:22.000Z (almost 7 years ago)
• Last Synced: 2024-08-05T17:25:55.819Z (4 months ago)
• Topics: benchmark, benchmark-framework, golang
• Language: Go
• Homepage:
• Size: 12.6 MB
• Stars: 66
• Watchers: 5
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-hacking-lists - drish/ben - Your benchmark assistant, written in Go. (Go)

README

        


  

  
Ben (beta)

  
Your benchmark assistant, written in Go.

  


    

    

    

    

  


---

Ben is a simple tool that helps you run your benchmarks on multiple hardware specs, clouds and runtime versions, so that you can easily compare you results against different environments.

## Install

With `go get`

```

$ go get https://github.com/drish/ben/cmd/ben

```

or with `curl`

```

curl -sf https://raw.githubusercontent.com/drish/ben/master/install.sh | sh

```

## Requirements

- Docker 17.03.0-ce+

## Supported clouds

  * [Hyper.sh](https://hyper.sh)

  * [ECS](https://aws.amazon.com/ecs/) (coming soon.)

## Quick Start

Add a `ben.json` file in the root of your project.

```json

{

  "environments": [

    {

      "runtime": "ruby",

      "version": "2.3",

      "machine": "local",

      "before": ["gem install benchmark-ips"],

      "command": "ruby bench.rb"

    },

    {

      "runtime": "ruby",

      "version": "2.5",

      "machine": "local",

      "before": ["gem install benchmark-ips"],

      "command": "ruby bench.rb"

    }

  ]

}

```

Then, in the root of your project run.

```

$ ben

```

After all benchmarks are done, a [benchmarks.md](https://github.com/drish/ben/tree/master/_examples/go/local/benchmarks.md) file will be generated.

Checkout [examples](https://github.com/drish/ben/tree/master/_examples) folder for more.

---



  



---

### More docs

  * [Running on hyper.sh](https://github.com/drish/ben/blob/master/docs/running-on-hyper.md)

  * [ben.json file spec](https://github.com/drish/ben/blob/master/docs/ben-json-spec.md)

## License

MIT © [Carlos Derich](https://dri.sh)