drnbench 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 029ac85e0d002dfaf7636ea8031f29fd811deb42
-  data.tar.gz: dfa72f28ebe5c95ad0dfa38f3bedd124fcf4c108
+  metadata.gz: bc7f61f1275e4e48a15492d197552728429a7272
+  data.tar.gz: fa6bd343d6a874c165dd95ae77bdc1ca7df730b1
 SHA512:
-  metadata.gz: 0c2b179e22d3acb8d4e2c3592789bb5017da991eb17e053431ce5e4a12fd7cca4f7fe4a5ac8a77a5bd5bfbaabd1752147cb8edbf0ee8a34195ae6f49c729c318
-  data.tar.gz: 97008b59cc5eb84afc94fce74f62fd89ae9e31b6bbfa1afe463c6404f062304dd8f6339c3271d9722f673491e6206b8428b60e54c3bd0dc05271300ad93d59da
+  metadata.gz: 226d64e8c67139749313e265c3c6be5ac369b2c03f38dfc269dc2f9a105d682aad9830639e86ebef914306027fbf9ae64001773d4058983a14a307a101b352be
+  data.tar.gz: a97fea6987677e63f4f6511148cec0c30b98646042d5603c9dc61c10cf81325c117cea3ac5f82b794916ef69a6cc7309276fc90657cc7ce60f5b09d71f8b88ae

data/bin/drnbench-extract-searchterms

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+#
+# Copyright (C) 2014  Droonga Project
+#
+# This program 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.
+#
+# This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "drnbench"
+require "ostruct"
+require "optparse"
+require "json"
+
+options = OpenStruct.new
+options.column_index = 0
+
+option_parser = OptionParser.new do |parser|
+  parser.version = Drnbench::VERSION
+
+  parser.on("--column-index=INDEX", Integer,
+            "Index number of the column to be extracted.",
+            "(#{options.output_column_index})") do |index|
+    options.column_index = index
+  end
+end
+
+groonga_select_result_files = option_parser.parse!(ARGV)
+
+def output_column_value(select_result, column_index)
+  select_result = JSON.parse(select_result)
+  body = select_result[1]
+  search_result = body.first
+  records = search_result[2..-1]
+  records.each do |record|
+    puts record[column_index]
+  end
+end
+
+if groonga_select_result_files.empty?
+  output_column_value($stdin.read, options.column_index)
+else
+  groonga_select_result_files.each do |select_result_file|
+    File.open(select_result_file) do |input|
+      output_column_value(input.read, options.column_index)
+    end
+  end
+end

data/bin/drnbench-generate-select-patterns

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby
+#
+# Copyright (C) 2014  Droonga Project
+#
+# This program 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.
+#
+# This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "drnbench"
+require "ostruct"
+require "optparse"
+require "json"
+
+options = {
+  :base_params => "limit=10&offset=0",
+  :hosts       => [],
+}
+
+option_parser = OptionParser.new do |parser|
+  parser.version = Drnbench::VERSION
+
+  parser.on("--base-params=PARAMS",
+            "Base parameters for each select request",
+            "(#{options[:base_params]})") do |params|
+    options[:base_params] = params
+  end
+
+  parser.on("--hosts=NAME1,NAME2,...", Array,
+            "Target hosts to be requested parallely") do |hosts|
+    options[:hosts] = hosts
+  end
+end
+
+searchterms_files = option_parser.parse!(ARGV)
+
+def sanitize_for_param(value)
+  value.to_s
+       .gsub(/[:;]/, " ")
+       .strip
+       .gsub(/ +/, "%20")
+end
+
+def generate_patterns(params)
+  host        = params[:host]
+  frequency   = params[:frequency] || 1.0
+  searchterms = params[:searchterms] || []
+  base_params = params[:base_params] || ""
+
+  request_patterns = searchterms.collect do |searchterm|
+    query_params = "query=#{sanitize_for_param(searchterm)}"
+    unless base_params.empty?
+      query_params = "#{base_params}&#{query_params}"
+    end
+    {
+      "path" => "/d/select?#{query_params}",
+    }
+  end
+
+  pattern = {
+    "frequency" => frequency,
+    "method"    => "get",
+    "patterns"  => request_patterns,
+  }
+
+  if host
+    pattern["host"] = host 
+    { "with-query-#{host}" => pattern }
+  else
+    { "with-query" => pattern }
+  end
+end
+
+def output_patterns(params)
+  patterns = {}
+
+  hosts = params[:hosts] || []
+  if hosts.empty?
+    patterns.merge!(generate_patterns(params))
+  else
+    hosts.each do |host|
+      host_params = params.merge(:host => host,
+                                 :frequency => 1.0 / hosts.size)
+      host_patterns = generate_patterns(host_params)
+      patterns.merge!(host_patterns)
+    end
+  end
+
+  puts JSON.pretty_generate(patterns)
+end
+
+if searchterms_files.empty?
+  searchterms = $stdin.read.split(/\r?\n/)
+  output_patterns(options.merge(:searchterms => searchterms))
+else
+  searchterms_files.each do |searchterms_file|
+    File.open(searchterms_file) do |input|
+      searchterms = input.read.split(/\r?\n/)
+      output_patterns(options.merge(:searchterms => searchterms))
+    end
+  end
+end
+
+

data/bin/drnbench-publish-subscribe

@@ -22,6 +22,8 @@ require "shellwords"
 
 config = Drnbench::PublishSubscribe::Configuration.new
 option_parser = OptionParser.new do |parser|
+  parser.version = Drnbench::VERSION
+
   parser.on("--start-n-subscribers=N", Integer,
             "initial number of subscribers") do |n_subscribers|
     config.start_n_subscribers = n_subscribers

data/bin/drnbench-request-response

@@ -21,6 +21,8 @@ require "optparse"
 
 config = Drnbench::RequestResponse::Configuration.new
 option_parser = OptionParser.new do |parser|
+  parser.version = Drnbench::VERSION
+
   parser.on("--duration=SECONDS", Float,
             "duration of the benmark") do |duration|
     config.duration = duration
@@ -29,6 +31,10 @@ option_parser = OptionParser.new do |parser|
             "wait for each request") do |wait|
     config.wait = wait
   end
+  parser.on("--interval=SECONDS", Float,
+            "interval for each gradual case") do |interval|
+    config.interval = interval
+  end
   parser.on("--start-n-clients=N", Integer,
             "initial number of clients (optional)") do |n_clients|
     config.start_n_clients = n_clients
@@ -74,6 +80,10 @@ option_parser = OptionParser.new do |parser|
             "default HTTP method (optional)") do |method|
     config.default_method = method
   end
+  parser.on("--default-timeout=SECONDS", Float,
+            "default timeout (optional)") do |timeout|
+    config.default_timeout = timeout
+  end
 
   parser.on("--output-path=PATH",
             "path to output statistics as a CSV file (optional)") do |path|

data/doc/text/news.md

@@ -1,12 +1,23 @@
 # News
 
+## 1.0.2: 2014-07-30
+
+ * 'drnbench-request-response'
+   * Report aborted requests as slow requests.
+   * Report response status and index for slow requests.
+   * Add ability to specify default timeout via the `--default-timeout` option.
+   * Add ability to specify interval between each benchamrk via the `--interval` option.
+ * New utility command `drnbench-extract-searchterms` to extract values of a specific column from a result of Groonga's select command.
+ * New utility command `drnbench-generate-select-patterns` to generate patterns file for benchmark of Groonga's select command via HTTP.
+
 ## 1.0.1: 2014-07-29
 
- * Report throughput more correctly.
- * Report percentages of returned HTTP statuses correctly.
- * Report max elapsed time correctly.
- * Add ability to report slow requests.
- * Accept pattern group specific parameters.
+ * `drnbench-request-response`
+   * Report throughput more correctly.
+   * Report percentages of returned HTTP statuses correctly.
+   * Report max elapsed time correctly.
+   * Add ability to report slow requests via the `--n-slow-requests` option.
+   * Accept pattern group specific parameters.
 
 ## 1.0.0: 2014-01-29
 

data/lib/drnbench/client/http.rb

@@ -23,10 +23,15 @@ module Drnbench
 
     SUPPORTED_HTTP_METHODS = ["GET", "POST"]
 
+    @@count = 0
+
     def initialize(params, config)
       @requests = params[:requests]
       @result   = params[:result]
       @config   = config
+      @count    = 0
+      @id       = @@count
+      @@count += 1
     end
 
     def run
@@ -37,16 +42,34 @@ module Drnbench
 
           client = Droonga::Client.new(:protocol => :http,
                                        :host => request["host"],
-                                       :port => request["port"])
+                                       :port => request["port"],
+                                       :timeout => request["timeout"])
           request["headers"] ||= {}
           request["headers"]["user-agent"] = "Ruby/#{RUBY_VERSION} Droonga::Benchmark::Runner::HttpClient"
           start_time = Time.now
+          @last_request = request
+          @last_start_time = start_time
+          begin
           response = client.request(request)
-          @result << {
-            :request => request,
-            :status => response.code,
-            :elapsed_time => Time.now - start_time,
-          }
+            @result << {
+              :request => request,
+              :status => response.code,
+              :elapsed_time => Time.now - start_time,
+              :client => @id,
+              :index => @count,
+            }
+          rescue Timeout::Error
+            @result << {
+              :request => request,
+              :status => "0",
+              :elapsed_time => Time.now - start_time,
+              :client => @id,
+              :index => @count,
+            }
+          end
+          @last_request = nil
+          @last_start_time = nil
+          @count += 1
           sleep @config.wait
         end
       end
@@ -55,6 +78,17 @@ module Drnbench
 
     def stop
       @thread.exit
+
+      if @last_request
+        @result << {
+          :request => @last_request,
+          :status => "0",
+          :elapsed_time => Time.now - @last_start_time,
+          :client => @id,
+          :index => @count,
+          :last => true,
+        }
+      end
     end
 
     private
@@ -67,6 +101,7 @@ module Drnbench
       unless SUPPORTED_HTTP_METHODS.include?(request["method"])
         request["method"] = "GET"
       end
+      request["timeout"] ||= @config.default_timeout
       request
     end
   end

data/lib/drnbench/request-response/configuration.rb

@@ -18,10 +18,10 @@ require "json"
 module Drnbench
   module RequestResponse
     class Configuration
-      attr_accessor :duration, :wait, :request_patterns_file
+      attr_accessor :duration, :wait, :interval, :request_patterns_file
       attr_accessor :start_n_clients, :end_n_clients, :step, :n_requests, :n_slow_requests
       attr_accessor :mode
-      attr_accessor :default_host, :default_port, :default_path, :default_method
+      attr_accessor :default_host, :default_port, :default_path, :default_method, :default_timeout
       attr_accessor :report_progressively, :output_path
 
       MIN_DURATION = 1
@@ -29,6 +29,7 @@ module Drnbench
 
       def initialize
         @wait                 = 1
+        @interval             = 5
         @start_n_clients      = 1
         @end_n_clients        = 1
         @step                 = 1
@@ -40,6 +41,7 @@ module Drnbench
         @default_port         = 80
         @default_path         = "/"
         @default_method       = "GET"
+        @default_timeout      = 5.0
 
         @report_progressively = true
         @output_path          = "/tmp/drnbench-result.csv"

data/lib/drnbench/request-response/gradual-runner.rb

@@ -34,6 +34,8 @@ module Drnbench
       def run_benchmarks
         @result = Result.new
         @config.start_n_clients.step(@config.end_n_clients, @config.step) do |n_clients|
+          sleep @config.interval unless @result.empty?
+
           benchmark = Runner.new(n_clients, @config)
           if @config.report_progressively
             puts "Running benchmark with #{n_clients} clients..."
@@ -57,6 +59,10 @@ module Drnbench
           @results[result.n_clients] = result
         end
 
+        def empty?
+          @results.empty?
+        end
+
         def statuses
           @statuses ||= prepare_statuses
         end

data/lib/drnbench/request-response/result.rb

@@ -55,6 +55,10 @@ module Drnbench
         @total_elapsed_time += result[:elapsed_time]
       end
 
+      def empty?
+        @results.empty?
+      end
+
       def total_n_requests
         @total_n_requests ||= @results.size
       end
@@ -82,8 +86,19 @@ module Drnbench
       def top_slow_requests
         slow_requests[0..@n_slow_requests-1].collect do |result|
           request = result[:request]
-          "#{result[:elapsed_time]} sec: " +
-            "#{request["method"]} http://#{request["host"]}:#{request["port"]}#{request["path"]}"
+          status = result[:status].to_i
+          if status.zero?
+            status = "#{status}(aborted)"
+          end
+          index = result[:index]
+          index = "#{index}(last)" if result[:last]
+          [
+            "#{result[:elapsed_time]} sec:",
+            request["method"],
+            status,
+            "<#{result[:client]}>#{index}",
+            "http://#{request["host"]}:#{request["port"]}#{request["path"]}",
+          ].join(" ")
         end
       end
 
@@ -105,6 +120,7 @@ module Drnbench
         "  max:     #{max_elapsed_time} sec\n" +
         "  average: #{average_elapsed_time} sec\n" +
         "Top #{@n_slow_requests} slow requests:\n" +
+        " [time: method status <client>index url]\n" +
         top_slow_requests.collect do |request|
           "  #{request}"
         end.join("\n")

data/lib/drnbench/request-response/runner.rb

@@ -113,6 +113,7 @@ module Drnbench
           pattern["host"] ||= request_pattern["host"]
           pattern["port"] ||= request_pattern["port"]
           pattern["method"] ||= request_pattern["method"]
+          pattern["timeout"] ||= request_pattern["timeout"]
           @requests << pattern
         end
       end

data/lib/drnbench/version.rb

@@ -14,5 +14,5 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 module Drnbench
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: drnbench
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - YUKI Hiroshi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-29 00:00:00.000000000 Z
+date: 2014-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -114,6 +114,8 @@ email:
 - yuki@clear-code.com
 - kou@clear-code.com
 executables:
+- drnbench-extract-searchterms
+- drnbench-generate-select-patterns
 - drnbench-request-response
 - drnbench-publish-subscribe
 extensions: []
@@ -142,6 +144,8 @@ files:
 - lib/drnbench/server/engine.rb
 - lib/drnbench/server/configuration.rb
 - lib/drnbench.rb
+- bin/drnbench-extract-searchterms
+- bin/drnbench-generate-select-patterns
 - bin/drnbench-request-response
 - bin/drnbench-publish-subscribe
 homepage: https://github.com/groonga/grntest