ngauthier-slow-actions 0.2.6 → 0.3.0

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 2
-:patch: 6
+:minor: 3
+:patch: 0
 :major: 0

data/bin/slow-actions

@@ -1,7 +1,14 @@
 #!/usr/bin/env ruby
 require File.join(File.dirname(__FILE__), '..', 'lib', 'slow_actions')
 
-@sa = SlowActions.new
+opts = {}
+start_date = ARGV.detect{|arg| arg =~/--start-date=(\S+)/}
+opts[:start_date] = $1 if start_date
+end_date = ARGV.detect{|arg| arg =~/--end-date=(\S+)/}
+opts[:end_date] = $1 if start_date
+
+
+@sa = SlowActions.new(opts)
 ARGV.select{|arg| arg[0,2] != "--"}.each do |file|
   @sa.parse_file(file)
 end
@@ -34,6 +41,8 @@ if output.size == 0
   puts "\t--min-cost=FLOAT"
   puts "\t--min-avg=FLOAT"
   puts "\t--min-max=FLOAT"
+  puts "\t--start-date=YYYY-MM-DD"
+  puts "\t--end-date=YYYY-MM-DD"
 else
   puts output.join("\n\n")
 end

data/lib/slow_actions.rb

@@ -1,23 +1,44 @@
+# Main class for the slow actions plugin library
 require File.join(File.dirname(__FILE__), 'slow_actions_parser')
 require File.join(File.dirname(__FILE__), 'slow_actions_controller')
 require File.join(File.dirname(__FILE__), 'slow_actions_action')
 require File.join(File.dirname(__FILE__), 'slow_actions_session')
+require 'date'
 
+# SlowActions class that is the master controller for processing slow actions
 class SlowActions
-  def initialize
+  # Takes an options hash where you can specify :start_date and :end_date as "YYYY-MM-DD" strings
+  def initialize(opts = {})
     @log_entries = []
+    if opts[:start_date]
+      @start_date = Date.strptime(opts[:start_date])
+    else
+      @start_date = Date.strptime
+    end
+    if opts[:end_date]
+      @end_date = Date.strptime(opts[:end_date])
+    else
+      @end_date = Date.today
+    end
   end
 
+  # Parse the file found at "file_path" and add the log entries to its collection of entries.
   def parse_file(file_path)
-    parser = Parser.new(file_path)
+    parser = Parser.new(file_path, @start_date, @end_date)
     @log_entries += parser.parse
     process
   end
 
+  # All the #LogEntry objects
   def log_entries
     return @log_entries
   end
 
+  # Print out all the actions and their statistics
+  #
+  #  :mincost  Lower bound on the cost of this action. See Computable.
+  #  :minavg   Lower bound on the average amount of time this action ever took
+  #  :minmax   Lower bound on the maximum amount of time this action ever took
   def print_actions(opts = {})
     str = ""
     str += "           Cost    Average Max\n"
@@ -34,6 +55,7 @@ class SlowActions
     return str
   end
 
+  # Print out all the controllers and their statistics, nesting actions as a tree. See #print_actions for options.
   def print_controller_tree(opts = {})
     str = ""
     str += "             Cost    Average Max\n"
@@ -59,6 +81,7 @@ class SlowActions
     return str
   end
 
+  # Print out all the session_ids and their statistics. See #print_actions for options.
   def print_sessions(opts = {})
     str = ""
     str += "           Cost    Average Max\n"
@@ -75,30 +98,40 @@ class SlowActions
     return str
   end
 
+  # Print out the stats as html. Not implemented.
   def to_html
     raise "Not Implemented"
   end
 
+  # All the #Controller objects.
   def controllers
     @controllers.values
   end
 
+  # All the #Action objects
   def actions
     @actions.values
   end
 
+  # All the #Session objects
   def sessions
     @sessions.values
   end
 
   private
 
+  # The Date to start parsing from
+  attr_accessor :start_date
+  # The Date to stop parsing at
+  attr_accessor :end_date
+
+  # Process statistics for all #Actions #Controllers and #Sessions
   def process
     @controllers ||= {}
     @actions ||= {}
     @sessions ||= {}
     @log_entries.each do |la|
-      next if la.processed
+      next if la.nil? or la.processed
       c = @controllers[la.controller]
       if c.nil?
         c = Controller.new(la.controller)
@@ -129,6 +162,7 @@ class SlowActions
     @sessions.values.each{|s| s.compute_times}
   end
 
+  # Convert a float to 7 places padded with zeros then one space
   def ftos(float)
     str = ((float*1000).to_i.to_f/1000).to_s
     while str.size < 7

data/lib/slow_actions_action.rb

@@ -1,20 +1,29 @@
 require File.join(File.dirname(__FILE__), 'slow_actions_computation_module')
 class SlowActions
   private
+  # Class to hold all #LogEntry objects that are associated with this individual #Action on a #Controller
   class Action
     include Computable
+    # Create a new #Action object.
+    #   name: the #name of the #Action. i.e. "new"
+    #   controller: the #Controller this #Action is a part of
     def initialize(name, controller)
       @name = name
       @controller = controller
       @log_entries = []
     end
+
+    # Name of this #Action
     attr_reader :name
+    # #Controller of this #Action
     attr_reader :controller
 
+    # Add a log entry to this #Action
     def add_entry(la)
       @log_entries << la
       la.action = self
     end
+    # All the #LogEntry objects this #Action holds
     attr_reader :log_entries
 
   end

data/lib/slow_actions_computation_module.rb

@@ -1,9 +1,32 @@
+# Computable module provides the attributes and methods to compute statistics on log entries
+#
+# Cost is computed as
+#   avg * Math.log(total + 0.1)
+#
+# So that it can take into account the frequency for which an action is called
 module Computable
-    attr_reader :render_avg, :db_avg, :total_avg
-    attr_reader :render_max, :db_max, :total_max
-    attr_reader :render_cost, :db_cost, :total_cost
+    # the average time for rendering
+    attr_reader :render_avg
+    # the average time for the database
+    attr_reader :db_avg
+    # the average time for the entire object
+    attr_reader :total_avg
+    # the maximum time an object ever took to render
+    attr_reader :render_max
+    # the maximum time an object ever took to query the database
+    attr_reader :db_max
+    # the maximum time an object ever took to complete the entire action
+    attr_reader :total_max
+    # cost for this action to render
+    attr_reader :render_cost
+    # cost for this action to query the db
+    attr_reader :db_cost
+    # cost for this action to complete
+    attr_reader :total_cost
+    # average error rate for this action
     attr_reader :error_avg
 
+    # Perform all the computations in one loop
     def compute_times
       @render_avg = 0.0
       @db_avg = 0.0

data/lib/slow_actions_controller.rb

@@ -1,24 +1,32 @@
 require File.join(File.dirname(__FILE__), 'slow_actions_computation_module')
 class SlowActions
   private
+  # Class to hold all #LogEntry objects that are associated with this #Controller.
   class Controller
     include Computable
+    # Create a new #Controller
+    #   name: The name of the #Controller
     def initialize(name)
       @name = name
       @log_entries = []
       @actions = []
     end
+    # Name of the #Controller
     attr_reader :name
 
+    # Add a #LogEntry to this #Controller
     def add_entry(la)
       @log_entries << la
       la.controller = self
     end
+    # All the #LogEntry objects associated with this #Controller
     attr_reader :log_entries
 
+    # Add an #Action as a child of this #Controller
     def add_action(a)
       @actions << a
     end
+    # All the #Actions under this #Controller
     attr_reader :actions
 
   end

data/lib/slow_actions_log_entry.rb

@@ -1,23 +1,39 @@
 class SlowActions
   private
+  # Object representing a single entry in a rails application's log file
   class LogEntry
+    # Create a new #LogEntry
     def initialize
       self.processed = false
     end
+    # The #Controller
     attr_accessor :controller
+    # The #Action
     attr_accessor :action
+    # IP address of user
     attr_accessor :ip
+    # date
     attr_accessor :date
+    # time
     attr_accessor :time
+    # HTTP Method
     attr_accessor :method
+    # Session ID
     attr_accessor :session
+    # Parameters to the action
     attr_accessor :parameters
+    # Total duration to complete
     attr_accessor :duration
+    # time spent rendering
     attr_accessor :rendering
+    # time spent in the database
     attr_accessor :db
+    # error text (if any)
     attr_accessor :error_text
+    # whether or not is has already been processed by #SlowActions
     attr_accessor :processed
 
+    # Whether or not this #LogEntry was an error
     def error?
       return false if error_text.nil?
       return false if error_text.empty?

data/lib/slow_actions_parser.rb

@@ -1,14 +1,23 @@
 require File.join(File.dirname(__FILE__), 'slow_actions_log_entry')
 class SlowActions
   private
+  # Text parser for #SlowActions
   class Parser
 
-    def initialize(file_path)
+    # Create a new #Parser
+    #   file_path: path to log file to parse
+    #   start_date: Date object. Entries before this date are skipped
+    #   end_date: Date object. Entries after this date are skipped
+    # Dates are inclusive
+    def initialize(file_path, start_date, end_date)
       @file_path = file_path
       raise "File not found: #{file_path}" unless File.exists? file_path
       @file = File.new(file_path, 'r')
+      @start_date = start_date
+      @end_date = end_date
     end
-
+ 
+    # Initiate the parsing
     def parse
       @log_entries = []
       begin
@@ -26,6 +35,8 @@ class SlowActions
 
     private
 
+    # Parse an individual entry
+    #   line: one line of text
     def parse_log_entry(line)
       la = LogEntry.new
       if line =~ /^Processing (\S+)#(\S+) \(for (\S+) at (\S+) (\S+)\) \[(\S+)\]$/
@@ -35,6 +46,10 @@ class SlowActions
         la.date = $4
         la.time = $5
         la.method = $6
+        parsed_date = Date.strptime(la.date)
+        if parsed_date < @start_date or parsed_date > @end_date
+          return nil
+        end
       end
       line = @file.readline
       if line =~ /^\s+Session ID: (\S+)$/
@@ -69,6 +84,7 @@ class SlowActions
       return la
     end
 
+    # parse an error
     def parse_error
       line = "\n"
       while line == "\n"

data/lib/slow_actions_session.rb

@@ -1,18 +1,24 @@
 require File.join(File.dirname(__FILE__), 'slow_actions_computation_module')
 class SlowActions
   private
+  # Class to hold and #LogEntry objects that are associated with this individual Session ID
   class Session
     include Computable
+    # Create a new session
+    #   name: the session_id
     def initialize(name)
       @name = name
       @log_entries = []
     end
+    # The session_id
     attr_reader :name
 
+    # Add a #LogEntry to this #Session
     def add_entry(la)
       @log_entries << la
       la.session = self
     end
+    # All the #LogEntry objects this #Session holds
     attr_reader :log_entries
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ngauthier-slow-actions
 version: !ruby/object:Gem::Version 
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors: 
 - Nick Gauthier