better_rails_debugger 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 378633b02ace347f31f2e5350248b08903e24e87
-  data.tar.gz: cf4e8e7b1614196b194ef32060c46a24237bac98
+  metadata.gz: 8db111d53acaca8f9189541d980913115548ad5d
+  data.tar.gz: 3019083b26fc20710e60f1e117c24ed8ab11fb36
 SHA512:
-  metadata.gz: 454b43fb094ea115cb30bdd1aa700dcb73b5cf5aaae41bbce2019e2c7e9c0cb62c0c2e497ba5fc91f2ffe5ebee5426a595f202f4d23cc13538963a2999474933
-  data.tar.gz: ea0d02c5e10418a224e075d0e9eab163b3bc57e9fa4a31f204c6a1d9f1c18e6990ece288207baa946e8c0f671173b134d27a414d86e01c4b3e548e88b7fc7443
+  metadata.gz: e2cd39a23ed59ad9287721aba2d9df1aac1848939ce417626f7fa39447846218140359a294d858c510806cffb0c976c183af409d23fc733cba50539be6983702
+  data.tar.gz: 64c5dfab31505814a7ecfa858b662da32fa23620e0c8b857aa35a4065252270be67e4b82bc05f8a6f4fc5ce7470134aed7b004ffda5cfd8f38b9fa97dbe0d69f

data/README.md

@@ -84,7 +84,7 @@ class ApplicationController < ActionController::Base
   around_action :do_analysis
 
   def do_analysis
-    BetterRailsDebugger::MemoryAnalyzer.instance.analyze "#{request.url}", "5a98a93f50f04b079458fd57" do
+    BetterRailsDebugger::Analyzer.instance.analyze "#{request.url}", "5a98a93f50f04b079458fd57" do
       yield
     end
   end

data/app/controllers/better_rails_debugger/analysis_groups_controller.rb

@@ -65,7 +65,8 @@ module BetterRailsDebugger
     def analysis_group_params
       params.require(:analysis_group).permit([:name, :collect_memory_information, :analise_memory_in_code,
                                               :analise_memory_in_gems, :record_objects_in, :times_to_run,
-                                              :analyze_repeated_instances])
+                                              :analyze_repeated_instances, :generate_method_execution_history,
+                                              :calculate_execution_time_of_methods])
     end
 
     def get_group

data/app/controllers/better_rails_debugger/group_instances_controller.rb

@@ -2,6 +2,31 @@ require_dependency "better_rails_debugger/application_controller"
 
 module BetterRailsDebugger
   class GroupInstancesController < ApplicationController
+    def show
+      begin
+        @instance = GroupInstance.find params[:id]
+      rescue Mongoid::Errors::DocumentNotFound
+        redirect_to analysis_groups_path, flash: {error: 'Instance not found'}
+        return
+      end
+      @most_used_methods = @instance.most_used_methods(4)
+      @file_allocations  = @instance.files_with_more_allocations(4)
+    end
+
+    def tracer
+      begin
+        @instance = GroupInstance.find params[:id]
+      rescue Mongoid::Errors::DocumentNotFound
+        redirect_to analysis_groups_path, flash: {error: 'Instance not found'}
+        return
+      end
+      @traces = @instance.trace_point_items.order(created_at: 'desc').limit(20)
+      filter_traces
+      @traces = @traces.paginate(page: (params[:page] || 1), per_page: 20)
+
+      @file_allocations = @instance.files_with_more_allocations(4)
+    end
+
     def objects
       begin
       @instance = GroupInstance.find params[:id]
@@ -10,7 +35,7 @@ module BetterRailsDebugger
         return
       end
       @objects = @instance.objects.order(created_at: 'desc').limit(20)
-      filter
+      filter_objects
       @objects = @objects.paginate(page: (params[:page] || 1), per_page: 20)
 
       @file_allocations = @instance.files_with_more_allocations(4)
@@ -31,7 +56,7 @@ module BetterRailsDebugger
     end
 
     private
-    def filter
+    def filter_objects
       if ['asc', 'desc'].include? params[:order] and ['location', 'memsize', 'class'].include? params[:column]
         if params[:column] == 'location'
           @objects = @objects.order({source_file: params[:order], source_line: params[:order]})
@@ -49,5 +74,22 @@ module BetterRailsDebugger
         pp @objects
       end
     end
+
+    def filter_traces
+      if ['asc', 'desc'].include? params[:order] and ['location', 'method', 'times'].include? params[:column]
+        if params[:column] == 'location'
+          @traces = @traces.order({source_file: params[:order], source_line: params[:order]})
+        elsif params[:column] == 'method'
+          @traces = @traces.order({method_id: params[:order]})
+        end
+      end
+      if params[:filter].present?
+        @objects = @objects.or({source_file: /.*#{params[:filter]}.*/i},
+                               {source_line: /.*#{params[:filter]}.*/i},
+                               {memsize:     /.*#{params[:filter]}.*/i},
+                               {class_name:  /.*#{params[:filter]}.*/i})
+        pp @objects
+      end
+    end
   end
 end

data/app/jobs/better_rails_debugger/analysis_recorder_job.rb

@@ -14,6 +14,8 @@ module BetterRailsDebugger
         Rails.logger.error "[BetterRailsDebugger AnalysisRecorderJob] GroupInstance '#{recorded[:instance_id]}' not found. Skiping..."
         return
       end
+      instance.status = 'processing'
+      instance.save
 
       # Now, with the group present... we can start to work on it
       # group = instance.analysis_group
@@ -30,6 +32,7 @@ module BetterRailsDebugger
       end
       instance.allocations_per_file = allocations_per_file.to_json
       instance.memsize_per_file = memsize_per_file.to_json
+      instance.status = 'finished'
       instance.save
 
     end

data/app/models/better_rails_debugger/analysis_group.rb

@@ -21,6 +21,10 @@ module BetterRailsDebugger
     field :times_to_run, type: Integer, default: 0                     # 0: Infinite
     field :analyze_repeated_instances, type: Boolean, default: true    # if false, Check the identifier and do run the analyzer if already exist one with the same identifier
 
+    ## Code execution options
+    field :generate_method_execution_history, type: Boolean, default: false
+    field :calculate_execution_time_of_methods, type: Boolean, default: false
+
     # Internal use
     field :analise_paths, type: Array, default: []
 

data/app/models/better_rails_debugger/group_instance.rb

@@ -5,13 +5,14 @@ module BetterRailsDebugger
 
     belongs_to :analysis_group, class_name: "::BetterRailsDebugger::AnalysisGroup"
     has_many :objects, class_name: "::BetterRailsDebugger::ObjectInformation", inverse_of: :group_instance, dependent: :delete_all
+    has_many :trace_point_items, class_name: "::BetterRailsDebugger::TracePointItem", inverse_of: :group_instance, dependent: :delete_all
 
     # Basic information
     field :identifier, type: String
     field :metadata, type: Hash
 
     # Status information
-    field :processed, type: Boolean
+    field :status, type: String
     field :total_classes, type: Integer                 # Total number of used Classes
     field :total_memory, type: Integer                  # Total memory used in bytes
     field :total_files, type: Integer                   # Total file used on allocation
@@ -21,17 +22,72 @@ module BetterRailsDebugger
     field :allocations_per_file, type: String
     field :memsize_per_file, type: String
 
-    def track_allocation_of?(path)
-      return true if match_file_list?(path) or called_from_caller_file?(path)
-      false
+    ## Memory methods
+
+    def memsize_per_file_hash
+      return @memsize_per_file_hash if @memsize_per_file_hash.present?
+      @memsize_per_file_hash = JSON.parse(memsize_per_file.to_s) rescue {}
     end
 
-    def files_with_more_allocations(n)
-      JSON.parse(allocations_per_file).to_a.sort_by do |a| a[1] end.reverse[0..n]
+    def allocations_per_file_hash
+      return @allocations_per_file if @allocations_per_file.present?
+      @allocations_per_file = JSON.parse(allocations_per_file.to_s) rescue {}
     end
 
     def files_that_use_more_memory(n)
-      JSON.parse(memsize_per_file).to_a.sort_by do |a| a[1] end.reverse[0..n]
+      memsize_per_file_hash.to_a.sort_by do |a| a[1] end.reverse[0..n]
+    end
+
+    def files_with_more_allocations(n)
+      allocations_per_file_hash.to_a.sort_by do |a| a[1] end.reverse[0..n]
+    end
+
+    def count_methods
+      return @count_methods if @count_methods
+      @count_methods = Hash.new
+      trace_point_items.each do |item|
+        @count_methods["#{item.source_file}:#{item.source_line}"] ||= {
+          item: item,
+          count: 0
+        }
+        @count_methods["#{item.source_file}:#{item.source_line}"][:count] += 1
+      end
+      @count_methods
+    end
+
+    def most_used_methods(n)
+      count_methods.to_a.sort_by do |a| a[1][:count] end.reverse[0..n].to_h
+    end
+
+    # Return an array of hash file => mem that consume more than 10 MB(default) or ram aprox
+    # TODO: The amount of consumed ram must be configurable
+    def big_files(max_size=10.megabytes)
+      return @big_files if @big_files
+      @big_files = (memsize_per_file_hash || {}).select do |key, size|
+        size >= max_size
+      end
+    end
+
+    # Return an array of hashed that contains some information about the classes that consume more than `max_size` bytess
+    def big_classes(max_size=1.megabytes)
+      return @big_classes if @big_classes
+      @big_classes = {}
+      ObjectInformation.where(:group_instance_id => self.id, :memsize.gt => max_size).all.each do |object|
+        @big_classes[object.class_name] ||= {total_mem: 0, average: 0, count: 0}
+        @big_classes[object.class_name][:total_mem] += object.memsize
+        @big_classes[object.class_name][:count] += 1
+      end
+      @big_classes.each_pair do |klass, hash|
+        @big_classes[klass][:average] = @big_classes[klass][:total_mem] / @big_classes[klass][:count]
+      end
+      @big_classes
+    end
+
+    ## Trace point methods
+
+    def track_allocation_of?(path)
+      return true if match_file_list?(path) or called_from_caller_file?(path)
+      false
     end
 
     private

data/app/models/better_rails_debugger/trace_point_item.rb

@@ -0,0 +1,11 @@
+module BetterRailsDebugger
+  class TracePointItem
+    include Mongoid::Document
+
+    belongs_to :group_instance, class_name: "::BetterRailsDebugger::GroupInstance"
+
+    field :source_file, type: String
+    field :source_line, type: Integer
+    field :method_id, type: String
+  end
+end

data/app/views/better_rails_debugger/analysis_groups/_form.html.haml

@@ -4,7 +4,7 @@
     = f.text_field :name, min: 3, class: 'form-control form-control-lg col-10'
 
   %fielset.form-group
-    %legend Settings
+    %legend Memory Settings
     .form-group.d-flex.justify-content-start
       = f.label :times_to_run, class: 'col-2'
       .col-10
@@ -37,5 +37,22 @@
       .col-10
         = f.check_box :analise_memory_in_gems
         .text-danger.d-inline Analise memory of all gems in the block it's really slow
+  / Disabled by the moment
+    %fielset.form-group
+      %legend.d-inline
+        Code execution
+      %i.small.d-inline.text-danger
+        (under development, do not enable it yet)
+      .form-group.d-flex.justify-content-start
+        = f.label :generate_method_execution_history, class: 'col-2'
+        .col-10
+          = f.check_box :generate_method_execution_history
+          .text-secondary.d-inline Generate and store the whole backtrace of method executed.
+
+      .form-group.d-flex.justify-content-start
+        = f.label :calculate_execution_time_of_methods, class: 'col-2'
+        .col-10
+          = f.check_box :calculate_execution_time_of_methods
+          .text-secondary.d-inline Generate and store the whole backtrace of method executed.
 
   %button.btn.btn-primary{:type => "submit"} Confirm

data/app/views/better_rails_debugger/analysis_groups/show.html.haml

@@ -29,7 +29,7 @@
       %tbody
         - @instances.each do |instance|
           %tr.d-flex
-            %td.col-8= link_to instance.identifier, objects_group_instance_path(instance.id)
+            %td.col-8= link_to instance.identifier, group_instance_path(instance.id)
             %th.col-2= instance.created_at.strftime("%c")
             %td.col-2= link_to "Objects", objects_group_instance_path(instance.id), class: 'btn btn-sm btn-information'
     = will_paginate @instances, renderer: WillPaginate::ActionView::BootstrapLinkRenderer

data/app/views/better_rails_debugger/group_instances/_memory_summary.html.haml

@@ -0,0 +1,47 @@
+%h4 Memory summary
+- if @instance.big_files.any?
+  %p
+    There are
+    %i.text-danger
+      = @instance.big_files.size
+    file that you should check.
+  %table.table.border.border-secondary.border-top-0
+    %thead.bg-secondary.text-white
+      %tr.d-flex
+        %th.col-10 File
+        %th.col-2 Memory
+
+    %tbody
+      - @instance.big_files.each do |file, size|
+        %tr.d-flex
+          %td.col-10
+            %span.text-primary
+              = file
+          %td.col-2= number_to_human_size size
+
+- else
+  %p.text-success Congratulations! all your files looks good!
+
+- if @instance.big_classes.any?
+  %p
+    There are
+    %i.text-danger
+      = @instance.big_classes.size
+    classes that you should check.
+
+  %table.table.border.border-secondary.border-top-0
+    %thead.bg-secondary.text-white
+      %tr.d-flex
+        %th.col-10 Class
+        %th.col-2 Average memory
+
+    %tbody
+      - @instance.big_classes.each_pair do |klass, hash|
+        %tr.d-flex
+          %td.col-10
+            %span.text-danger
+              = klass
+          %td.col-2= number_to_human_size hash[:average]
+- else
+  %p.text-success There is no particular class that you should care about.
+= link_to "Check all objects allocated", objects_group_instance_path(@instance)

data/app/views/better_rails_debugger/group_instances/_method_summary.html.haml

@@ -0,0 +1,3 @@
+%h4 Trace summary
+
+= link_to "Check all objects allocated", tracer_group_instance_path(@instance)

data/app/views/better_rails_debugger/group_instances/objects.html.haml

@@ -22,7 +22,9 @@
         %li.breadcrumb-item
           %a{:href => analysis_group_path(@instance.analysis_group.id)}= @instance.analysis_group.name
         %li.breadcrumb-item
-          %a{:href => "#"}= @instance.identifier
+          %a{:href => group_instance_path(@instance)}= @instance.identifier
+        %li.breadcrumb-item.active
+          %a{:href => "#"} Objects
 
     .alert.alert-warning{:role => "alert"}
       %h4.alert-heading

data/app/views/better_rails_debugger/group_instances/show.html.haml

@@ -0,0 +1,35 @@
+.card
+  .card-header
+    = @instance.identifier
+    = "-"
+    = @instance.created_at.strftime("%c")
+  .card-body
+
+    - content_for :header_nav do
+      %ul.nav.navbar-nav.d-md-down-none
+        %li.nav-item
+          %a.nav-link.navbar-toggler.sidebar-toggler{:href => "#"} ☰
+        %li.nav-item.px-3
+          %a.nav-link{:href => group_instance_path(@instance)} List
+
+      %ul.navbar-nav.ml-md-auto
+
+
+    - content_for :breadcrum do
+      %ol.breadcrumb
+        %li.breadcrumb-item
+          %a{:href => analysis_groups_path} Analysis Groups
+        %li.breadcrumb-item
+          %a{:href => analysis_group_path(@instance.analysis_group.id)}= @instance.analysis_group.name
+        %li.breadcrumb-item
+          %a{:href => "#"}= @instance.identifier
+
+    %h2 Summary
+
+    - if @instance.status != 'finished'
+      .text-warning
+        The system didn't finished to collect and process all the information.
+
+    = render partial: 'better_rails_debugger/group_instances/memory_summary'
+
+    =# render partial: 'better_rails_debugger/group_instances/method_summary'

data/app/views/better_rails_debugger/group_instances/tracer.html.haml

@@ -0,0 +1,38 @@
+.card
+  .card-header
+    = @instance.identifier
+    = "-"
+    = @instance.created_at.strftime("%c")
+  .card-body
+
+    - content_for :header_nav do
+      %ul.nav.navbar-nav.d-md-down-none
+        %li.nav-item
+          %a.nav-link.navbar-toggler.sidebar-toggler{:href => "#"} ☰
+        %li.nav-item.px-3
+          %a.nav-link{:href => group_instance_path(@instance)} List
+
+      %ul.navbar-nav.ml-md-auto
+
+
+    - content_for :breadcrum do
+      %ol.breadcrumb
+        %li.breadcrumb-item
+          %a{:href => analysis_groups_path} Analysis Groups
+        %li.breadcrumb-item
+          %a{:href => analysis_group_path(@instance.analysis_group.id)}= @instance.analysis_group.name
+        %li.breadcrumb-item
+          %a{:href => "#"}= @instance.identifier
+
+    %table.table.border.border-secondary.border-top-0
+      %thead.bg-secondary.text-white
+        %tr.d-flex
+          %th.col-8= order_link "Location", 'location', @instance
+          %th.col-2= order_link "Method", 'method', @instance
+          %th.col-2 Times
+      %tbody
+        - @instance.count_methods.each_pair do |location, hash|
+          %tr.d-flex
+            %td.col-8= location
+            %td.col-2= hash[:item].method_id
+            %td.col-2= hash[:count]

data/config/routes.rb

@@ -5,6 +5,7 @@ BetterRailsDebugger::Engine.routes.draw do
   resources :group_instances do
     member do
       get 'objects'
+      get 'tracer'
       get 'code'
     end
   end

data/lib/better_rails_debugger/{memory_analyzer.rb → analyzer.rb}

@@ -1,7 +1,7 @@
 require 'objspace'
 
 module BetterRailsDebugger
-  class MemoryAnalyzer
+  class Analyzer
     include Singleton
 
 
@@ -13,6 +13,7 @@ module BetterRailsDebugger
         yield
         return
       end
+      start_trace_point group
       # If we reached the max time to execute the code, just execute the code and do not collect information
       if times_to_run_exceeded?(group) or skip_instance?(group, identifier)
         yield
@@ -20,7 +21,28 @@ module BetterRailsDebugger
         ::ObjectSpace.trace_object_allocations do
           yield
         end
-        collect_information(identifier, group_id)
+      end
+      end_trace_point
+      collect_information(identifier, group_id)
+    end
+
+    def start_trace_point(group)
+      if group.generate_method_execution_history
+        @trace_point_history = []
+        tracer
+        tracer.enable
+      end
+    end
+
+    def end_trace_point
+      tracer.disable
+    end
+
+    def tracer
+      return @tracer if @tracer
+      @tracer = TracePoint.new do |tp|
+        # Record everything but us
+        @trace_point_history << {source_file: tp.path, source_line: tp.lineno, method_id: tp.method_id} if tp.path !~ /better_rails_debugger/
       end
     end
 
@@ -51,9 +73,10 @@ module BetterRailsDebugger
         Mongoid.logger.level = Logger::FATAL
       end
 
-      instance = ::BetterRailsDebugger::GroupInstance.create identifier: identifier, analysis_group_id: group_id, caller_file: caller[3][/[^:]+/]
+      instance = ::BetterRailsDebugger::GroupInstance.create identifier: identifier, analysis_group_id: group_id, caller_file: caller[3][/[^:]+/], status: 'pending'
 
       collect_memory_information(instance)
+      collect_trace_point_history(instance)
 
       # Now, it's time to analyze all collected data and generate a report
       ::BetterRailsDebugger::AnalysisRecorderJob.perform_later({ instance_id: instance.id.to_s })
@@ -91,6 +114,15 @@ module BetterRailsDebugger
       ::BetterRailsDebugger::ObjectInformation.collection.insert_many(objects)
     end
 
+    def collect_trace_point_history(instance)
+      return if !@trace_point_history.kind_of? Array
+      ::BetterRailsDebugger::TracePointItem.collection.insert_many(@trace_point_history.map do |item|
+            item[:group_instance_id] = instance.id
+            item
+      end)
+    end
+
+
     def all_valid_classes
       return @all_valid_classes if @all_valid_classes
       if !@all_classes

data/lib/better_rails_debugger/version.rb

@@ -1,3 +1,3 @@
 module BetterRailsDebugger
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/better_rails_debugger.rb

@@ -6,7 +6,7 @@ require "will_paginate-bootstrap4"
 require "font-awesome-rails"
 
 require "better_rails_debugger/config"
-require "better_rails_debugger/memory_analyzer"
+require "better_rails_debugger/analyzer"
 
 Haml.init_rails(binding)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better_rails_debugger
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Andres Jose Borek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-03 00:00:00.000000000 Z
+date: 2018-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -186,13 +186,18 @@ files:
 - app/models/better_rails_debugger/application_record.rb
 - app/models/better_rails_debugger/group_instance.rb
 - app/models/better_rails_debugger/object_information.rb
+- app/models/better_rails_debugger/trace_point_item.rb
 - app/views/better_rails_debugger/analysis_groups/_form.html.haml
 - app/views/better_rails_debugger/analysis_groups/edit.html.haml
 - app/views/better_rails_debugger/analysis_groups/index.html.haml
 - app/views/better_rails_debugger/analysis_groups/new.html.haml
 - app/views/better_rails_debugger/analysis_groups/show.html.haml
+- app/views/better_rails_debugger/group_instances/_memory_summary.html.haml
+- app/views/better_rails_debugger/group_instances/_method_summary.html.haml
 - app/views/better_rails_debugger/group_instances/_stats_summary.html.haml
 - app/views/better_rails_debugger/group_instances/objects.html.haml
+- app/views/better_rails_debugger/group_instances/show.html.haml
+- app/views/better_rails_debugger/group_instances/tracer.html.haml
 - app/views/better_rails_debugger/memory/index.html.haml
 - app/views/better_rails_debugger/memory/show.html.haml
 - app/views/better_rails_debugger/shared/_header.html.haml
@@ -202,9 +207,9 @@ files:
 - config/mongoid.yml
 - config/routes.rb
 - lib/better_rails_debugger.rb
+- lib/better_rails_debugger/analyzer.rb
 - lib/better_rails_debugger/config.rb
 - lib/better_rails_debugger/engine.rb
-- lib/better_rails_debugger/memory_analyzer.rb
 - lib/better_rails_debugger/version.rb
 - lib/tasks/better_rails_debugger_tasks.rake
 homepage: ''