tarantool / microb

Automatic performance regression testing framework

microB

Microbenchmarking for Tarantool. More details in wiki

Benchmark

Usage

tarantool start_runner.lua

Add a new benchmark

• Add a new file to the benchmarks folder
• Create a new configuration settings in microb/cfg.lua file. You must set name and engines parameters. name must be equal to the filename from the first bullet.

Minimal configuration example:

-- This module for benchmarks counts and other configuration value

-- Engine configuration options
local engine = {
    memtx = {
        engine_name = 'memtx',
        index = { 'hash', 'tree' },
        count = 500000,
        wal_mode = 'none'
    },
}

-- Benchmarks configuration settings (benchmarks must have the same names as in benchmarks folder)
local crud = { name = 'crud', engines = { engine.memtx } }

-- Global configuration settings
return {
    -- Number of iterations per benchmark
    bench_iters = 1,
    -- Benchmarks to run
    benchmarks = { crud }
}

Web Storage and Site

Install

• install tarantool
• install luarocks
• create rpm

$make

• install package

$sudo yum localinstall tarantool-microb-module-x.y-z.noarch.rpm

• enable installed modules in tarantool

$sudo cp /etc/tarantool/instances.available/*.lua  /etc/tarantool/instances.enabled/

• Start microb storage and web ui

$sudo tarantoolctl start microb_storage
$sudo tarantoolctl start microb_web

Usage

1. Configure and run storage

$tarantool start_storage.lua
2015-03-04 18:01:18.469 [4047] main/101/start_storage.lua C> version 1.6.4-428-g248a2a7
2015-03-04 18:01:18.470 [4047] main/101/start_storage.lua C> log level 5
2015-03-04 18:01:18.471 [4047] main/101/start_storage.lua I> mapping 1073741824 bytes for a shared arena...
...
2015-03-04 18:01:18.563 [4047] main/101/start_storage.lua I> Started http server at host = 0.0.0.0 and port = 3300 
2015-03-04 18:01:18.563 [4047] main/104/http/0.0.0.0:33001 I> started
2015-03-04 18:01:18.564 [4047] main C> entering the event loop

2. Run web ui

$tarantool start_web.lua
2015-03-04 18:05:35.162 [4156] main/101/tarantoolctl C> version 1.6.4-428-g248a2a7
2015-03-04 18:05:35.164 [4156] main/101/tarantoolctl C> log level 5
2015-03-04 18:05:35.164 [4156] main/101/tarantoolctl I> mapping 1073741824 bytes for a shared arena...
...
2015-03-04 18:05:35.278 [4156] main/101/microb_web I> Starting_remote connection box-net-box on host = 127.0.0.1, port = 33011
2015-03-04 18:05:35.284 [4156] main/101/microb_web I> Started http server at host = 0.0.0.0 and port = 22222
2015-03-04 18:05:35.285 [4156] main/108/http/0.0.0.0:22222 I> started
2015-03-04 18:05:35.285 [4156] main C> entering the event loop

Nginx proxy pass

By default microb run web module at 22222 port. If you want you can handle in with nginx

server {
        listen 80;
        server_name bench.build.tarantool.org;
        location / {
                proxy_pass http://127.0.0.1:22222;
        }
}

It's possible to save benchmarks in microb_storage using restful api. Example:

http://myserver.com/push?key=[API_KEY]&name=[METRIC_NAME]&param=[METRIC_VALUE]&v=[TARANTOOL_VERSION]&unit=[MEASUREMENT]&tab=[METRIC_GROUP]