ruby-mqtt-bench 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb071932d4f5408baa1be95dbbde168c6be78105
+  data.tar.gz: b18612d37a36719675e4d20a33c1a194e1cd3369
+SHA512:
+  metadata.gz: 7f6fd8ec1324da568a825a5d58d89ba840dd52187888ce8df5416e59ff188dc5495957756d29392632fe67628ac093b8f90d1aba97156242b9019e587b322413
+  data.tar.gz: f62296b9266d19598009ade1f529f3fad784ea348656d52544eafb20b2397ecde6fd8495e3405a71314099e35fd95268194dc1bc5997e8915b55de6bcf034c92

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-mqtt-io.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    ruby-mqtt-bench (0.0.1)
+      concurrent-ruby (~> 1.0)
+      mqtt (~> 0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.0.0)
+    concurrent-ruby (1.0.0-java)
+    mqtt (0.3.1)
+    rake (10.5.0)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  rake (~> 10.0)
+  ruby-mqtt-bench!
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1,53 @@
+# ruby-mqtt-bench
+mqtt-bench for ruby
+
+This project is deeply inspired by [mqtt-bench](https://github.com/takanorig/mqtt-bench "mqtt-bench"). Ruby cannot provide the same performance as golang. This code is provided just for debugging purposes.
+
+
+## Installation
+
+    gem install ruby-mqtt-bench
+
+
+## How to use
+
+    ruby-mqtt-bench conf/mqtt_bench.conf
+
+## Configuration
+
+The configuration can be modified by editing mqtt_bench.conf as follows. mqtt_opts are passed to ruby-mqtt and bench_opts are used locally in ruby-mqtt-bench.
+
+    vi conf/mqtt_bench.conf
+    {
+      "mqtt_opts": {
+        "host": "127.0.0.1",
+        "port": 1883,
+        "keep_alive": 15
+      },
+      "bench_opts": {
+        "topic": "mqtt_bench",
+        "num_clients": 128,
+        "data_size": 64,
+        "num_msgs": 1000,
+        "interval": 0,
+        "time_key": "time",
+        "timestamp": "timestamp"
+      }
+    }
+
+- topic: topic to be published
+- num_clients: number of clients connecting to a target broker simultaneously
+- data_size: message size
+- num_msgs: total number of messages sent to a target broker
+- interval: message sending interval
+- time_key: attribute name of time when the message was published
+- timestamp: attribute name for passing timestamp information to fluentd (default nil)
+
+Message is created in JSON format. Because each message has minimum fields,
+minimum message size can be calculated as follows:
+
+Example message:
+
+    {:cid=>"001", :data=>"", :mid=>"00001", :time=>1455754303515}
+
+Field name and symbols have 50 bytes. "data" field size can be specified in configuration. "cid" (client id) and "mid" (message id) have number of digits with maximum number specified in configuration (num_clients and num_msgs. Time to send a message is recorded in the message as time field in ms.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/mqtt_bench

@@ -0,0 +1,143 @@
+#!/usr/bin/env ruby
+
+require 'mqtt'
+require 'json'
+require 'thwait'
+require 'time'
+
+# MQTT benchmark software written in Ruby
+# Message is created in JSON format.
+# Because each message has minimum fields,
+# minimum message size can be calculated as follows:
+#
+# Example configuration:
+# {
+#   "mqtt_opts": {
+#     "host": "127.0.0.1",
+#     "port": 1883,
+#     "keep_alive": 15
+#   },
+#   "bench_opts": {
+#     "num_clients": 512,
+#     "data_size": 64,
+#     "num_msgs": 1000,
+#     "interval": 0
+#   }
+# }
+#
+# Example message:
+#   {:cid=>"001", :data=>"", :mid=>"00001", :time=>1455754303515}
+#
+# Field name and symbols have 50 bytes.
+# "data" field size can be specified in configuration.
+# "cid" (client id) and "mid" (message id) have number of digits with
+# maximum number specified in configuration (num_clients and num_msgs.
+# Time to send a message is recorded in the message as time field in ms.
+#
+class MqttBench
+  attr_accessor :results, :total_results
+
+  def initialize(conf_file)
+    conf = JSON.parse(open(conf_file || File.dirname(__FILE__) + '/../conf/mqtt_bench.conf').read, symbolize_names: true)
+    @mqtt_opts = {
+      host: "127.0.0.1",
+      port: 1883,
+      keep_alive: 15
+    }.merge(conf[:mqtt_opts])
+
+    @bench_opts = {
+      topic: "mqtt_bench",
+      num_clients: 5,
+      data_size: 128,
+      num_msgs: 100,
+      interval: 1,
+      time_key: "time",
+      timestamp: nil
+    }.merge(conf[:bench_opts])
+  end
+
+  def curr_time
+    Time.now.instance_eval { self.to_i * 1000 + (usec/1000) }
+  end
+
+  def align_digits(basis, target)
+    sprintf("%0#{@bench_opts[basis].to_s.length}d", target)
+  end
+
+  def start
+    $stderr.puts "start mqtt #{@mqtt_opts[:host]}"
+    @clients = []
+    @threads = []
+    @results = Queue.new
+    @total_results = {}
+    @data = (0..(@bench_opts[:data_size]-1)).map {|i| i % 10}.join
+    @total_results[:start_time] = curr_time
+    @bench_opts[:num_clients].times do |i|
+      @threads[i] = Thread.new do
+        result = {}
+        msg_count = 0
+        topic = "#{@bench_opts[:topic]}/#{align_digits(:num_clients, i)}"
+        message = {
+          cid: align_digits(:num_clients, i),
+          data: @data
+        }
+        begin
+          client = MQTT::Client.new(@mqtt_opts)
+          result[:start_time] = curr_time
+          client.connect
+          while (true)
+            message[:mid] = align_digits(:num_msgs, msg_count + 1)
+            message[@bench_opts[:time_key].to_sym] = curr_time
+            message[@bench_opts[:timestamp].to_sym] = Time.now.utc.iso8601 if !@bench_opts[:timestamp].nil?
+            client.publish(topic, message.to_json)
+            msg_count += 1
+            break if @bench_opts[:num_msgs] - msg_count <= 0
+            sleep @bench_opts[:interval]
+          end
+          client.disconnect
+          result[:end_time] = curr_time
+          @results.push(result)
+        rescue MQTT::ProtocolException => e
+          $stderr.puts "Protocol error occurs: #{e.class},#{e.message}"
+          next
+        rescue Timeout::Error => e
+          $stderr.puts "Timeout error occurs: #{e.class},#{e.message}"
+          next
+        rescue SystemCallError => e
+          $stderr.puts "System call error occurs: #{e.class},#{e.message}"
+          next
+        rescue StandardError=> e
+          $stderr.puts "The other error occurs: #{e.class},#{e.message}"
+          next
+        end
+      end
+      #p @threads[i]
+    end
+  end
+
+  def wait_clients
+    ThreadsWait.all_waits(*@threads) # {|th| puts "end #{th.inspect}"}
+    @total_results[:end_time] = curr_time
+  end
+
+  def print_results
+    total_duration = @total_results[:end_time] - @total_results[:start_time]
+    results = []
+    @results.size.times do
+      results << @results.pop
+    end
+    duration = results.map {|r| r[:end_time] - r[:start_time]}
+    avg_duration = duration.inject(:+).to_f / duration.size
+    dev_duration = duration.map {|d| (d - avg_duration)**2}
+    stddev_duration = Math.sqrt(dev_duration.inject(:+).to_f) / dev_duration.size
+    puts "total duration:\t\t\t\t#{total_duration} ms"
+    puts "total throughput:\t\t\t#{@bench_opts[:num_msgs].to_f * @bench_opts[:num_clients] / total_duration} msgs/ms"
+    puts "average duration/client:\t\t#{avg_duration} ms"
+    puts "standard deviation of duration/client:\t#{stddev_duration} ms"
+  end
+end
+
+bench = MqttBench.new(ARGV[0])
+bench.start
+bench.wait_clients
+bench.print_results

data/conf/mqtt_bench.conf

@@ -0,0 +1,15 @@
+{
+  "mqtt_opts": {
+    "host": "127.0.0.1",
+    "port": 1883,
+    "keep_alive": 15
+  },
+  "bench_opts": {
+    "topic": "mqtt_bench",
+    "num_clients": 5,
+    "data_size": 128,
+    "num_msgs": 100,
+    "interval": 1,
+    "time_key": "time"
+  }
+}

data/ruby-mqtt-bench.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby-mqtt-bench"
+  spec.version       = "0.0.3"
+  spec.authors       = ["Toyokazu Akiyama"]
+  spec.email         = ["toyokazu@gmail.com"]
+
+  spec.summary       = %q{mqtt benchmark for ruby}
+  spec.description   = %q{mqtt benchmark for ruby}
+  spec.homepage      = "https://github.com/toyokazu/ruby-mqtt-bench"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.gsub(/images\/[\w\.]+\n/, "").split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mqtt", "~> 0.3"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: ruby-mqtt-bench
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Toyokazu Akiyama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mqtt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: mqtt benchmark for ruby
+email:
+- toyokazu@gmail.com
+executables:
+- mqtt_bench
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/mqtt_bench
+- conf/mqtt_bench.conf
+- ruby-mqtt-bench.gemspec
+homepage: https://github.com/toyokazu/ruby-mqtt-bench
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: mqtt benchmark for ruby
+test_files: []