awesome_explain 0.3.0 → 1.0.0

data/app/models/awesome_explain/sql_plan_node.rb

@@ -0,0 +1,73 @@
+class AwesomeExplain::SqlPlanNode
+  attr_accessor :id,
+    :parent,
+    :children,
+    :label,
+    :type,
+    :relation_name,
+    :join_type,
+    :startup_cost,
+    :total_cost,
+    :rows,
+    :width,
+    :actual_startup_time,
+    :actual_total_time,
+    :actual_rows,
+    :actual_loops,
+    :recheck_condition,
+    :index_name,
+    :index_condition,
+    :seq_scan,
+    :total_rows,
+    :total_loops
+
+  alias :seq_scan? :seq_scan
+
+  def initialize
+    @total_rows = 0
+    @total_loops = 0
+  end
+
+  def self.build(data, parent = nil)
+    instance = self.new
+    instance.label = data.dig('Node Type')
+    instance.type = data.dig('Node Type')
+    instance.relation_name = data.dig('Relation Name')
+    instance.startup_cost = data.dig('Startup Cost')
+    instance.total_cost = data.dig('Total Cost')
+    instance.rows = data.dig('Plan Rows')
+    instance.width = data.dig('Plan Width')
+    instance.actual_startup_time = data.dig('Actual Startup Time')
+    instance.actual_total_time = data.dig('Actual Total Time')
+    instance.actual_rows = data.dig('Actual Rows')
+    instance.actual_loops = data.dig('Actual Loops')
+    instance.recheck_condition = data.dig('Recheck Cond')
+    instance.index_name = data.dig('Index Name')
+    instance.index_condition = data.dig('Index Cond')
+    instance.seq_scan = data.dig('Node Type') == 'Seq Scan'
+    instance.parent = parent
+    instance.children = []
+    instance
+  end
+
+  def meta_data_str
+    meta_data.join('<hr />')
+  end
+
+  def meta_data
+    data = []
+    data << "<strong>Join Type:</strong> #{join_type}" if join_type.present?
+    data << "<strong>Rows:</strong> #{rows}" if rows.present?
+    data << "<strong>Width:</strong> #{width}" if width.present?
+    data << "<span #{seq_scan? ? 'class="bg-red-200 text-red-900 px-1 py-1 rounded-r"' : ''}><strong>Seq Scan:</strong> #{seq_scan?}</span>"
+    data << "<strong>Index Name</strong> #{index_name}" if index_name.present?
+    data << "<strong>Index Condition</strong> #{index_condition}" if index_condition.present?
+    data << "<strong>Actual Rows</strong> #{actual_rows}" if actual_rows.present?
+    data << "<strong>Actual Loops</strong> #{actual_loops}" if actual_loops.present?
+    data << "<strong>Startup Cost</strong> #{startup_cost}" if startup_cost.present?
+    data << "<strong>Total Cost</strong> #{total_cost}" if total_cost.present?
+    data << "<strong>Actual Startup Time</strong> #{actual_startup_time}" if actual_startup_time.present?
+    data << "<strong>Actual Total Time</strong> #{actual_total_time}" if actual_total_time.present?
+    data
+  end
+end

data/app/models/awesome_explain/sql_plan_stats.rb

@@ -0,0 +1,34 @@
+class AwesomeExplain::SqlPlanStats
+  attr_accessor :table_stats,
+    :node_type_stats,
+    :index_stats,
+    :total_rows_planned,
+    :total_rows,
+    :total_loops,
+    :actual_total_time,
+    :seq_scans
+
+  def initialize
+    @table_stats = {}
+    @node_type_stats = {}
+    @index_stats = {}
+    @total_rows_planned = 0
+    @total_rows = 0
+    @total_loops = 0
+    @actual_total_time = 0
+    @seq_scans = 0
+  end
+
+  def indexes?
+    !@index_stats.empty?
+  end
+
+  def to_hash
+    {
+      table_stats: @table_stats,
+      node_type_stats: @node_type_stats,
+      index_stats: @index_stats,
+    }
+  end
+  alias :to_h :to_hash
+end

data/app/models/awesome_explain/sql_plan_tree.rb

@@ -0,0 +1,133 @@
+class AwesomeExplain::SqlPlanTree
+  attr_accessor :root,
+    :ids,
+    :plans_count,
+    :seq_scan,
+    :seq_scans,
+    :startup_cost,
+    :total_cost,
+    :rows,
+    :width,
+    :actual_startup_time,
+    :actual_total_time,
+    :actual_rows,
+    :actual_loops,
+    :plan_stats
+
+  alias :seq_scan? :seq_scan
+
+  def initialize
+    @startup_cost = 0
+    @total_cost = 0
+    @rows = 0
+    @width = 0
+    @actual_startup_time = 0
+    @actual_total_time = 0
+    @actual_rows = 0
+    @actual_loops = 0
+    @seq_scans = 0
+    @plan_stats = ::AwesomeExplain::SqlPlanStats.new
+  end
+
+  def self.build(plan)
+    tree = self.new
+    tree.ids = (2..500).to_a # Ugh!!!
+    root = ::AwesomeExplain::SqlPlanNode.build(plan.first.dig('Plan'))
+    tree.root = root
+    tree.update_tree_stats(root)
+    root.id = 1
+    tree.plans_count = 1
+    build_recursive(plan.first.dig('Plan', 'Plans'), root, tree)
+    tree
+  end
+
+  def self.build_recursive(data, parent, tree)
+    return unless data.present?
+
+    if data.is_a?(Array)
+      data.each do |plan|
+        build_recursive(plan, parent, tree)
+      end
+    elsif data.is_a?(Hash) && data.dig('Plans').present?
+      node = ::AwesomeExplain::SqlPlanNode.build(data, parent)
+      node.id = tree.ids.shift
+      parent.children << node
+      tree.plans_count += 1
+      tree.seq_scans += 1 if node.seq_scan?
+      tree.update_tree_stats(node)
+      build_recursive(data.dig('Plans'), node, tree)
+    elsif data.is_a?(Hash) && data.dig('Plans').nil?
+      node = ::AwesomeExplain::SqlPlanNode.build(data, parent)
+      tree.update_tree_stats(node)
+      node.id = tree.ids.shift
+      tree.plans_count += 1
+      tree.seq_scans += 1 if node.seq_scan?
+      parent.children << node
+    end
+  end
+
+  def treeviz
+    return unless root.present?
+    output = []
+    queue = [root]
+    while(!queue.empty?) do
+      node = queue.shift
+      output << node.treeviz
+      node.children.each do |child|
+        queue << child
+      end
+    end
+
+    output
+  end
+
+  def update_tree_stats(node)
+    self.startup_cost += node.startup_cost
+    self.total_cost += node.total_cost
+    self.rows += node.rows
+    self.width += node.width
+    self.actual_startup_time += node.actual_startup_time
+    self.actual_total_time += node.actual_total_time
+    self.actual_rows += node.actual_rows
+    self.actual_loops += node.actual_loops
+
+    # Plan Stats
+    plan_stats.total_rows_planned += node.rows
+    plan_stats.total_rows += node.actual_rows
+    plan_stats.total_loops += node.actual_loops
+    plan_stats.seq_scans += 1 if node.seq_scan?
+
+    relation_name = node.relation_name
+    if relation_name
+      if plan_stats.table_stats.dig(relation_name).nil?
+        plan_stats.table_stats[relation_name] = {
+          count: 0,
+          time: 0
+        }
+      end
+      plan_stats.table_stats[relation_name][:count] += 1
+      plan_stats.table_stats[relation_name][:time] += node.actual_total_time
+    end
+
+
+    node_type = node.type
+    if node_type
+      if plan_stats.node_type_stats.dig(node_type).nil?
+        plan_stats.node_type_stats[node_type] = {
+          count: 0
+        }
+      end
+      plan_stats.node_type_stats[node_type][:count] += 1
+    end
+
+    index_name = node.index_name
+    if index_name
+      if plan_stats.index_stats.dig(index_name).nil?
+        plan_stats.index_stats[index_name] = {
+          count: 0
+        }
+        plan_stats.index_stats[index_name][:count] += 1
+      end
+    end
+  end
+end

data/app/models/awesome_explain/sql_query.rb

@@ -0,0 +1,7 @@
+class AwesomeExplain::SqlQuery < ActiveRecord::Base
+  establish_connection AwesomeExplain::Config.instance.db_config
+  self.table_name = 'sql_queries'
+
+  belongs_to :stacktrace
+  belongs_to :sql_explain
+end

data/app/models/awesome_explain/stacktrace.rb

@@ -0,0 +1,11 @@
+class AwesomeExplain::Stacktrace < ActiveRecord::Base
+  establish_connection AwesomeExplain::Config.instance.db_config
+  self.table_name = 'stacktraces'
+
+  has_many :logs
+  has_many :explains
+
+  def stacktrace
+    JSON.parse self['stacktrace']
+  end
+end

data/awesome_explain.gemspec

@@ -22,11 +22,22 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'awesome_print', '~> 1.0'
   spec.add_dependency 'terminal-table', '~> 1.0'
+  spec.add_dependency 'sqlite3'
+  spec.add_dependency 'rails', '>= 4.2'
+  spec.add_dependency 'kaminari', '>= 1.0'
+  spec.add_dependency 'activerecord-import', '>= 0.25'
+  spec.add_dependency 'niceql'
+  spec.add_dependency 'pg'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'wwtd'
+  spec.add_development_dependency 'binding_of_caller'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'pry-rails'
   spec.add_development_dependency 'mongoid', '>= 5'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'simplecov-console', '~> 0.4.2'
-  spec.add_development_dependency 'simplecov', '~> 0.16.1'
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'rspec', '>= 3.10'
+  spec.add_development_dependency 'simplecov', '>= 0.21.2'
+  spec.add_development_dependency 'simplecov-console', '>= 0.9.1'
 end

data/bin/rails

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/awesome_explain/engine', __dir__)
+APP_PATH = File.expand_path('../test/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/data/mongodb/customers.metadata.json

@@ -0,0 +1 @@
+{"options":{},"indexes":[{"v":2,"key":{"_id":1},"name":"_id_","ns":"OrderExample.customers"},{"v":2,"key":{"email":1.0},"name":"email_1","ns":"OrderExample.customers"}],"uuid":"290a27943cbe49c08136a6ef9602c089"}

data/data/mongodb/line_items.metadata.json

@@ -0,0 +1 @@
+{"options":{},"indexes":[{"v":2,"key":{"_id":1},"name":"_id_","ns":"OrderExample.line_items"},{"v":2,"key":{"orderId":1.0},"name":"orderId_1","ns":"OrderExample.line_items"},{"v":2,"key":{"prodId":1.0},"name":"prodId_1","ns":"OrderExample.line_items"}],"uuid":"77924a3990304623881e6b748abf20e7"}

data/data/mongodb/orders.metadata.json

@@ -0,0 +1 @@
+{"options":{},"indexes":[{"v":2,"key":{"_id":1},"name":"_id_","ns":"OrderExample.orders"},{"v":2,"key":{"customerId":1.0},"name":"customerId_1","ns":"OrderExample.orders"}],"uuid":"e4d9c8ca50ae48888c16a8906d7d97de"}

data/data/mongodb/products.metadata.json

@@ -0,0 +1 @@
+{"options":{},"indexes":[{"v":2,"key":{"_id":1},"name":"_id_","ns":"OrderExample.products"}],"uuid":"4067ccb6647b4f32aeeb239fbd4f6183"}

data/db/migrate/20200507214801_stacktraces.rb

@@ -0,0 +1,12 @@
+class Stacktraces < ActiveRecord::Migration[ActiveRecord.version.to_s.to_f]
+  def connection
+    ActiveRecord::Base.establish_connection(AwesomeExplain::Config.instance.db_config).connection
+  end
+
+  def change
+    create_table :stacktraces do |t|
+      t.column :stacktrace, :string
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200507214949_controllers.rb

@@ -0,0 +1,16 @@
+class Controllers < ActiveRecord::Migration[ActiveRecord.version.to_s.to_f]
+  def connection
+    ActiveRecord::Base.establish_connection(AwesomeExplain::Config.instance.db_config).connection
+  end
+
+  def change
+    create_table :controllers do |t|
+      t.column :name, :string
+      t.column :action, :string
+      t.column :path, :string
+      t.column :params, :string
+      t.column :session_id, :string
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200507215205_logs.rb

@@ -0,0 +1,22 @@
+class Logs < ActiveRecord::Migration[ActiveRecord.version.to_s.to_f]
+  def connection
+    ActiveRecord::Base.establish_connection(AwesomeExplain::Config.instance.db_config).connection
+  end
+
+  def change
+    create_table :logs do |t|
+      t.column :collection, :string
+      t.column :source_name, :string
+      t.column :operation, :string
+      t.column :collscan, :integer
+      t.column :command, :string
+      t.column :duration, :double
+      t.column :session_id, :string
+      t.column :lsid, :string
+      t.column :stacktrace_id, :integer
+      t.column :explain_id, :integer
+      t.column :controller_id, :integer
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200507215243_explains.rb

@@ -0,0 +1,27 @@
+class Explains < ActiveRecord::Migration[ActiveRecord.version.to_s.to_f]
+  def connection
+    ActiveRecord::Base.establish_connection(AwesomeExplain::Config.instance.db_config).connection
+  end
+
+  def change
+    create_table :explains do |t|
+      t.column :collection, :string
+      t.column :source_name, :string
+      t.column :command, :string
+      t.column :collscan, :integer
+      t.column :winning_plan, :string
+      t.column :winning_plan_raw, :string
+      t.column :used_indexes, :string
+      t.column :duration, :double
+      t.column :documents_returned, :integer
+      t.column :documents_examined, :integer
+      t.column :keys_examined, :integer
+      t.column :rejected_plans, :integer
+      t.column :session_id, :string
+      t.column :lsid, :string
+      t.column :stacktrace_id, :integer
+      t.column :controller_id, :integer
+      t.timestamps
+    end
+  end
+end

data/gemfiles/rails_4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.2"
+
+gemspec path: "../"

data/gemfiles/rails_4.gemfile.lock

@@ -0,0 +1,208 @@
+PATH
+  remote: ..
+  specs:
+    awesome_explain (1.0.0)
+      activerecord-import (>= 0.25)
+      awesome_print (~> 1.0)
+      kaminari (>= 1.0)
+      niceql
+      pg
+      rails (>= 4.2, <= 6.1)
+      sqlite3
+      terminal-table (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.0)
+      actionpack (= 4.2.0)
+      actionview (= 4.2.0)
+      activejob (= 4.2.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.0)
+      actionview (= 4.2.0)
+      activesupport (= 4.2.0)
+      rack (~> 1.6.0)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    actionview (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    activejob (4.2.0)
+      activesupport (= 4.2.0)
+      globalid (>= 0.3.0)
+    activemodel (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+    activerecord (4.2.0)
+      activemodel (= 4.2.0)
+      activesupport (= 4.2.0)
+      arel (~> 6.0)
+    activerecord-import (1.0.8)
+      activerecord (>= 3.2)
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ansi (1.5.0)
+    appraisal (2.4.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (6.0.4)
+    awesome_print (1.9.2)
+    binding_of_caller (1.0.0)
+      debug_inspector (>= 0.0.1)
+    bson (4.12.0)
+    builder (3.2.4)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    debug_inspector (1.0.0)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    erubis (2.7.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    json (1.8.6)
+    kaminari (1.2.1)
+      activesupport (>= 4.1.0)
+      kaminari-actionview (= 1.2.1)
+      kaminari-activerecord (= 1.2.1)
+      kaminari-core (= 1.2.1)
+    kaminari-actionview (1.2.1)
+      actionview
+      kaminari-core (= 1.2.1)
+    kaminari-activerecord (1.2.1)
+      activerecord
+      kaminari-core (= 1.2.1)
+    kaminari-core (1.2.1)
+    loofah (2.9.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    method_source (1.0.0)
+    mini_mime (1.0.2)
+    mini_portile2 (2.5.0)
+    minitest (5.14.4)
+    mongo (2.14.0)
+      bson (>= 4.8.2, < 5.0.0)
+    mongoid (5.4.1)
+      activemodel (~> 4.0)
+      mongo (>= 2.5.1, < 3.0.0)
+      origin (~> 2.3)
+      tzinfo (>= 0.3.37)
+    niceql (0.1.25)
+    nokogiri (1.11.2)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    origin (2.3.1)
+    pg (1.2.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    pry-rails (0.3.9)
+      pry (>= 0.10.4)
+    racc (1.5.2)
+    rack (1.6.13)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.0)
+      actionmailer (= 4.2.0)
+      actionpack (= 4.2.0)
+      actionview (= 4.2.0)
+      activejob (= 4.2.0)
+      activemodel (= 4.2.0)
+      activerecord (= 4.2.0)
+      activesupport (= 4.2.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.0)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.4)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.9)
+      activesupport (>= 4.2.0, < 5.0)
+      nokogiri (~> 1.6)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (4.2.0)
+      actionpack (= 4.2.0)
+      activesupport (= 4.2.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-console (0.9.1)
+      ansi
+      simplecov
+      terminal-table
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (1.1.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    wwtd (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  awesome_explain!
+  binding_of_caller
+  bundler
+  mongoid (>= 5)
+  pry-byebug
+  pry-rails
+  rails (= 4.2)
+  rake (>= 10.0)
+  rspec (>= 3.10)
+  simplecov (>= 0.21.2)
+  simplecov-console (>= 0.9.1)
+  wwtd
+
+BUNDLED WITH
+   1.17.3