sql_event_analyzer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45ac7d368d025a8cd7154de382c68bf224dace83
+  data.tar.gz: 42693e5aa757fd57011981b9fd9952fbf8a203a3
+SHA512:
+  metadata.gz: eb16c5c8c7b0910d0ea2efa5339f68db70cd5e4f9d1aa57824eec036eafe8b0b1cb1c03776bc4b5ff13632441c2154d3468bb8ad068d43c0f3806992e02c0a3a
+  data.tar.gz: 579efba8137ab510de74af37106d6ae01fa88d6ada22c37c7b1ac31737f29cf1be243ddecc1e7b8020cb816bae9e65ab75ce5c5e69c9e484a8701e751d1e9f34

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 2.2

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sql_event_analyzer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Scott Pierce
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# Overview
+
+Consume Rails SQL events and generates an HTML overview for the SQL utilization.
+
+## Usage
+
+### Around any calls
+```ruby
+SqlEventAnalyzer.start(name: 'report1') do
+  # Some code that does a lot of SQL
+end
+```
+
+### View the Results
+
+A directory will be created at the root of the project directry from which Rails
+is running. All results are contained there as HTML files. Open them in your
+web browser.
+
+```sh
+find tmp/sql_event_analyzer/
+open tmp/sql_event_analyzer/report1.html
+```
+
+### Around a Rails Controller
+```ruby
+class ApplicationController < ActionController::Base
+
+  # @see http://guides.rubyonrails.org/action_controller_overview.html#after-filters-and-around-filters
+  around_action :capture_sql_filter
+
+  def capture_sql_filter(&block)
+    stats_file_name = "#{params[:controller]}-#{params[:action]}"
+    SqlEventAnalyzer.start(name: stats_file_name, &block)
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sql_event_analyzer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sql_event_analyzer
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ddrscott/sql_event_analyzer.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sql_event_analyzer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sql_event_analyzer/version.rb

@@ -0,0 +1,3 @@
+class SqlEventAnalyzer
+  VERSION = '0.1.0'.freeze
+end

data/lib/sql_event_analyzer.erb

@@ -0,0 +1,55 @@
+<html>
+  <head>
+    <link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/ace/1.2.6/ace.js" integrity="sha256-xrr4HH5eSY+cFz4SH7ja/LaAi9qcEdjMpeMP49/iOLs=" crossorigin="anonymous"></script>
+    <style>
+      textarea {
+        width: 70em;
+        font-family: monospace;
+        font-size: .8em;
+        height: 15em;
+        overflow-x: hidden;
+      }
+    </style>
+  </head>
+  <body>
+    <h2>Overall</h2>
+    <div class="row">
+      <div class="col-sm-6">
+      <table class="table table-condensed">
+        <tr>
+          <th>uniq callers</th>
+          <th>total calls</th>
+          <th>total millis</th>
+        </tr>
+        <tr>
+          <td><%= stats.size %></td>
+          <td><%= stats.values.inject(0){|agg, r| r[:count] + agg } %> </td>
+          <td><%= stats.values.inject(0){|agg, r| r[:duration] + agg }.round %> </td>
+        </tr>
+      </table>
+      </div>
+    </div>
+    <h2>Details</h2>
+    <table class="table table-condensed">
+      <tr>
+        <th>order</th>
+        <th>calls</th>
+        <th>millis</th>
+        <th>SQL</th>
+        <th>Explain</th>
+        <th>caller</th>
+      </tr>
+      <% stats.each do |k, stat| %>
+        <tr>
+          <td><%= stat[:order] %></td>
+          <td><%= stat[:count] %></td>
+          <td><%= stat[:duration].round %></td>
+          <td><textarea><%= debug_rb(k.first) %><%= pretty_sql(stat[:payload][:sql]) %></textarea></td>
+          <td><textarea><%= explain(stat[:payload]) %></textarea></td>
+          <td><textarea><%= k.map{|m| trim_caller(m)}.join("\\n") %></textarea></td>
+        </tr>
+      <% end %>
+    </table>
+  </body>
+</html>

data/lib/sql_event_analyzer.rb

@@ -0,0 +1,102 @@
+require 'sql_event_analyzer/version'
+require 'active_support/notifications'
+require 'active_record'
+
+# Captures Rails SQL events and crunches some statistics
+class SqlEventAnalyzer
+
+  attr_reader :stats, :name
+
+  # captures the events and writes out the result
+  # @return [File] file containing html output
+  def self.start(name: Time.current)
+    instance = SqlEventAnalyzer.new(name: name)
+
+    subscription_name = ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
+      event = ActiveSupport::Notifications::Event.new(*args)
+      instance.process_event(event)
+    end
+
+    if block_given?
+      begin
+        yield
+      ensure
+        ActiveSupport::Notifications.unsubscribe(subscription_name)
+      end
+      write_html(instance)
+    end
+  end
+
+  def self.write_html(instance)
+    output_dir = 'tmp/sql_event_analyzer'
+    output_path = File.join(output_dir, "#{instance.name}.html")
+    FileUtils.mkdir_p(output_dir)
+    html = instance.render_as_html
+    File.open(output_path, 'w') {|f| f << html}
+  end
+
+  def initialize(name:)
+    @name = name
+    @root = Rails.root.to_s
+    @stats = {}
+  end
+
+  # @param [ActiveSupport::Notifications::Event] SQL event from Rails
+  def process_event(event)
+    # Callers from Rails root and not the subscriber itself
+    backtrace = caller.select{|line| relevent_caller?(line) }
+
+    # Initialize a uniq SQL use.
+    # `:payload` will always be the first instance of the call.
+    stat = @stats[backtrace] ||= {
+      order: @stats.size,
+      count: 0,
+      duration: 0,
+      payload: event.payload
+    }
+
+    # increment stats
+    stat[:count] += 1
+    stat[:duration] += event.duration
+  end
+
+  def render_as_html
+    ERB.new(erb_template).result(binding)
+  end
+
+  private
+
+  def relevent_caller?(c)
+    c.start_with?(@root) && !c.start_with?(__FILE__)
+  end
+
+  def pretty_sql(sql)
+    sql
+      .delete('"')
+      .gsub(/\b+(SELECT|FROM|WHERE|GROUP|HAVING|LEFT JOIN|LEFT OUTER JOIN|INNER JOIN|JOIN|RIGHT|ORDER|WINDOW)\b+/, "\n\\1")
+  end
+
+  def explain(payload)
+    ActiveRecord::Base.connection.explain(payload[:sql], payload[:binds])
+  end
+
+  def erb_template
+    File.read(File.join(__dir__, 'sql_event_analyzer.erb'))
+  end
+
+  def trim_caller(c)
+    c.gsub(@root, '.')
+  end
+
+  def debug_rb(c)
+    first = trim_caller(c)
+    file, line = if first =~ /(.*\.rb):(\d+)/
+                   [$1, $2]
+                 end
+    rb_src = File.readlines(file)[line.to_i - 1].strip
+    <<-EOF.strip_heredoc
+    -- #{first}
+    --     #{rb_src}
+    EOF
+  end
+end

data/sql_event_analyzer.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sql_event_analyzer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sql_event_analyzer'
+  spec.version       = SqlEventAnalyzer::VERSION
+  spec.authors       = ['Scott Pierce']
+  spec.email         = ['ddrscott@gmail.com']
+
+  spec.summary       = 'SQL events collector and statistics generator'
+  spec.homepage      = 'https://github.com/ddrscott/sql_event_analyzer'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_dependency 'rails', '>= 4.0'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: sql_event_analyzer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Scott Pierce
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 
+email:
+- ddrscott@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sql_event_analyzer.erb
+- lib/sql_event_analyzer.rb
+- lib/sql_event_analyzer/version.rb
+- sql_event_analyzer.gemspec
+homepage: https://github.com/ddrscott/sql_event_analyzer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: SQL events collector and statistics generator
+test_files: []