request-log-analyzer 1.0.4 → 1.1.0

data/DESIGN

@@ -12,3 +12,13 @@ This allows you to easily add extra reports, filters and outputs.
 
 3) Gather output from pipeline.
   Controller.report
+
+At the moment the supported sources are file and STDIN.
+In the future we want to be able to have a generated request database as source.
+This will make interactive downdrilling possible.
+
+
+For the report generation output we now use the File and the STDOUT class, as they both support <<.
+In the future we want to have a OutputFile, OutputSTDOUT and OutputHTML class, so that reports can generate
+tables, lines and comments and push them into the output class.
+

data/README.rdoc

@@ -10,6 +10,8 @@ Merb to produce a performance report. Its purpose is to find what actions are be
 * Fast
 * MIT licensed
 
+Request log analyzer was designed and built by Willem van Bergen and Bart ten Brinke.
+
 == Installation
 
 Install request-log-analyzer as a Ruby gem:
@@ -36,3 +38,4 @@ For more details and available command line options, see the project's wiki:http
 
 * Project wiki at GitHub: http://wiki.github.com/wvanbergen/request-log-analyzer
 * wvanbergen's blog posts: http://techblog.floorplanner.com/tag/request-log-analyzer
+* bart ten brinke's blog posts: http://movesonrails.com

data/bin/request-log-analyzer

@@ -49,6 +49,7 @@ begin
     command_line.option(:before)    
     
     command_line.switch(:boring, :b)
+    command_line.option(:output, :alias => :o, :default => 'FixedWidth')    
     command_line.option(:report_width, :default => terminal_width - 1)
     
     command_line.switch(:debug)
@@ -73,6 +74,7 @@ rescue CommandLine::Error => e
   puts "  --database <filename>, -d: Creates an SQLite3 database of all the parsed request information."
   puts "  --debug                    Print debug information while parsing."
   puts "  --file <filename>          Output to file."
+  puts "  --output <format>          Output format. Supports 'HTML' and 'FixedWidth' (default)"  
   puts 
   puts "Examples:"
   puts "  request-log-analyzer development.log"
@@ -116,7 +118,7 @@ else
   puts "Request log analyzer, by Willem van Bergen and Bart ten Brinke - Version 1.0\n\n"  
   
   # Run the request_log_analyzer!
-  RequestLogAnalyzer::Controller.build(arguments, terminal_width).run!
+  RequestLogAnalyzer::Controller.build(arguments).run!
 
   puts 
   puts "Thanks for using request-log-analyzer"

data/lib/cli/progressbar.rb

@@ -7,230 +7,224 @@
 #
 # You can redistribute it and/or modify it under the terms
 # of Ruby's license.
-#
 
-class ProgressBar
-  VERSION = "0.9"
-
-  def initialize (title, total, out = STDERR)
-    @title = title
-    @total = total
-    @out = out
-    @terminal_width = 80
-    @bar_mark = '='
-    @current = 0
-    @previous = 0
-    @finished_p = false
-    @start_time = Time.now
-    @previous_time = @start_time
-    @title_width = 24
-    @format = "%-#{@title_width}s %3d%% %s %s"
-    @format_arguments = [:title, :percentage, :bar, :stat]
-    clear
-    show
-  end
-  attr_reader   :title
-  attr_reader   :current
-  attr_reader   :total
-  attr_accessor :start_time
-
-  private
-  def fmt_bar
-    bar_width = do_percentage * @terminal_width / 100
-    sprintf("[%s%s]", 
-            @bar_mark * bar_width, 
-            " " *  (@terminal_width - bar_width))
-  end
+module CommandLine
+  class ProgressBar
+    VERSION = "0.9"
+
+    def initialize (title, total, out = STDERR)
+      @title = title
+      @total = total
+      @out = out
+      @terminal_width = 80
+      @bar_mark = '='
+      @current = 0
+      @previous = 0
+      @finished_p = false
+      @start_time = Time.now
+      @previous_time = @start_time
+      @title_width = 24
+      @format = "%-#{@title_width}s %3d%% %s %s"
+      @format_arguments = [:title, :percentage, :bar, :stat]
+      clear
+      show
+    end
+    attr_reader   :title
+    attr_reader   :current
+    attr_reader   :total
+    attr_accessor :start_time
+
+    private
+    def fmt_bar
+      bar_width = do_percentage * @terminal_width / 100
+      sprintf("[%s%s]", 
+              @bar_mark * bar_width, 
+              " " *  (@terminal_width - bar_width))
+    end
 
-  def fmt_percentage
-    do_percentage
-  end
+    def fmt_percentage
+      do_percentage
+    end
 
-  def fmt_stat
-    if @finished_p then elapsed else eta end
-  end
+    def fmt_stat
+      if @finished_p then elapsed else eta end
+    end
 
-  def fmt_stat_for_file_transfer
-    if @finished_p then 
-      sprintf("%s %s %s", bytes, transfer_rate, elapsed)
-    else 
-      sprintf("%s %s %s", bytes, transfer_rate, eta)
+    def fmt_stat_for_file_transfer
+      if @finished_p then 
+        sprintf("%s %s %s", bytes, transfer_rate, elapsed)
+      else 
+        sprintf("%s %s %s", bytes, transfer_rate, eta)
+      end
     end
-  end
 
-  def fmt_title
-    @title[0,(@title_width - 1)] + ":"
-  end
+    def fmt_title
+      @title[0,(@title_width - 1)] + ":"
+    end
 
-  def convert_bytes (bytes)
-    if bytes < 1024
-      sprintf("%6dB", bytes)
-    elsif bytes < 1024 * 1000 # 1000kb
-      sprintf("%5.1fKB", bytes.to_f / 1024)
-    elsif bytes < 1024 * 1024 * 1000  # 1000mb
-      sprintf("%5.1fMB", bytes.to_f / 1024 / 1024)
-    else
-      sprintf("%5.1fGB", bytes.to_f / 1024 / 1024 / 1024)
+    def convert_bytes (bytes)
+      if bytes < 1024
+        sprintf("%6dB", bytes)
+      elsif bytes < 1024 * 1000 # 1000kb
+        sprintf("%5.1fKB", bytes.to_f / 1024)
+      elsif bytes < 1024 * 1024 * 1000  # 1000mb
+        sprintf("%5.1fMB", bytes.to_f / 1024 / 1024)
+      else
+        sprintf("%5.1fGB", bytes.to_f / 1024 / 1024 / 1024)
+      end
     end
-  end
 
-  def transfer_rate
-    bytes_per_second = @current.to_f / (Time.now - @start_time)
-    sprintf("%s/s", convert_bytes(bytes_per_second))
-  end
+    def transfer_rate
+      bytes_per_second = @current.to_f / (Time.now - @start_time)
+      sprintf("%s/s", convert_bytes(bytes_per_second))
+    end
 
-  def bytes
-    convert_bytes(@current)
-  end
+    def bytes
+      convert_bytes(@current)
+    end
 
-  def format_time (t)
-    t = t.to_i
-    sec = t % 60
-    min  = (t / 60) % 60
-    hour = t / 3600
-    sprintf("%02d:%02d:%02d", hour, min, sec);
-  end
+    def format_time (t)
+      t = t.to_i
+      sec = t % 60
+      min  = (t / 60) % 60
+      hour = t / 3600
+      sprintf("%02d:%02d:%02d", hour, min, sec);
+    end
 
-  # ETA stands for Estimated Time of Arrival.
-  def eta
-    if @current == 0
-      "ETA:  --:--:--"
-    else
-      elapsed = Time.now - @start_time
-      eta = elapsed * @total / @current - elapsed;
-      sprintf("ETA:  %s", format_time(eta))
+    # ETA stands for Estimated Time of Arrival.
+    def eta
+      if @current == 0
+        "ETA:  --:--:--"
+      else
+        elapsed = Time.now - @start_time
+        eta = elapsed * @total / @current - elapsed;
+        sprintf("ETA:  %s", format_time(eta))
+      end
     end
-  end
 
-  def elapsed
-    elapsed = Time.now - @start_time
-    sprintf("Time: %s", format_time(elapsed))
-  end
+    def elapsed
+      elapsed = Time.now - @start_time
+      sprintf("Time: %s", format_time(elapsed))
+    end
   
-  def eol
-    if @finished_p then "\n" else "\r" end
-  end
-
-  def do_percentage
-    if @total.zero?
-      100
-    else
-      @current  * 100 / @total
+    def eol
+      if @finished_p then "\n" else "\r" end
     end
-  end
 
-  def get_width
-    # FIXME: I don't know how portable it is.
-    default_width = 80
-    begin
-      tiocgwinsz = 0x5413
-      data = [0, 0, 0, 0].pack("SSSS")
-      if @out.ioctl(tiocgwinsz, data) >= 0 then
-        rows, cols, xpixels, ypixels = data.unpack("SSSS")
-        if cols >= 0 then cols else default_width end
+    def do_percentage
+      if @total.zero?
+        100
       else
-        default_width
+        @current  * 100 / @total
       end
-    rescue Exception
-      default_width
     end
-  end
 
-  def show
-    arguments = @format_arguments.map {|method| 
-      method = sprintf("fmt_%s", method)
-      send(method)
-    }
-    line = sprintf(@format, *arguments)
-
-    width = get_width
-    if line.length == width - 1 
-      @out.print(line + eol)
-      @out.flush
-    elsif line.length >= width
-      @terminal_width = [@terminal_width - (line.length - width + 1), 0].max
-      if @terminal_width == 0 then @out.print(line + eol) else show end
-    else # line.length < width - 1
-      @terminal_width += width - line.length + 1
-      show
+    def get_width
+      # FIXME: I don't know how portable it is.
+      default_width = 80
+      begin
+        tiocgwinsz = 0x5413
+        data = [0, 0, 0, 0].pack("SSSS")
+        if @out.ioctl(tiocgwinsz, data) >= 0 then
+          rows, cols, xpixels, ypixels = data.unpack("SSSS")
+          if cols >= 0 then cols else default_width end
+        else
+          default_width
+        end
+      rescue Exception
+        default_width
+      end
     end
-    @previous_time = Time.now
-  end
 
-  def show_if_needed
-    if @total.zero?
-      cur_percentage = 100
-      prev_percentage = 0
-    else
-      cur_percentage  = (@current  * 100 / @total).to_i
-      prev_percentage = (@previous * 100 / @total).to_i
+    def show
+      arguments = @format_arguments.map {|method| 
+        method = sprintf("fmt_%s", method)
+        send(method)
+      }
+      line = sprintf(@format, *arguments)
+
+      width = get_width
+      if line.length == width - 1 
+        @out.print(line + eol)
+        @out.flush
+      elsif line.length >= width
+        @terminal_width = [@terminal_width - (line.length - width + 1), 0].max
+        if @terminal_width == 0 then @out.print(line + eol) else show end
+      else # line.length < width - 1
+        @terminal_width += width - line.length + 1
+        show
+      end
+      @previous_time = Time.now
     end
 
-    # Use "!=" instead of ">" to support negative changes
-    if cur_percentage != prev_percentage || 
-        Time.now - @previous_time >= 1 || @finished_p
-      show
+    def show_if_needed
+      if @total.zero?
+        cur_percentage = 100
+        prev_percentage = 0
+      else
+        cur_percentage  = (@current  * 100 / @total).to_i
+        prev_percentage = (@previous * 100 / @total).to_i
+      end
+
+      # Use "!=" instead of ">" to support negative changes
+      if cur_percentage != prev_percentage || 
+          Time.now - @previous_time >= 1 || @finished_p
+        show
+      end
     end
-  end
 
-  public
-  def clear
-    @out.print "\r"
-    @out.print(" " * (get_width - 1))
-    @out.print "\r"
-  end
+    public
+    def clear
+      @out.print "\r"
+      @out.print(" " * (get_width - 1))
+      @out.print "\r"
+    end
 
-  def finish
-    @current = @total
-    @finished_p = true
-    show
-  end
+    def finish
+      @current = @total
+      @finished_p = true
+      show
+    end
 
-  def finished?
-    @finished_p
-  end
+    def finished?
+      @finished_p
+    end
 
-  def file_transfer_mode
-    @format_arguments = [:title, :percentage, :bar, :stat_for_file_transfer]
-  end
+    def file_transfer_mode
+      @format_arguments = [:title, :percentage, :bar, :stat_for_file_transfer]
+    end
 
-  def format= (format)
-    @format = format
-  end
+    def format= (format)
+      @format = format
+    end
 
-  def format_arguments= (arguments)
-    @format_arguments = arguments
-  end
+    def format_arguments= (arguments)
+      @format_arguments = arguments
+    end
 
-  def halt
-    @finished_p = true
-    show
-  end
+    def halt
+      @finished_p = true
+      show
+    end
 
-  def inc (step = 1)
-    @current += step
-    @current = @total if @current > @total
-    show_if_needed
-    @previous = @current
-  end
+    def inc (step = 1)
+      @current += step
+      @current = @total if @current > @total
+      show_if_needed
+      @previous = @current
+    end
 
-  def set (count)
-    count = 0 if count < 0 
-    count = @total if count > @total
+    def set (count)
+      count = 0 if count < 0 
+      count = @total if count > @total
     
-    @current = count
-    show_if_needed
-    @previous = @current
-  end
-
-  def inspect
-    "#<ProgressBar:#{@current}/#{@total}>"
-  end
-end
+      @current = count
+      show_if_needed
+      @previous = @current
+    end
 
-class ReversedProgressBar < ProgressBar
-  def do_percentage
-    100 - super
+    def inspect
+      "#<ProgressBar:#{@current}/#{@total}>"
+    end
   end
 end
-

data/lib/request_log_analyzer/aggregator/base.rb

@@ -38,7 +38,7 @@ module RequestLogAnalyzer::Aggregator
     
     # The report function is called at the end. Implement any result reporting
     # in this function.
-    def report(output = STDOUT, report_width = 80, color = false)
+    def report(output)
     end
 
   end

data/lib/request_log_analyzer/aggregator/database.rb

@@ -50,13 +50,13 @@ module RequestLogAnalyzer::Aggregator
     end
     
     # Prints a short report of what has been inserted into the database
-    def report(output = STDOUT, report_width = 80, color = false)
-      output << "\n"
-      output << green("━" * report_width, color) + "\n"
+    def report(output)
+      output.title('Request database created')
+      
       output <<  "A database file has been created with all parsed request information.\n"
       output <<  "#{@request_count} requests have been added to the database.\n"      
       output <<  "To execute queries on this database, run the following command:\n"
-      output <<  "  $ sqlite3 #{options[:database]}\n"
+      output <<  output.colorize("  $ sqlite3 #{options[:database]}\n", :bold)
       output << "\n"
     end
     

data/lib/request_log_analyzer/aggregator/echo.rb

@@ -14,11 +14,9 @@ module RequestLogAnalyzer::Aggregator
       @warnings << "WARNING #{type.inspect} on line #{lineno}: #{message}\n"
     end
     
-    def report(output=STDOUT, report_width = 80, color = false)
-      output << "\n"
-      output << "Warnings during parsing:\n"
-      output << green("━" * report_width, color) + "\n"
-      output << @warnings + "\n"
+    def report(output)
+      output.title("Warnings during parsing")
+      output.puts @warnings
     end
 
   end

data/lib/request_log_analyzer/aggregator/summarizer.rb

@@ -67,36 +67,41 @@ module RequestLogAnalyzer::Aggregator
       @trackers.each { |tracker| tracker.finalize }
     end
        
-    def report(output=STDOUT, report_width = 80, color = false)
-      report_header(output, report_width, color)
+    def report(output)
+      report_header(output)
       if source.parsed_requests > 0
-        @trackers.each { |tracker| tracker.report(output, report_width, color) }
+        @trackers.each { |tracker| tracker.report(output) }
       else
-        output << "\n"
-        output << "There were no requests analyzed.\n"
+        output.puts
+        output.puts('There were no requests analyzed.')
       end
-      report_footer(output, report_width, color)
+      report_footer(output)
     end
     
-    def report_header(output=STDOUT, report_width = 80, color = false)
-      output << "Request summary\n"
-      output << green("━" * report_width, color) + "\n"
-      output << "Parsed lines:         #{green(source.parsed_lines, color)}\n"
-      output << "Parsed requests:      #{green(source.parsed_requests, color)}\n"
-      output << "Skipped lines:        #{green(source.skipped_lines, color)}\n" if source.skipped_lines > 0
-      if has_warnings?
-        output <<  "Warnings:             " + @warnings_encountered.map { |(key, value)| "#{key.inspect}: #{blue(value, color)}" }.join(', ') + "\n"
+    def report_header(output)
+      output.title("Request summary")
+  
+      output.with_style(:cell_separator => false) do 
+        output.table({:width => 20}, {:font => :bold}) do |rows|
+          rows << ['Parsed lines:',   source.parsed_lines]
+          rows << ['Parsed request:', source.parsed_requests]
+          rows << ['Skipped lines:',  source.skipped_lines]
+        
+          rows <<  ["Warnings:", @warnings_encountered.map { |(key, value)| "#{key.inspect}: #{value}" }.join(', ')] if has_warnings?
+        end
       end
       output << "\n"
     end
     
-    def report_footer(output=STDOUT, report_width = 80, color = false)
-      output << "\n" 
-      if has_serious_warnings?      
-        output << green("━" * report_width, color) + "\n"
-        output << "Multiple warnings were encountered during parsing. Possibly, your logging " + "\n"
-        output << "is not setup correctly. Visit this website for logging configuration tips:" + "\n"
-        output <<  blue("http://github.com/wvanbergen/request-log-analyzer/wikis/configure-logging", color) + "\n"
+    def report_footer(output)
+      if has_serious_warnings?     
+        
+        output.title("Parse warnings")
+        
+        output.puts "Multiple warnings were encountered during parsing. Possibly, your logging "
+        output.puts "is not setup correctly. Visit this website for logging configuration tips:"
+        output.puts output.link("http://github.com/wvanbergen/request-log-analyzer/wikis/configure-logging")
+        output.puts
       end
     end
     

data/lib/request_log_analyzer/controller.rb

@@ -29,17 +29,19 @@ module RequestLogAnalyzer
     # Builds a RequestLogAnalyzer::Controller given parsed command line arguments
     # <tt>arguments<tt> A CommandLine::Arguments hash containing parsed commandline parameters.
     # <rr>report_with</tt> Width of the report. Defaults to 80.
-    def self.build(arguments, report_width = 80)
-            
-      options = { :report_width => arguments[:report_width].to_i, :output => STDOUT}
+    def self.build(arguments)
+      options = { }
 
       options[:database] = arguments[:database] if arguments[:database]
       options[:debug]    = arguments[:debug]
-      options[:colorize] = !arguments[:boring]
 
+      output_class = RequestLogAnalyzer::Output::const_get(arguments[:output])
       if arguments[:file]
-        options[:output] = File.new(arguments[:file], "w+")
-        options[:colorize] = false
+        output_file = File.new(arguments[:file], "w+")
+        options[:output] = output_class.new(output_file, :width => 80, :color => false, :characters => :ascii)
+      else
+        options[:output] = output_class.new(STDOUT, :width => arguments[:report_width].to_i, 
+            :color => !arguments[:boring], :characters => (arguments[:boring] ? :ascii : :utf))
       end
                 
       # Create the controller with the correct file format
@@ -129,7 +131,7 @@ module RequestLogAnalyzer
     def handle_progress(message, value = nil)
       case message
       when :started
-        @progress_bar = ProgressBar.new(green(File.basename(value), options[:colorize]), File.size(value))
+        @progress_bar = CommandLine::ProgressBar.new(File.basename(value), File.size(value))
       when :finished
         @progress_bar.finish
         @progress_bar = nil
@@ -176,6 +178,8 @@ module RequestLogAnalyzer
     # 6. Finalize Source
     def run!
       
+
+      
       @filters.each { |filter| filter.prepare }
       @aggregators.each { |agg| agg.prepare }
       
@@ -189,12 +193,15 @@ module RequestLogAnalyzer
         puts "Caught interrupt! Stopped parsing."
       end
 
-      puts "\n"
-      
       @aggregators.each { |agg| agg.finalize }
-      @aggregators.each { |agg| agg.report(@output, options[:report_width], options[:colorize]) }
-      
+
+      @output.header
+      @aggregators.each { |agg| agg.report(@output) }
+      @output.footer
+            
       @source.finalize
+      
+
     end
     
   end

data/lib/request_log_analyzer/filter/base.rb

@@ -17,9 +17,12 @@ module RequestLogAnalyzer
         register_file_format(format)
       end
       
+      # Initialize the filter
       def prepare
       end
       
+      # Return the request if the request should be kept.
+      # Return nil otherwise.
       def filter(request)
         return nil unless request
         return request