RubyGems - groonga-query-log - Versions diffs - 1.0.0 - Mend

groonga-query-log 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (36) hide show

data/.yardopts +5 -0
data/Gemfile +21 -0
data/README.md +49 -0
data/Rakefile +51 -0
data/bin/groonga-query-log-analyzer +28 -0
data/doc/text/lgpl-2.1.txt +502 -0
data/doc/text/news.md +5 -0
data/groonga-query-log.gemspec +65 -0
data/lib/groonga/query-log.rb +21 -0
data/lib/groonga/query-log/analyzer.rb +212 -0
data/lib/groonga/query-log/analyzer/reporter.rb +101 -0
data/lib/groonga/query-log/analyzer/reporter/console.rb +291 -0
data/lib/groonga/query-log/analyzer/reporter/html.rb +325 -0
data/lib/groonga/query-log/analyzer/reporter/json.rb +78 -0
data/lib/groonga/query-log/analyzer/sized-grouped-operations.rb +84 -0
data/lib/groonga/query-log/analyzer/sized-statistics.rb +172 -0
data/lib/groonga/query-log/analyzer/statistic.rb +160 -0
data/lib/groonga/query-log/analyzer/streamer.rb +42 -0
data/lib/groonga/query-log/parser.rb +77 -0
data/lib/groonga/query-log/version.rb +23 -0
data/test/command/test-select.rb +162 -0
data/test/fixtures/n_entries.expected +19 -0
data/test/fixtures/no-report-summary.expected +15 -0
data/test/fixtures/order/-elapsed.expected +28 -0
data/test/fixtures/order/-start-time.expected +28 -0
data/test/fixtures/order/elapsed.expected +28 -0
data/test/fixtures/order/start-time.expected +28 -0
data/test/fixtures/query.log +7 -0
data/test/fixtures/reporter/console.expected +28 -0
data/test/fixtures/reporter/html.expected +196 -0
data/test/fixtures/reporter/json.expected +4 -0
data/test/groonga-query-log-test-utils.rb +79 -0
data/test/run-test.rb +43 -0
data/test/test-analyzer.rb +82 -0
data/test/test-parser.rb +90 -0
metadata +235 -0

data/lib/groonga/query-log/analyzer/reporter/html.rb ADDED Viewed

@@ -0,0 +1,325 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2011-2012  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2012  Haruka Yoshihara <yoshihara@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 "erb"
+require "groonga/query-log/analyzer/reporter"
+module Groonga
+  module QueryLog
+    class Analyzer
+      class HTMLReporter < Reporter
+        include ERB::Util
+        def start
+          write(header)
+        end
+        def finish
+          write(footer)
+        end
+        def report_summary
+          summary_html = erb(<<-EOH, __LINE__ + 1, binding)
+    <h2>Summary</h2>
+    <div class="summary">
+<%= analyze_parameters %>
+<%= metrics %>
+<%= slow_operations %>
+    </div>
+          EOH
+          write(summary_html)
+        end
+        def report_statistics
+          write(statistics_header)
+          super
+          write(statistics_footer)
+        end
+        def report_statistic(statistic)
+          command = statistic.command
+          statistic_html = erb(<<-EOH, __LINE__ + 1, binding)
+      <div class="statistic-heading">
+        <h3>Command</h3>
+        <div class="metrics">
+          [<%= format_time(statistic.start_time) %>
+           -
+           <%= format_time(statistic.last_time) %>
+           (<%= format_elapsed(statistic.elapsed_in_seconds,
+                               :slow? => statistic.slow?) %>)]
+          (<%= span({:class => "return-code"}, h(statistic.return_code)) %>)
+        </div>
+        <%= div({:class => "raw-command"}, h(statistic.raw_command)) %>
+      </div>
+      <div class="statistic-parameters">
+        <h3>Parameters</h3>
+        <dl>
+          <dt>name</dt>
+          <dd><%= h(command.name) %></dd>
+<% command.arguments.each do |key, value| %>
+          <dt><%= h(key) %></dt>
+          <dd><%= h(value) %></dd>
+<% end %>
+         </dl>
+      </div>
+      <div class="statistic-operations">
+        <h3>Operations</h3>
+        <ol>
+<% statistic.each_operation do |operation| %>
+          <li>
+            <%= format_elapsed(operation[:relative_elapsed_in_seconds],
+                               :slow? => operation[:slow?]) %>:
+            <%= span({:class => "name"}, h(operation[:name])) %>:
+            <%= span({:class => "context"}, h(operation[:context])) %>
+          </li>
+<% end %>
+        </ol>
+      </div>
+          EOH
+          write(statistic_html)
+        end
+        private
+        def erb(content, line, _binding=nil)
+          _erb = ERB.new(content, nil, "<>")
+          eval(_erb.src, _binding || binding, __FILE__, line)
+        end
+        def header
+          erb(<<-EOH, __LINE__ + 1)
+<html>
+  <head>
+    <title>groonga query analyzer</title>
+    <style>
+table,
+table tr,
+table tr th,
+table tr td
+{
+  border: 1px solid black;
+}
+span.slow
+{
+  color: red;
+}
+div.parameters
+{
+  float: left;
+  padding: 2em;
+}
+div.parameters h3
+{
+  text-align: center;
+}
+div.parameters table
+{
+  margin-right: auto;
+  margin-left: auto;
+}
+div.statistics
+{
+  clear: both;
+}
+td.elapsed,
+td.ratio,
+td.n
+{
+  text-align: right;
+}
+td.name
+{
+  text-align: center;
+}
+    </style>
+  </head>
+  <body>
+    <h1>groonga query analyzer</h1>
+      EOH
+        end
+    def footer
+      erb(<<-EOH, __LINE__ + 1)
+  </body>
+</html>
+          EOH
+    end
+        def statistics_header
+          erb(<<-EOH, __LINE__ + 1)
+    <h2>Slow Queries</h2>
+    <div>
+          EOH
+        end
+        def statistics_footer
+          erb(<<-EOH, __LINE__ + 1)
+    </div>
+          EOH
+        end
+        def analyze_parameters
+          erb(<<-EOH, __LINE__ + 1)
+      <div class="parameters">
+        <h3>Analyze Parameters</h3>
+        <table>
+          <tr><th>Name</th><th>Value</th></tr>
+          <tr>
+            <th>Slow response threshold</th>
+            <td><%= h(@statistics.slow_response_threshold) %>sec</td>
+          </tr>
+          <tr>
+            <th>Slow operation threshold</th>
+            <td><%= h(@statistics.slow_operation_threshold) %>sec</td>
+          </tr>
+        </table>
+      </div>
+          EOH
+        end
+        def metrics
+          erb(<<-EOH, __LINE__ + 1)
+      <div class="parameters">
+        <h3>Metrics</h3>
+        <table>
+          <tr><th>Name</th><th>Value</th></tr>
+          <tr>
+            <th># of responses</th>
+            <td><%= h(@statistics.n_responses) %></td>
+          </tr>
+          <tr>
+            <th># of slow responses</th>
+            <td><%= h(@statistics.n_slow_responses) %></td>
+          </tr>
+          <tr>
+            <th>responses/sec</th>
+            <td><%= h(@statistics.responses_per_second) %></td>
+          </tr>
+          <tr>
+            <th>start time</th>
+            <td><%= format_time(@statistics.start_time) %></td>
+          </tr>
+          <tr>
+            <th>last time</th>
+            <td><%= format_time(@statistics.last_time) %></td>
+          </tr>
+          <tr>
+            <th>period</th>
+            <td><%= h(@statistics.period) %>sec</td>
+          </tr>
+          <tr>
+            <th>slow response ratio</th>
+            <td><%= h(@statistics.slow_response_ratio) %>%</td>
+          </tr>
+          <tr>
+            <th>total response time</th>
+            <td><%= h(@statistics.total_elapsed) %>sec</td>
+          </tr>
+        </table>
+      </div>
+          EOH
+        end
+        def slow_operations
+          erb(<<-EOH, __LINE__ + 1)
+      <div class="statistics">
+        <h3>Slow Operations</h3>
+        <table class="slow-operations">
+          <tr>
+            <th>total elapsed(sec)</th>
+            <th>total elapsed(%)</th>
+            <th># of operations</th>
+            <th># of operations(%)</th>
+            <th>operation name</th>
+            <th>context</th>
+          </tr>
+<% @statistics.each_slow_operation do |grouped_operation| %>
+          <tr>
+            <td class="elapsed">
+              <%= format_elapsed(grouped_operation[:total_elapsed]) %>
+            </td>
+            <td class="ratio">
+              <%= format_ratio(grouped_operation[:total_elapsed_ratio]) %>
+            </td>
+            <td class="n">
+              <%= h(grouped_operation[:n_operations]) %>
+            </td>
+            <td class="ratio">
+              <%= format_ratio(grouped_operation[:n_operations_ratio]) %>
+            </td>
+            <td class="name"><%= h(grouped_operation[:name]) %></td>
+            <td class="context">
+              <%= format_context(grouped_operation[:context]) %>
+            </td>
+          </tr>
+<% end %>
+        </table>
+      </div>
+          EOH
+        end
+        def format_time(time)
+          span({:class => "time"}, h(super))
+        end
+        def format_elapsed(elapsed, options={})
+          formatted_elapsed = span({:class => "elapsed"}, h("%8.8f" % elapsed))
+          if options[:slow?]
+            formatted_elapsed = span({:class => "slow"}, formatted_elapsed)
+          end
+          formatted_elapsed
+        end
+        def format_ratio(ratio)
+          h("%5.2f%%" % ratio)
+        end
+        def format_context(context)
+          h(context).gsub(/,/, ",<wbr />")
+        end
+        def tag(name, attributes, content)
+          html = "<#{name}"
+          html_attributes = attributes.collect do |key, value|
+            "#{h(key)}=\"#{h(value)}\""
+          end
+          html << " #{html_attributes.join(' ')}" unless attributes.empty?
+          html << ">"
+          html << content
+          html << "</#{name}>"
+          html
+        end
+        def span(attributes, content)
+          tag("span", attributes, content)
+        end
+        def div(attributes, content)
+          tag("div", attributes, content)
+        end
+      end
+    end
+  end
+end

data/lib/groonga/query-log/analyzer/reporter/json.rb ADDED Viewed

@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2011-2012  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2012  Haruka Yoshihara <yoshihara@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/analyzer/reporter"
+module Groonga
+  module QueryLog
+    class Analyzer
+      class JSONReporter < Reporter
+        def report_statistic(statistic)
+          write(",") if @index > 0
+          write("\n")
+          write(format_statistic(statistic))
+          @index += 1
+        end
+        def start
+          @index = 0
+          write("[")
+        end
+        def finish
+          write("\n")
+          write("]\n")
+        end
+        def report_summary
+          # TODO
+        end
+        private
+        def format_statistic(statistic)
+          data = {
+            "start_time" => statistic.start_time.to_i,
+            "last_time" => statistic.last_time.to_i,
+            "elapsed" => statistic.elapsed_in_seconds,
+            "return_code" => statistic.return_code,
+          }
+          command = statistic.command
+          arguments = command.arguments.collect do |key, value|
+            {"key" => key, "value" => value}
+          end
+          data["command"] = {
+            "raw" => statistic.raw_command,
+            "name" => command.name,
+            "parameters" => arguments,
+          }
+          operations = []
+          statistic.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]
+            operations << operation_data
+          end
+          data["operations"] = operations
+          JSON.generate(data)
+        end
+      end
+    end
+  end
+end

data/lib/groonga/query-log/analyzer/sized-grouped-operations.rb ADDED Viewed

@@ -0,0 +1,84 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2011-2012  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2012  Haruka Yoshihara <yoshihara@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
+module Groonga
+  module QueryLog
+    class Analyzer
+      class SizedGroupedOperations < Array
+        def initialize
+          @max_size = 10
+          @sorter = create_sorter
+        end
+        def apply_options(options)
+          @max_size = options[:n_entries]
+        end
+        def each
+          i = 0
+          super do |grouped_operation|
+            break if i >= @max_size
+            i += 1
+            yield(grouped_operation)
+          end
+        end
+        def <<(operation)
+          each do |grouped_operation|
+            if grouped_operation[:name] == operation[:name] and
+                grouped_operation[:context] == operation[:context]
+              elapsed = operation[:relative_elapsed_in_seconds]
+              grouped_operation[:total_elapsed] += elapsed
+              grouped_operation[:n_operations] += 1
+              replace(sort_by(&@sorter))
+              return self
+            end
+          end
+          grouped_operation = {
+            :name => operation[:name],
+            :context => operation[:context],
+            :n_operations => 1,
+            :total_elapsed => operation[:relative_elapsed_in_seconds],
+          }
+          buffer_size = @max_size * 100
+          if size < buffer_size
+            super(grouped_operation)
+            replace(sort_by(&@sorter))
+          else
+            if @sorter.call(grouped_operation) < @sorter.call(last)
+              super(grouped_operation)
+              sorted_operations = sort_by(&@sorter)
+              sorted_operations.pop
+              replace(sorted_operations)
+            end
+          end
+          self
+        end
+        private
+        def create_sorter
+          lambda do |grouped_operation|
+            -grouped_operation[:total_elapsed]
+          end
+        end
+      end
+    end
+  end
+end