ben

package module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 30, 2017 License: MIT Imports: 7 Imported by: 0

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.

Install

With go get

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

Requirements

  • Docker 17.03.0-ce+

Supported clouds

Quick Start

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

{
  "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 file will be generated.

Checkout examples folder for more.



More docs

License

MIT © Carlos Derich

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Runner

type Runner struct {
	// contains filtered or unexported fields
}

Runner defines the top-level runner struct

func New

func New(c *config.Config) *Runner

New is the Runner initializer

func (*Runner) BuildRuntime

func (r *Runner) BuildRuntime(b builders.RuntimeBuilder, output string, display bool) (reporter.ReportData, error)

BuildRuntime builds the appropriate runtime

func (*Runner) Run

func (r *Runner) Run(output string, display bool) error

Run is the entrypoint method

Directories

Path Synopsis
_examples
cmd
ben command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL