Skip to content

Commit

Permalink
a proxy driver to benchmark remote system
Browse files Browse the repository at this point in the history
  • Loading branch information
fogfish committed Nov 19, 2015
1 parent 36cf4df commit be9bf3e
Show file tree
Hide file tree
Showing 4 changed files with 113 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,28 @@ $ ./priv/gp_latencies.sh

Also, you can plot multiple test runs on a single plot by using "-d" switch.

** Benchmarking Erlang cluster

A typical benchmark scenario is that Basho Bench spawn Erlang VM and executes the driver inside. However, there is needs to catch performance metrics from an application executed remotely within dedicated environment (e.g. probe performance from live system; benchmark an application inside C or Java node, etc). Bash Bench implements a generic =basho_bench_driver_cluster= that acts as proxy. It uses Erlang distribution to delegate benchmark responsibility to remote actor, which is randomly selected from configured pool.

Basho Bench do not define how the actors are spawned within SUT. It only defined a communication protocol. The actor is responsible to handle the message:

={pid(), atom(), key(), val()}=

- =pid()= : request originator, actor shall respond to this process
- =atom()= : id of operation to execute as defined in config file
- =key()= : materialized key value as defined by key generator function
- =val()= : materialized value as defined by value generator function

The actor executes the request, measures performance and respond to originator process =pid()= with one of the message ={ok, microsecond()}= or ={error, reason()}=

See cluster.config example for details. Use following command to spawn benchmark

#+BEGIN_SRC shell
./basho_bench -C nocookie -N [email protected] -J [email protected] examples/cluster.config
#+END_SRC


** Contributing
We encourage contributions to Basho Bench from the community.

Expand Down
27 changes: 27 additions & 0 deletions examples/cluster.config
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
%%
%% definition
{log_level, info}.
{report_interval, 1}.
{driver, basho_bench_driver_cluster}.

%%
%% workload
{mode, max}.
{duration, 1}.
{concurrent, 10}.
{key_generator, {int_to_bin_bigendian, {uniform_int, 10000}}}.
{value_generator, {fixed_bin, 1000}}.

{operations, [
{put, 1}
,{get, 1}
]}.

%%
%% config
{cluster_actors, [
{a, '[email protected]'}
{b, '[email protected]'}
{c, '[email protected]'}
]}.

59 changes: 59 additions & 0 deletions src/basho_bench_driver_cluster.erl
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
%% -------------------------------------------------------------------
%%
%% basho_bench: benchmark service on any within Erlang cluster
%% using distribution protocol
%%
%% Copyright (c) 2015 Dmitry Kolesnikov
%%
%% This file is provided to you under the Apache License,
%% Version 2.0 (the "License"); you may not use this file
%% except in compliance with the License. You may obtain
%% a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing,
%% software distributed under the License is distributed on an
%% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
%% KIND, either express or implied. See the License for the
%% specific language governing permissions and limitations
%% under the License.
%%
%% -------------------------------------------------------------------
-module(basho_bench_driver_cluster).

-export([
new/1,
run/4
]).

-record(state, {actor}).

%% ====================================================================
%% API
%% ====================================================================

new(Id) ->
Actors = basho_bench_config:get(cluster_actors, []),
{Name, Node} = Actor = lists:nth(random:uniform(length(Actors)), Actors),
case net_adm:ping(Node) of
pang ->
lager:error("~s is not available", [Node]),
{ok, #state{actor = undefined}};

pong ->
lager:info("worker ~b is bound to ~s on ~s", [Id, Name, Node]),
{ok, #state{actor = Actor}}
end.

run(Run, KeyGen, ValGen, #state{actor = Actor}=State) ->
Key = KeyGen(),
Val = ValGen(),
erlang:send(Actor, {self(), Run, Key, Val}),
receive
{ok, ElapsedT} ->
{ok, ElapsedT, State};

{error, Reason} ->
{error, Reason}
end.
5 changes: 5 additions & 0 deletions src/basho_bench_worker.erl
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,11 @@ worker_next_op(State) ->
{Res, DriverState} when Res == silent orelse element(1, Res) == silent ->
{ok, State#state { driver_state = DriverState}};

{ok, ElapsedT, DriverState} ->
%% time is measured by external system
basho_bench_stats:op_complete(Next, ok, ElapsedT),
{ok, State#state { driver_state = DriverState}};

{error, Reason, DriverState} ->
%% Driver encountered a recoverable error
basho_bench_stats:op_complete(Next, {error, Reason}, ElapsedUs),
Expand Down

0 comments on commit be9bf3e

Please sign in to comment.