pbenchmark 1.0.0

data/README.md

@@ -0,0 +1,48 @@
+# pbenchmark
+
+  A simple tool to benchmark Pusher.com compatible servers.
+  
+  [![Dependency Status][2]][1]
+  
+  [1]: https://gemnasium.com/tech-angels/pb
+  [2]: https://gemnasium.com/tech-angels/pb.png
+
+## Getting started
+
+Install the pbenchmark gem:
+
+    gem install pbenchmark
+
+Run it against your server, for example a Slanger daemon:
+
+    pbenchmark -c 10 -n 5 -i 43 -k bcff8137f9c04db491199d4578a37286 -s 68f5400d1aaa4d1bbaaf70bb0b866cb7 -a 127.0.0.1:80 -w 127.0.0.1:8080
+
+Messages are sent via the API, and the time it took them to reach the websocket clients is printed.
+
+## Commmand line parameters
+
+<pre>
+-c Number of websocket clients.
+
+-n Number of messages to send via the API.
+
+-i Application ID.
+
+-k Application key.
+
+-s Application secret.
+
+-a API host and port. Example: 127.0.0.1:80.
+
+-w Websocket server host and port. Example: 127.0.0.1:8080
+
+--size Payload size in bytes.
+</pre>
+
+## Credits
+
+  Gilbert Roulot @ Tech-angels - http://www.tech-angels.com/
+  
+  [![Tech-Angels](http://media.tumblr.com/tumblr_m5ay3bQiER1qa44ov.png)](http://www.tech-angels.com)
+
+

data/bin/pbenchmark

@@ -0,0 +1,182 @@
+#!/usr/bin/env ruby
+
+#    Copyright (c)2012 Tech-Angels
+# 
+#    This file is part of PBenchmark.
+#
+#    PBenchmark is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    PBenchmark is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with PBenchmark.  If not, see <http://www.gnu.org/licenses/>. 2
+
+
+
+require 'bundler'
+require 'active_support/json'
+require 'eventmachine'
+require 'em-websocket-client'
+require 'pusher'
+require 'optparse'
+
+module PBenchmark
+  @all_latencies = []
+  def get_latencies
+    @all_latencies
+  end
+
+  @options = {
+    api_host: '127.0.0.1', 
+    api_port: '4567', 
+    websocket_host: '127.0.0.1',
+    websocket_port: '8080', debug: false,
+    nb_clients: 1,
+    nb_messages: 10,
+    payload_size: 100,
+  }
+  @opts_app_id = nil
+  @opts_app_key = nil
+  @opts_secret = nil
+
+  OptionParser.new do |opts|
+    opts.on '-c', '--concurrency NUMBER', 'Number of clients' do |k|
+      @options[:nb_clients] = k.to_i
+    end
+
+    opts.on '-n', '--messages NUMBER', 'Number of messages' do |k|
+      @options[:nb_messages] = k.to_i
+    end
+
+    opts.on '-i', '--app_id APP_ID', "Pusher application id" do |k|
+      @opts_app_id = k
+    end
+
+    opts.on '-k', '--app_key APP_KEY', "Pusher application key" do |k|
+      @opts_app_key = k
+    end
+
+    opts.on '-s', '--secret SECRET', "Pusher application secret" do |k|
+      @opts_secret = k
+    end
+
+    opts.on '-a', '--api_host HOST', "API service address (Default: 0.0.0.0:4567)" do |p|
+      @options[:api_host], @options[:api_port] = p.split(':')
+    end
+
+    opts.on '-w', '--websocket_host HOST', "WebSocket service address (Default: 0.0.0.0:8080)" do |p|
+      @options[:websocket_host], @options[:websocket_port] = p.split(':')
+    end
+
+    opts.on '--size NUMBER', 'Payload size in bytes. (Default: 100)' do |s|
+      @options[:payload_size] = s.to_i
+    end
+  end.parse!
+
+  def new_websocket
+    EM::WebSocketClient.connect("ws://" + @options[:websocket_host] + ":" + @options[:websocket_port] + "/app/" + @opts_app_key + "?client=js&version=1.8.5")
+  end
+  
+  def configure_pusher
+    Pusher.tap do |p|
+      p.host   = @options[:api_host]
+      p.port   = @options[:api_port].to_i
+      p.app_id = @opts_app_id
+      p.secret = @opts_secret
+      p.key    = @opts_app_key
+    end
+  end 
+
+  def get_stats(latencies)
+    lowest = latencies.min * 1000
+    highest = latencies.max * 1000
+    total = latencies.inject(:+) * 1000
+    len = latencies.length
+    average = total.to_f / len
+    sorted = latencies.sort
+    median = (len % 2 == 1 ? sorted[len/2] : (sorted[len / 2 - 1] + sorted[len / 2]).to_f / 2) * 1000
+    return {
+      min: lowest,
+      mean: average,
+      median: median,
+      max: highest
+    }
+  end
+
+  def regular_channel
+    configure_pusher
+    latencies  = []
+    client_who_received = 0
+    messages_to_send = @options[:nb_messages].to_i
+    puts "Latency (ms)"
+    puts "min\tmean\tmedian\tmax"
+ 
+    EM.run do
+      # Connect clients
+      (1..@options[:nb_clients]).each do
+        websocket = new_websocket
+
+        websocket.errback { |e|
+          puts "Websocket error: " + e.to_s
+          EM.stop
+        }
+
+        websocket.stream do |message|
+          now = Time.now.to_f
+          message = JSON.parse(message)
+          data = message['data']
+          data = JSON.parse(data) unless data.is_a?(Hash)
+          if data.has_key?('time')
+            latency = now - data['time']
+            latencies << latency
+            client_who_received += 1
+          end
+          if client_who_received >= @options[:nb_clients] then
+            # Display statistics
+            stats = get_stats(latencies)
+            puts "%.2f\t%.2f\t%.2f\t%.2f" % [stats[:min], stats[:mean], stats[:median], stats[:max]] 
+            @all_latencies += latencies
+          end
+        end
+
+        websocket.callback do
+          websocket.send_msg({ event: 'pusher:subscribe', data: { channel: 'MY_CHANNEL'} }.to_json)
+        end
+
+      end
+      # Send messages to the channel
+      EM::PeriodicTimer.new(1) do 
+        if messages_to_send > 0
+          client_who_received = 0
+          latencies  = []
+          Pusher['MY_CHANNEL'].trigger_async 'an_event', { time: Time.now.to_f, payload: " " * @options[:payload_size] }
+          messages_to_send -= 1
+        else
+          EM.stop
+        end
+      end
+    end
+  end
+
+  extend self
+end
+
+begin
+  PBenchmark.regular_channel
+rescue SystemExit, Interrupt
+end
+
+# Print final stats
+stats = PBenchmark.get_stats(PBenchmark.get_latencies)
+puts "\n\nOverall latencies (ms)"
+puts "min\tmean\tmedian\tmax"
+puts "%.2f\t%.2f\t%.2f\t%.2f" % [stats[:min], stats[:mean], stats[:median], stats[:max]] 
+ 
+
+

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: pbenchmark
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Gilbert Roulot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &6043060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *6043060
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: &6040680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *6040680
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: &5286240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *5286240
+- !ruby/object:Gem::Dependency
+  name: em-websocket-client
+  requirement: &5284560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *5284560
+- !ruby/object:Gem::Dependency
+  name: pusher
+  requirement: &5283720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *5283720
+description: A benchmarking tool for servers compatible with the Pusher protocol.
+email: gilbert.roulot@tech-angels.com
+executables:
+- pbenchmark
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/pbenchmark
+homepage: https://github.com/tech-angels/pbenchmark
+licenses:
+- GPL-3
+post_install_message: 
+rdoc_options: []
+require_paths:
+- .
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A benchmarking tool for servers compatible with the Pusher protocol.
+test_files: []