rpc-bench 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d37a1b9b71d4c41226d132a14cf626b104eba9b5
-  data.tar.gz: 2798cf1d52f627983e32f789d1db29a2548e3ba8
+  metadata.gz: 197357f01e80f24d1ff3999dc1f189116d1b6088
+  data.tar.gz: 3a9fb7dd595fcfa8786c472681b4388ecc04e94d
 SHA512:
-  metadata.gz: fa8940339142ecf4264fe0278445345df5a5d8442c38e9ce2e0d1ac83ad86ae001973226c17fbf9b767f4e9c1fe550c077fc8e7300b6726485ad53ac328828b1
-  data.tar.gz: 0cead41d618f4d3b036e43e60af378dc4f8dbab6170d7417b931a5595a0e070a20b619dcf5fe208d994eae509b32e94b9f37fb8554e61fd2f469dcc0204cf881
+  metadata.gz: 21e47f7cf5dfad36ebb8534225b260d32a72c21904b8793b3640d503d66b0fb5e2c09ba68b34b7d36004f5cb44a4fc0df89027b6a13934605d399a1df2f3ab1e
+  data.tar.gz: 4141e3a126c7ef3fc1ce9f0d1d2208c0961c3b8f19e958e5b02705db6f896031799f0983a261708cdfb82738bbdd68fb242ff18689b12c4f1514613beb6397bb

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+.*.sw*
+*.gem

data/README.md

@@ -1,41 +1,83 @@
-# RpcBench
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rpc_bench`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+# RPCBench
+RPCBench is a simple benchmark tool for RabbitMQ(AMQP, STOMP), ZeroMQ, gRPC.
+For benchmarking RPC using these middleware, RPCBench using following library.
 
 ## Installation
+You have to install some libraries which client of RPCBench uses.
+This explanes the procedure to install them on Ubuntu14.04.
 
-Add this line to your application's Gemfile:
+### Install some packages
+Some packages is needed to prepare following environment (e.g. building `libzmq` library).
+```
+$ sudo apt-get install protobuf-compiler autoconf rabbitmq-server libtool
+```
 
-```ruby
-gem 'rpc_bench'
+### for gRPC
+Here is a procedure to install Ruby gems to benchmark gRPC.
+```
+$ git clone https://github.com/grpc/grpc.git
+$ cd grpc
+$ bundle install
 ```
 
-And then execute:
+### for ZeroMQ
+You have to install `libzmq` which is the library of ZeroMQ.
+In this document, I'll show the procedure to install it from source code.
+```
+$ git clone git@github.com:zeromq/libzmq.git
+$ autoreconf -i
+$ ./configure; make
+$ sudo make install
+```
 
-    $ bundle
+### for RabbitMQ (stomp)
+To use rabbitmq-stomp plugin, you have to enable it from `rabbitmq-plugins` command like following and install Ruby gem of STOMP client.
+```
+$ sudo rabbitmq-plugins enable rabbitmq_stomp
+$ gem install stomp
+```
 
-Or install it yourself as:
+### RPCBench
+Now, you have finished groundwork to benchmark using RPCBench.
+Here is a way to install it.
 
-    $ gem install rpc_bench
+```
+$ gem install rpc_bench
+```
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Server
+Here is the usage of server.
+```
+Usage: rpc_bench_server [options]
+    -m, --mode m                     specify benchmark mode {rabbitmq|rabbitmq-stomp|newtmq|zeromq|grpc} [default: rabbitmq]
+    -s, --server s                   specify server to send request
+    -p, --port p                     specify port number on which server listens
+```
 
-## Contributing
+When you want to benchmark ZeroMQ, you execute `rpc_bench_server` command with `-m zeromq` which means 'ZeroMQ server mode'. And the parameter of `-p` means port number to listen.
+```
+$ rpc_bench_server -m zeromq -p 20000
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rpc_bench. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+### Client
+Here is the usage of client.
+```
+Usage: rpc_bench_client [options]
+    -m, --mode m                     specify benchmark mode {rabbitmq|rabbitmq-stomp|newtmq|zeromq|grpc} [default: rabbitmq]
+    -s, --server s                   specify server to send request
+    -p, --port p                     specify port number on which server listens
+    -c, --concurrency c              specify concurrent level [default: 10]
+    -n, --number n                   specify request number per thread [default: 100]
+```
 
+When you want to benchmark ZeroMQ, you do command `rpc_benchmark_client` command with `-m zeromq` in the same way.
+Additionally, you can take some parameters that is `-c, --concurrency` and `-n, --number`.
+The `--concurrency` means the number of threads to execute the processing to send request to server. And the `--number` means the number of requests to send request per thread.
+```
+$ rpc_bench_client -m zeromq -p 20000 -c 16 -n 50000
+```
 
 ## License
-
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/bin/rpc_bench

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'rpc_bench'
+
+optobj = RPCBench::Options.new
+
+begin
+  options = optobj.parse
+rescue OptionParser::MissingArgument, OptionParser::InvalidOption => e
+  puts "[warning] failed to parse command line option (#{e})"
+  puts optobj.usage
+
+  exit 1
+end
+
+client = RPCBench::Client.new(options)
+
+client.run

data/bin/rpc_bench_client

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'rpc_bench'
+
+optobj = RPCBench::ClientOptions.new
+
+begin
+  options = optobj.parse
+rescue OptionParser::MissingArgument, OptionParser::InvalidOption => e
+  puts "[warning] failed to parse command line option (#{e})"
+  puts optobj.usage
+
+  exit 1
+end
+
+client = RPCBench::Client.new(options)
+
+client.run

data/bin/rpc_bench_server

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'rpc_bench'
+
+optobj = RPCBench::ServerOptions.new
+
+begin
+  options = optobj.parse
+rescue OptionParser::MissingArgument, OptionParser::InvalidOption => e
+  puts "[warning] failed to parse command line option (#{e})"
+  puts optobj.usage
+
+  exit 1
+end
+
+server = RPCBench::Server.new(options)
+
+server.run

data/lib/rpc_bench.rb

@@ -1,5 +1,13 @@
 require "rpc_bench/version"
+require "rpc_bench/options"
+require "rpc_bench/client"
+require "rpc_bench/server"
+require "rpc_bench/driver"
+require "rpc_bench/driver_rabbitmq"
+require "rpc_bench/driver_grpc"
+require "rpc_bench/driver_zmq"
+require "rpc_bench/driver_stomp"
 
-module RpcBench
+module RPCBench
   # Your code goes here...
 end

data/lib/rpc_bench/client.rb

@@ -0,0 +1,47 @@
+module RPCBench
+  class Client
+    def initialize(opts)
+      @bench_conc = opts[:conc]
+      @bench_num = opts[:num]
+
+      case opts[:mode]
+      when 'rabbitmq'
+        @driver = RabbitMQ::Client.new opts
+      when 'grpc'
+        @driver = GRPC::Client.new opts
+      when 'zeromq'
+        @driver = ZeroMQ::Client.new opts
+      when 'stomp'
+        @driver = Stomp::Client.new opts
+      else
+        raise RuntimeError.new("failed to initialize driver of '#{opts[:mode]}'")
+      end
+    end
+
+    def validate? results
+      results.all? {|x| x == 2}
+    end
+
+    def run
+      t_start = Time.now
+
+      threads = []
+      (1..@bench_conc).each do |x|
+        threads << Thread.new do
+          @driver.send(1, @bench_num)
+        end
+      end
+
+      results = threads.map(&:value).flatten
+      unless(validate? results)
+        puts "[error] failed to get accurate result"
+      end
+
+      @driver.close
+
+      t_end = Time.now
+
+      puts "Time: #{t_end - t_start}"
+    end
+  end
+end

data/lib/rpc_bench/driver.rb

@@ -0,0 +1,19 @@
+module RPCBench
+  class Driver
+    def set_handler handler
+      @handler = handler
+    end
+
+    def send(data, count)
+      begin
+        send_request(data, count)
+      rescue NameError => e
+        puts "[warning] failed to send request (#{e})"
+      end
+    end
+
+    def close
+      # nop
+    end
+  end
+end

data/lib/rpc_bench/driver_grpc.rb

@@ -0,0 +1,96 @@
+require 'protobuf/message'
+require 'protobuf/rpc/service'
+
+require 'grpc'
+require 'thread'
+
+module RPCBench
+  module GRPC
+    SERVICE_NAME = 'rpc_bench'
+
+    ##
+    # Message Fields
+    #
+    class TmpRequest < Protobuf::Message
+      required :int32, :num, 1
+    end
+    class TmpReply < Protobuf::Message
+      required :int32, :num, 1
+    end
+
+    ##
+    # Service Classes
+    #
+    class ServiceCalc < Protobuf::Rpc::Service
+      rpc :calc_tmp, TmpRequest, TmpReply
+    end
+
+    class Calc
+      class Service
+        include ::GRPC::GenericService
+
+        self.marshal_class_method = :encode
+        self.unmarshal_class_method = :decode
+        self.service_name = SERVICE_NAME
+
+        rpc :CalcTmp, TmpRequest, TmpReply
+      end
+      Stub = Service.rpc_stub_class
+    end
+
+    class Client < Driver
+      def initialize opts
+        @opts = opts
+      end
+  
+      def sendmsg stub, data
+        begin
+          stub.calc_tmp(RPCBench::GRPC::TmpRequest.new(num: data)).num
+        rescue ::GRPC::BadStatus => e
+          if(e.code == 8)
+            sendmsg stub, data
+          else
+            puts "[warning] other error is occurrs"
+          end
+        end
+      end
+  
+      def send_request(data, count)
+        stub = RPCBench::GRPC::Calc::Stub.new("#{@opts[:host]}:#{@opts[:port]}", :this_channel_is_insecure)
+  
+        results = []
+        (1..count).each do |_|
+          results << sendmsg(stub, data)
+        end
+
+        results
+      end
+    end
+    class Server < Driver
+      @@handler = nil
+
+      def initialize opts
+        @opts = opts
+      end
+
+      def self.handler
+        @@handler
+      end
+
+      def run
+        @@handler = @handler
+
+        s = ::GRPC::RpcServer.new
+        s.add_http2_port("#{@opts[:host]}:#{@opts[:port]}", :this_port_is_insecure)
+        s.handle(MyCalc)
+        s.run_till_terminated
+      end
+
+      class MyCalc < RPCBench::GRPC::Calc::Service
+        def calc_tmp(value, obj)
+          TmpReply.new(num: RPCBench::GRPC::Server.handler.callback(value.num))
+        end
+      end
+    end
+  end
+end

data/lib/rpc_bench/driver_rabbitmq.rb

@@ -0,0 +1,64 @@
+require 'bunny'
+
+module RPCBench
+  module RabbitMQ
+    QNAME = 'rpc_queue'
+
+    class Client < Driver
+      def initialize opts
+        @opts = opts
+      end
+  
+      def send_request data, count
+        results = []
+
+        conn = Bunny.new(host: @opts[:host], port: @opts[:port])
+        conn.start
+  
+        ch = conn.create_channel
+        exchange = ch.default_exchange
+  
+        reply_queue = ch.queue("", :exclusive => true)
+        (1..count).each do |_|
+          exchange.publish(data.to_s, :routing_key => RPCBench::RabbitMQ::QNAME, :reply_to => reply_queue.name)
+        end
+  
+        reply_queue.subscribe(:block => true) do |dinfo, _, data|
+          results << data.to_i
+
+          if results.size >= count
+            dinfo.consumer.cancel
+            break
+          end
+        end
+        ch.close
+        conn.close
+
+        results
+      end
+    end
+    class Server < Driver
+      def initialize opts
+        @opts = opts
+      end
+
+      def run
+        conn = Bunny.new(host: @opts[:host], port: @opts[:port])
+        conn.start
+
+        ch = conn.create_channel
+
+        queue = ch.queue RPCBench::RabbitMQ::QNAME
+        exchange = ch.default_exchange
+        queue.subscribe(:block => true) do |_, attr, data|
+          resp = @handler.callback(data.to_i)
+
+          exchange.publish(resp.to_s, :routing_key => attr.reply_to, :correlation_id => attr.correlation_id)
+        end
+
+        ch.close
+        conn.close
+      end
+    end
+  end
+end

data/lib/rpc_bench/driver_stomp.rb

@@ -0,0 +1,48 @@
+require 'stomp'
+
+module RPCBench
+  module Stomp
+    QNAME = '/queue/rpc-bench'
+
+    class Client < Driver
+      TEMP_QNAME = '/temp-queue/rpc-bench'
+      def initialize opts
+        @opts = opts
+      end
+  
+      def send_request data, count
+        results = []
+
+        conn = ::Stomp::Connection.open('guest', 'guest', @opts[:host], @opts[:port])
+        (1..count).each do |x|
+          conn.publish(RPCBench::Stomp::QNAME, data.to_s, {
+            'reply-to' => TEMP_QNAME
+          })
+        end
+        (1..count).each do |_|
+          results << conn.receive.body.slice(/[0-9]*/).to_i
+        end
+        conn.disconnect
+
+        results
+      end
+    end
+    class Server < Driver
+      def initialize opts
+        @opts = opts
+      end
+
+      def run
+        conn = ::Stomp::Connection.open('guest', 'guest', @opts[:host], @opts[:port])
+
+        conn.subscribe RPCBench::Stomp::QNAME
+        loop do
+          msg = conn.receive
+          reply = @handler.callback(msg.body.to_i)
+  
+          conn.publish(msg.headers['reply-to'], reply.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/rpc_bench/driver_zmq.rb

@@ -0,0 +1,62 @@
+require 'ffi-rzmq'
+
+module RPCBench
+  module ZeroMQ
+    class Base < Driver
+      def initialize opts
+        @opts = opts
+        @context = ZMQ::Context.new
+      end
+    end
+    class Client < Base
+      def initialize opts
+        super opts
+      end
+  
+      def send_request data, count
+        sock = @context.socket(ZMQ::REQ)
+        sock.connect("tcp://#{@opts[:host]}:#{@opts[:port]}")
+  
+        results = []
+        (1..count).each do |_|
+          # sending request
+          sock.send_string data.to_s
+  
+          # receiving reply
+          reply = ''
+          sock.recv_string(reply)
+
+          results << reply.slice(/[0-9]+/).to_i
+        end
+        sock.close
+
+        results
+      end
+  
+      def close
+        @context.terminate
+      end
+    end
+    class Server < Base
+      def initialize opts
+        super opts
+      end
+
+      def run
+        sock = @context.socket(ZMQ::REP)
+        sock.bind("tcp://*:#{@opts[:port]}")
+
+        loop do
+          request = ''
+
+          sock.recv_string(request)
+
+          data = request.inspect.slice(/[0-9]+/).to_i
+
+          # Send reply back to client
+          sock.send_string(@handler.callback(data).to_s)
+        end
+      end
+    end
+  end
+end

data/lib/rpc_bench/options.rb

@@ -0,0 +1,73 @@
+require "optparse"
+
+module RPCBench
+  class Options
+    MODE_VALUES = ['rabbitmq', 'stomp', 'zeromq', 'grpc']
+
+    OPT_DEFAULT = {
+      :host => 'localhost',
+      :port => 5672,
+      :mode => 'rabbitmq',
+    }
+    def initialize
+      def sets(key, short, long, desc)
+        @opt.on(short, long, desc) {|v| @options[key] = v}
+      end
+      def setn(key, short, long, desc)
+        @opt.on(short, long, desc) {|v| @options[key] = v.to_i}
+      end
+
+      @options = OPT_DEFAULT
+      @opt = OptionParser.new
+      
+      sets(:mode, '-m', '--mode m',
+           'specify benchmark mode {rabbitmq|rabbitmq-stomp|newtmq|zeromq|grpc} [default: rabbitmq]')
+      sets(:host, '-s', '--server s',
+           'specify server to send request')
+      setn(:port, '-p', '--port p',
+           'specify port number on which server listens')
+    end
+
+    def parse
+      @opt.parse!(ARGV)
+
+      raise OptionParser::InvalidOption.new('validation failed') unless validated?
+
+      @options
+    end
+
+    def usage
+      @opt.help
+    end
+
+    private
+    def validated?
+      ret = true
+
+      ret &= MODE_VALUES.include? @options[:mode]
+      ret &= @options[:conc].is_a? Integer
+      ret &= @options[:num].is_a? Integer
+    end
+  end
+
+  class ServerOptions < Options
+    def initialize
+      super
+    end
+  end
+  class ClientOptions < Options
+    OPT_DEFAULT.merge!({
+      :conc => 10,
+      :num => 100,
+    })
+
+    def initialize
+      super
+
+      setn(:conc, '-c', '--concurrency c',
+           'specify concurrent level [default: 10]')
+      setn(:num,  '-n', '--number n',
+           'specify request number per thread [default: 100]')
+    end
+  end
+end

data/lib/rpc_bench/server.rb

@@ -0,0 +1,28 @@
+module RPCBench
+  class Server
+    def initialize(opts)
+      case opts[:mode]
+      when 'rabbitmq'
+        @driver = RabbitMQ::Server.new opts
+      when 'grpc'
+        @driver = GRPC::Server.new opts
+      when 'zeromq'
+        @driver = ZeroMQ::Server.new opts
+      when 'stomp'
+        @driver = Stomp::Server.new opts
+      else
+        raise RuntimeError.new("failed to initialize driver of '#{opts[:mode]}'")
+      end
+
+      @driver.set_handler self
+    end
+
+    def run
+      @driver.run
+    end
+
+    def callback(v)
+      v.to_i + 1
+    end
+  end
+end

data/lib/rpc_bench/version.rb

@@ -1,3 +1,3 @@
-module RpcBench
-  VERSION = "0.0.1"
+module RPCBench
+  VERSION = "0.1.0"
 end

data/rpc_bench.gemspec

@@ -5,7 +5,7 @@ require 'rpc_bench/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "rpc-bench"
-  spec.version       = RpcBench::VERSION
+  spec.version       = RPCBench::VERSION
   spec.authors       = ["Hiroyasu OHYAMA"]
   spec.email         = ["user.localhost2000@gmail.com"]
 
@@ -17,4 +17,11 @@ Gem::Specification.new do |spec|
   spec.bindir        = "bin"
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "grpc", "0.14.1"
+  spec.add_runtime_dependency "grpc-tools", "0.14.1"
+  spec.add_runtime_dependency "stomp", "1.4.0"
+  spec.add_runtime_dependency "bunny", "2.3.1"
+  spec.add_runtime_dependency "ffi-rzmq", "2.0.4"
+  spec.add_runtime_dependency "protobuf", "3.6.9"
 end

metadata

@@ -1,19 +1,106 @@
 --- !ruby/object:Gem::Specification
 name: rpc-bench
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Hiroyasu OHYAMA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-13 00:00:00.000000000 Z
-dependencies: []
+date: 2016-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: grpc-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: stomp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: ffi-rzmq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+- !ruby/object:Gem::Dependency
+  name: protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.9
 description: 
 email:
 - user.localhost2000@gmail.com
-executables: []
+executables:
+- rpc_bench
+- rpc_bench_client
+- rpc_bench_server
 extensions: []
 extra_rdoc_files: []
 files:
@@ -23,7 +110,18 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/rpc_bench
+- bin/rpc_bench_client
+- bin/rpc_bench_server
 - lib/rpc_bench.rb
+- lib/rpc_bench/client.rb
+- lib/rpc_bench/driver.rb
+- lib/rpc_bench/driver_grpc.rb
+- lib/rpc_bench/driver_rabbitmq.rb
+- lib/rpc_bench/driver_stomp.rb
+- lib/rpc_bench/driver_zmq.rb
+- lib/rpc_bench/options.rb
+- lib/rpc_bench/server.rb
 - lib/rpc_bench/version.rb
 - rpc_bench.gemspec
 homepage: https://github.com/userlocalhost2000/rpc_bench