groonga-query-log 1.2.8 → 1.2.9

data/lib/{groonga/query-log → groonga-query-log}/replayer.rb

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2013  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2013-2017  Kouhei Sutou <kou@clear-code.com>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -21,10 +19,9 @@ require "thread"
 
 require "groonga/client"
 
-require "groonga/query-log/parser"
+require "groonga-query-log/parser"
 
-module Groonga
-  module QueryLog
+module GroongaQueryLog
     class Replayer
       def initialize(options)
         @options = options
@@ -147,11 +144,14 @@ module Groonga
         attr_accessor :protocol
         attr_accessor :n_clients
         attr_writer :request_queue_size
+        attr_writer :disable_cache
         attr_accessor :target_command_names
+        attr_accessor :requests_path
+        attr_accessor :responses_path
         def initialize
           @host = "127.0.0.1"
           @port = 10041
-          @protocol = :gqtp
+          @protocol = :http
           @n_clients = 8
           @request_queue_size = nil
           @disable_cache = false
@@ -201,5 +201,4 @@ module Groonga
         end
       end
     end
-  end
 end

data/lib/{groonga/query-log → groonga-query-log}/response-comparer.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2015  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2014-2017  Kouhei Sutou <kou@clear-code.com>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -14,8 +14,7 @@
 # License along with this library; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
-module Groonga
-  module QueryLog
+module GroongaQueryLog
     class ResponseComparer
       def initialize(command, response1, response2, options={})
         @command = command
@@ -46,7 +45,7 @@ module Groonga
 
       private
       def error_response?(response)
-        response.is_a?(Client::Response::Error)
+        response.is_a?(Groonga::Client::Response::Error)
       end
 
       def same_error_response?
@@ -211,5 +210,4 @@ module Groonga
         map
       end
     end
-  end
 end

data/lib/{groonga/query-log → groonga-query-log}/server-verifier.rb

@@ -19,11 +19,10 @@ require "thread"
 
 require "groonga/client"
 
-require "groonga/query-log/parser"
-require "groonga/query-log/response-comparer"
+require "groonga-query-log/parser"
+require "groonga-query-log/response-comparer"
 
-module Groonga
-  module QueryLog
+module GroongaQueryLog
     class ServerVerifier
       def initialize(options)
         @options = options
@@ -246,5 +245,4 @@ module Groonga
         end
       end
     end
-  end
 end

data/lib/groonga-query-log/statistic.rb

@@ -0,0 +1,192 @@
+# Copyright (C) 2011-2017  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library 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
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "groonga/command/parser"
+
+module GroongaQueryLog
+  class Statistic
+    DEFAULT_SLOW_OPERATION_THRESHOLD = 0.1
+    DEFAULT_SLOW_RESPONSE_THRESHOLD = 0.2
+
+    attr_reader :context_id, :start_time, :raw_command
+    attr_reader :elapsed, :return_code
+    attr_accessor :slow_operation_threshold, :slow_response_threshold
+    def initialize(context_id)
+      @context_id = context_id
+      @start_time = nil
+      @command = nil
+      @select_command = nil
+      @raw_command = nil
+      @operations = []
+      @elapsed = nil
+      @return_code = 0
+      @slow_operation_threshold = DEFAULT_SLOW_OPERATION_THRESHOLD
+      @slow_response_threshold = DEFAULT_SLOW_RESPONSE_THRESHOLD
+    end
+
+    def start(start_time, command)
+      @start_time = start_time
+      @raw_command = command
+    end
+
+    def finish(elapsed, return_code)
+      @elapsed = elapsed
+      @return_code = return_code
+    end
+
+    def command
+      Groonga::Command::Parser.parse(@raw_command) do |status, command|
+        case status
+        when :on_load_start
+          @loading = false
+          @command ||= command
+        when :on_command
+          @command ||= command
+        end
+      end
+      @command
+    end
+
+    def elapsed_in_seconds
+      nano_seconds_to_seconds(@elapsed)
+    end
+
+    def last_time
+      @start_time + elapsed_in_seconds
+    end
+
+    def slow?
+      elapsed_in_seconds >= @slow_response_threshold
+    end
+
+    def each_operation
+      return to_enum(__method__) unless block_given?
+
+      previous_elapsed = 0
+      ensure_parse_command
+      operation_context_context = {
+        :filter_index => 0,
+        :drilldown_index => 0,
+      }
+      @operations.each_with_index do |operation, i|
+        relative_elapsed = operation[:elapsed] - previous_elapsed
+        relative_elapsed_in_seconds = nano_seconds_to_seconds(relative_elapsed)
+        previous_elapsed = operation[:elapsed]
+        parsed_operation = {
+          :i => i,
+          :elapsed => operation[:elapsed],
+          :elapsed_in_seconds => nano_seconds_to_seconds(operation[:elapsed]),
+          :relative_elapsed => relative_elapsed,
+          :relative_elapsed_in_seconds => relative_elapsed_in_seconds,
+          :name => operation[:name],
+          :context => operation_context(operation[:name],
+                                        operation_context_context),
+          :n_records => operation[:n_records],
+          :extra => operation[:extra],
+          :slow? => slow_operation?(relative_elapsed_in_seconds),
+        }
+        yield parsed_operation
+      end
+    end
+
+    def add_operation(operation)
+      @operations << operation
+    end
+
+    def operations
+      _operations = []
+      each_operation do |operation|
+        _operations << operation
+      end
+      _operations
+    end
+
+    def select_command?
+      command.name == "select"
+    end
+
+    def to_hash
+      data = {
+        "start_time" => start_time.to_f,
+        "last_time" => last_time.to_f,
+        "elapsed" => elapsed_in_seconds,
+        "return_code" => return_code,
+        "slow" => slow?,
+      }
+      arguments = command.arguments.collect do |key, value|
+        {"key" => key, "value" => value}
+      end
+      data["command"] = {
+        "raw" => raw_command,
+        "name" => command.name,
+        "parameters" => arguments,
+      }
+      operations = []
+      each_operation do |operation|
+        operation_data = {}
+        operation_data["name"] = operation[:name]
+        operation_data["relative_elapsed"] = operation[:relative_elapsed_in_seconds]
+        operation_data["context"] = operation[:context]
+        operation_data["slow"] = operation[:slow?]
+        operations << operation_data
+      end
+      data["operations"] = operations
+      data
+    end
+
+    private
+    def nano_seconds_to_seconds(nano_seconds)
+      nano_seconds / 1000.0 / 1000.0 / 1000.0
+    end
+
+    def operation_context(label, context)
+      return nil if @select_command.nil?
+
+      case label
+      when "filter"
+        if @select_command.query and context[:query_used].nil?
+          context[:query_used] = true
+          "query: #{@select_command.query}"
+        else
+          index = context[:filter_index]
+          context[:filter_index] += 1
+          @select_command.conditions[index]
+        end
+      when "sort"
+        @select_command.sortby
+      when "score"
+        @select_command.scorer
+      when "output"
+        @select_command.output_columns
+      when "drilldown"
+        index = context[:drilldown_index]
+        context[:drilldown_index] += 1
+        @select_command.drilldowns[index]
+      else
+        nil
+      end
+    end
+
+    def ensure_parse_command
+      return unless select_command?
+      @select_command = Groonga::Command::Parser.parse(@raw_command)
+    end
+
+    def slow_operation?(elapsed)
+      elapsed >= @slow_operation_threshold
+    end
+  end
+end

data/lib/{groonga/query-log → groonga-query-log}/version.rb

@@ -14,8 +14,6 @@
 # License along with this library; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
-module Groonga
-  module QueryLog
-    VERSION = "1.2.8"
-  end
+module GroongaQueryLog
+    VERSION = "1.2.9"
 end

data/lib/groonga/query-log.rb

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2012  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2017  Kouhei Sutou <kou@clear-code.com>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -16,9 +14,23 @@
 # License along with this library; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
-require "groonga/query-log/version"
-require "groonga/query-log/analyzer"
-require "groonga/query-log/parser"
-require "groonga/query-log/replayer"
-require "groonga/query-log/server-verifier"
-require "groonga/query-log/command-version-compatibility-checker"
+require "groonga-query-log"
+
+module GroongaQueryLog
+  module NamespaceBackwardCompatibility
+    def const_missing(name)
+      case name
+      when :QueryLog
+        warn("Groonga::QueryLog is deprecated. Use GroongaQueryLog instead:\n" +
+             caller.join("\n"))
+        const_set(name, GroongaQueryLog)
+      else
+        super
+      end
+    end
+  end
+end
+
+module Groonga
+  extend GroongaQueryLog::NamespaceBackwardCompatibility
+end

data/lib/groonga/query-log/command/analyzer.rb

@@ -0,0 +1,18 @@
+# Copyright (C) 2017  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library 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
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "groonga/query-log"
+require "groonga-query-log/command/analyzer"

data/lib/groonga/query-log/command/check-command-version-compatibility.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2017  Kouhei Sutou <kou@clear-code.com>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -14,58 +14,5 @@
 # License along with this library; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
-require "optparse"
-
 require "groonga/query-log"
-
-module Groonga
-  module QueryLog
-    module Command
-      class CheckCommandVersionCompatibility
-        def initialize
-          @options = CommandVersionCompatibilityChecker::Options.new
-        end
-
-        def run(command_line)
-          input_paths = create_parser.parse(command_line)
-          checker = CommandVersionCompatibilityChecker.new(@options)
-          checker.start do
-            compatible = true
-            if input_paths.empty?
-              compatible = false unless checker.check($stdin)
-            else
-              input_paths.each do |input_path|
-                File.open(input_path) do |input|
-                  compatible = false unless checker.check(input)
-                end
-              end
-            end
-            compatible
-          end
-        end
-
-        private
-        def create_parser
-          parser = OptionParser.new
-          parser.version = VERSION
-          parser.banner += " QUERY_LOG1 QUERY_LOG2 ..."
-
-          parser.separator("")
-          parser.separator("Options:")
-
-          parser.on("--target-version=VERSION", Integer,
-                    "Check incompatibility against command version VERSION",
-                    "[#{@options.target_version}]") do |version|
-            @options.target_version = version
-          end
-
-          parser.on("--output=PATH",
-                    "Output results to PATH",
-                    "[stdout]") do |path|
-            @options.output_path = path
-          end
-        end
-      end
-    end
-  end
-end
+require "groonga-query-log/command/check-command-version-compatibility"

data/lib/groonga/query-log/command/detect-memory-leak.rb

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2013-2014  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2017  Kouhei Sutou <kou@clear-code.com>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -16,78 +14,5 @@
 # License along with this library; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
-require "optparse"
-
-require "groonga/query-log/version"
-require "groonga/query-log/memory-leak-detector"
-
-module Groonga
-  module QueryLog
-    module Command
-      class DetectMemoryLeak
-        def initialize
-          @options = MemoryLeakDetector::Options.new
-        end
-
-        def run(command_line)
-          input_paths = create_parser.parse(command_line)
-          detector = MemoryLeakDetector.new(@options)
-          input_paths.each do |input_path|
-            File.open(input_path) do |input|
-              detector.detect(input)
-            end
-          end
-          true
-        end
-
-        private
-        def create_parser
-          parser = OptionParser.new
-          parser.version = VERSION
-          parser.banner += " QUERY_LOG"
-
-          parser.separator("")
-          parser.separator("Options:")
-
-          parser.on("--host=HOST",
-                    "Host name or IP address of groonga server",
-                    "[#{@options.host}]") do |host|
-            @options.host = host
-          end
-
-          parser.on("--port=PORT", Integer,
-                    "Port number of groonga server",
-                    "[#{@options.port}]") do |port|
-            @options.port = port
-          end
-
-          available_protocols = [:gqtp, :http]
-          available_protocols_label = "[#{available_protocols.join(', ')}]"
-          parser.on("--protocol=PROTOCOL", available_protocols,
-                    "Protocol of groonga server",
-                    available_protocols_label) do |protocol|
-            @options.protocol = protocol
-          end
-
-          parser.on("--pid=PID",
-                    "The PID of groonga server",
-                    "[#{@options.pid}]") do |pid|
-            @options.pid = pid
-          end
-
-          parser.on("--n-tries=N", Integer,
-                    "The number of the same request tries",
-                    "[#{@options.n_tries}]") do |n|
-            @options.n_tries = n
-          end
-
-          parser.on("--[no-]force-disable-cache",
-                    "Force disable cache of select command by cache=no parameter",
-                    "[#{@options.force_disable_cache?}]") do |boolean|
-            @options.force_disable_cache = boolean
-          end
-        end
-      end
-    end
-  end
-end
+require "groonga/query-log"
+require "groonga-query-log/command/detect-memory-leak"