pghero 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f906933d95e8d3370c8c5e0770bea23b496d3163
-  data.tar.gz: 26d9a09ea1d0a655ef91247c5d10eb01f63e4c92
+  metadata.gz: 924297f7d5d7f5ae69f7105d22752011a809c6e3
+  data.tar.gz: 8fcd272469562fd914aa9ad490a6cb1ba022ad56
 SHA512:
-  metadata.gz: 1967500ff522d67529f888cb03b47533fdf2ac4dcef9f316bf9ef3b135e6fdbc0c7edf9d47260f85547e818dd517e0daea5507601a07060ac3793eb4f28dfe2b
-  data.tar.gz: 9593a2e9a276fa692d6ea085313406cf5ca04c1b8ec50365137b807572bfdccdb6809d2098477b331a0ce28eec0ea44d8bc97887555747d94889faea9d3dacaa
+  metadata.gz: b83d39c5c5939966dfffbe4c0f6013a1f0830e8cf12821d9c46460a0ab8e55b82a0ba1273159a0c3c309d0259ae50060cb4538de4dddd0cf69918d1f8586f881
+  data.tar.gz: 2932ffba7ddd3545085858e3ec26a08a1d5c119a80fd8ee297ef947335128e0210ee5450b6d0345c23861d97978c6ec2408536629e19e4d4e82398f74b8e28fa

data/.gitignore

@@ -3,7 +3,7 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
+*.lock
 InstalledFiles
 _yardoc
 coverage

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.1.1
+
+- Added explain
+- Added query stats
+- Fixed CSS issues
+
 ## 0.1.0
 
 - First major release

data/README.md

@@ -4,13 +4,13 @@ Database insights made easy
 
 [View the demo](https://pghero.herokuapp.com/)
 
-![Screenshot](https://pghero.herokuapp.com/assets/screenshot-f7b70ae13b1f2ab0ea44ad005208c477.png)
+![Screenshot](https://pghero.herokuapp.com/assets/screenshot-57d07895ddb050f8dd46b98e73ef1415.png)
 
 Supports PostgreSQL 9.2+
 
 For pure SQL, check out [PgHero.sql](https://github.com/ankane/pghero.sql)
 
-Initial queries by [Heroku](https://blog.heroku.com/archives/2013/5/10/more_insight_into_your_database_with_pgextras) :clap:
+A big thanks to [Craig Kerstiens](http://www.craigkerstiens.com/2013/01/10/more-on-postgres-performance/) and [Heroku](https://blog.heroku.com/archives/2013/5/10/more_insight_into_your_database_with_pgextras) for the initial queries :clap:
 
 ## Installation
 
@@ -68,13 +68,15 @@ end
 
 ## TODO
 
-- better explanations on dashboard
+- show exactly which indexes to add
 - use `pg_stat_statements` extension for more detailed insights
-- poll for running queries
+- more detailed explanations on dashboard
+
+Know a bit about PostgreSQL? [Suggestions](https://github.com/ankane/pghero/issues) are greatly appreciated.
 
 ## Thanks
 
-Thanks to [Heroku](https://blog.heroku.com/archives/2013/5/10/more_insight_into_your_database_with_pgextras) for the initial queries and [Bootswatch](https://github.com/thomaspark/bootswatch) for the theme.
+Thanks to [Craig Kerstiens](http://www.craigkerstiens.com/2013/01/10/more-on-postgres-performance/) and [Heroku](https://blog.heroku.com/archives/2013/5/10/more_insight_into_your_database_with_pgextras) for the initial queries and [Bootswatch](https://github.com/thomaspark/bootswatch) for the theme.
 
 ## History
 

data/Rakefile

@@ -1,2 +1,8 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
 
+task :default => :test
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end

data/app/controllers/pg_hero/home_controller.rb

@@ -6,14 +6,19 @@ module PgHero
 
     http_basic_authenticate_with name: ENV["PGHERO_USERNAME"], password: ENV["PGHERO_PASSWORD"] if ENV["PGHERO_PASSWORD"]
 
+    before_filter :set_query_stats_enabled
+
     def index
       @title = "Status"
+      @slow_queries = PgHero.slow_queries
       @long_running_queries = PgHero.long_running_queries
       @index_hit_rate = PgHero.index_hit_rate
       @table_hit_rate = PgHero.table_hit_rate
       @missing_indexes = PgHero.missing_indexes
       @unused_indexes = PgHero.unused_indexes
       @good_cache_rate = @table_hit_rate >= 0.99 && @index_hit_rate >= 0.99
+      @query_stats_available = PgHero.query_stats_available?
+      @rds = PgHero.rds?
     end
 
     def indexes
@@ -32,6 +37,25 @@ module PgHero
       @running_queries = PgHero.running_queries
     end
 
+    def query_stats
+      @title = "Query Stats"
+      @query_stats = PgHero.query_stats
+    end
+
+    def explain
+      @title = "Explain"
+      @query = params[:query]
+      # TODO use get + token instead of post so users can share links
+      # need to prevent CSRF and DoS
+      if request.post? and @query
+        begin
+          @explanation = PgHero.explain(@query)
+        rescue ActiveRecord::StatementInvalid => e
+          @error = e.message
+        end
+      end
+    end
+
     def kill
       if PgHero.kill(params[:pid])
         redirect_to root_path, notice: "Query killed"
@@ -45,5 +69,29 @@ module PgHero
       redirect_to :back, notice: "Connections killed"
     end
 
+    def enable_query_stats
+      begin
+        PgHero.enable_query_stats
+        redirect_to :back, notice: "Query stats enabled"
+      rescue ActiveRecord::StatementInvalid => e
+        redirect_to :back, alert: "The database user does not have permission to enable query stats"
+      end
+    end
+
+    def reset_query_stats
+      begin
+        PgHero.reset_query_stats
+        redirect_to :back, notice: "Query stats reset"
+      rescue ActiveRecord::StatementInvalid => e
+        redirect_to :back, alert: "The database user does not have permission to reset query stats"
+      end
+    end
+
+    protected
+
+    def set_query_stats_enabled
+      @query_stats_enabled = PgHero.query_stats_enabled?
+    end
+
   end
 end

data/app/views/layouts/pg_hero/application.html.erb

@@ -7,13 +7,16 @@
 
     <style>
       body {
-        font-family: "Helvetica Neue", Arial, Helvetica, sans-serif;
         margin: 0;
         padding: 20px;
+        background-color: #2b3e50;
+      }
+
+      body, textarea {
+        font-family: "Helvetica Neue", Arial, Helvetica, sans-serif;
         font-size: 14px;
         line-height: 1.4;
         color: #333;
-        background-color: #2b3e50;
       }
 
       a, a:visited, a:active {
@@ -67,6 +70,13 @@
         white-space: pre-wrap;
       }
 
+      textarea {
+        width: 100%;
+        height: 80px;
+        border: solid 1px #ccc;
+        padding: 10px;
+      }
+
       .container {
         max-width: 1000px;
         margin-left: auto;
@@ -124,6 +134,8 @@
         cursor: pointer;
         outline: none;
         margin: 0;
+        -webkit-appearance: none;
+        -webkit-border-radius: 0;
       }
 
       .btn-danger {
@@ -153,6 +165,10 @@
         background-color: #f0ad4e;
       }
 
+      .alert-danger {
+        background-color: #df691a;
+      }
+
       .alert a {
         color: #fff;
         text-decoration: none;
@@ -312,8 +328,10 @@
   </head>
   <body>
     <div class="container">
-      <div class="alert alert-info">
-        <% if notice %>
+      <div class="alert alert-<%= alert ? "danger" : "info" %>">
+        <% if alert %>
+          <%= alert %>
+        <% elsif notice %>
           <%= notice %>
         <% elsif Rails.env.development? %>
           Do not use development information to make decisions about your production environment
@@ -327,9 +345,13 @@
           <ul class="nav">
             <!-- poor man's active_link_to -->
             <li class="<%= controller.action_name == "index" ? "active" : "" %>"><%= link_to "Status", root_path %></li>
+            <% if @query_stats_enabled %>
+              <li class="<%= controller.action_name == "query_stats" ? "active" : "" %>"><%= link_to "Queries", query_stats_path %></li>
+            <% end %>
             <li class="<%= controller.action_name == "indexes" ? "active" : "" %>"><%= link_to "Indexes", indexes_path %></li>
             <li class="<%= controller.action_name == "space" ? "active" : "" %>"><%= link_to "Space", space_path %></li>
-            <li class="<%= controller.action_name == "queries" ? "active" : "" %>"><%= link_to "Queries", queries_path %></li>
+            <li class="<%= controller.action_name == "explain" ? "active" : "" %>"><%= link_to "Explain", explain_path %></li>
+            <li class="<%= controller.action_name == "queries" ? "active" : "" %>"><%= link_to "Live Queries", queries_path %></li>
           </ul>
         </div>
 

data/app/views/pg_hero/home/_query_stats_table.html.erb

@@ -0,0 +1,21 @@
+<table class="table">
+  <thead>
+    <tr>
+      <th style="width: 33.33%;">Total Time</th>
+      <th style="width: 33.33%;">Average Time</th>
+      <th style="width: 33.33%;">Calls</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% queries.each do |query| %>
+      <tr>
+        <td><%= query["total_minutes"].to_f.round %> min</td>
+        <td><%= query["average_time"].to_f.round %> ms</td>
+        <td><% calls = query["calls"].to_i %><%= calls >= 1000 ? number_with_delimiter(calls.round) + "k" : calls %></td>
+      </tr>
+      <tr>
+        <td colspan="3" style="border-top: none; padding: 0;"><pre><%= query["query"] %></pre></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/pg_hero/home/explain.html.erb

@@ -0,0 +1,15 @@
+<div class="content">
+  <h1>Explain</h1>
+
+  <%= form_tag explain_path do %>
+    <%= text_area_tag :query, @query, placeholder: "Enter a SQL query" %>
+    <p><%= submit_tag "Explain", class: "btn btn-info" %></p>
+  <% end %>
+
+  <% if @explanation %>
+    <pre><%= @explanation %></pre>
+    <p><%= link_to "See how to interpret this", "http://www.postgresql.org/docs/current/static/using-explain.html", target: "_blank" %></p>
+  <% elsif @error %>
+    <div class="alert alert-danger"><%= @error %></div>
+  <% end %>
+</div>

data/app/views/pg_hero/home/index.html.erb

@@ -1,4 +1,20 @@
 <div id="status">
+  <div class="alert alert-<%= @query_stats_enabled ? "success" : "warning" %>">
+    <% if @query_stats_enabled %>
+      Query stats are enabled
+    <% else %>
+      Query stats are not enabled
+    <% end %>
+  </div>
+  <div class="alert alert-<%= @query_stats_enabled && @slow_queries.empty? ? "success" : "warning" %>">
+    <% if !@query_stats_enabled %>
+      Query stats must be enabled for slow queries
+    <% elsif @slow_queries.any? %>
+      <%= pluralize(@slow_queries.size, "slow query") %>
+    <% else %>
+      No slow queries
+    <% end %>
+  </div>
   <div class="alert alert-<%= @long_running_queries.empty? ? "success" : "warning" %>">
     <% if @long_running_queries.any? %>
       <%= pluralize(@long_running_queries.size, "long running query") %>
@@ -29,6 +45,37 @@
   </div>
 </div>
 
+<% if !@query_stats_enabled %>
+  <div class="content">
+    <h1>Query Statistics</h1>
+
+    <% if @query_stats_available %>
+      <p>
+        Query statistics are available but not enabled.
+        <%= button_to "Enable", enable_query_stats_path, class: "btn btn-info" %>
+      </p>
+    <% elsif @rds %>
+      <p>Query statistics are not available on Amazon RDS. <%= link_to "Tell Amazon you want this.", "https://forums.aws.amazon.com/thread.jspa?messageID=548724", target: "_blank" %></p>
+    <% else %>
+      <p>Make them available by adding the following lines to <code>postgresql.conf</code>:</p>
+      <pre>shared_preload_libraries = 'pg_stat_statements'
+pg_stat_statements.track = all</pre>
+      <p>Restart the server for the changes to take effect.</p>
+    <% end %>
+  </div>
+<% end %>
+
+<% if @query_stats_enabled && @slow_queries.any? %>
+  <div class="content">
+    <h1>Slow Queries</h1>
+
+    <p>Slow queries take 20 ms or more on average and have been called at least 100 times.</p>
+    <p><%= link_to "Run EXPLAIN", explain_path %> on queries to see where to add indexes.</p>
+
+    <%= render partial: "query_stats_table", locals: {queries: @slow_queries} %>
+  </div>
+<% end %>
+
 <% if @long_running_queries.any? %>
   <div class="content">
     <h1>Long Running Queries</h1>

data/app/views/pg_hero/home/queries.html.erb

@@ -1,5 +1,5 @@
 <div class="content">
-  <h1>Queries</h1>
+  <h1>Live Queries</h1>
 
   <%= render partial: "queries_table", locals: {queries: @running_queries} %>
 

data/app/views/pg_hero/home/query_stats.html.erb

@@ -0,0 +1,17 @@
+<div class="content">
+  <% if @query_stats_enabled %>
+    <%= button_to "Reset", reset_query_stats_path, class: "btn btn-danger", style: "float: right;" %>
+  <% end %>
+
+  <h1>Queries</h1>
+
+  <% if @query_stats_enabled %>
+    <% if @query_stats.any? %>
+      <%= render partial: "query_stats_table", locals: {queries: @query_stats} %>
+    <% else %>
+      <p>Stats are not available yet. Come back soon!</p>
+    <% end %>
+  <% else %>
+    <p>Query stats are not enabled.</p>
+  <% end %>
+</div>

data/config/routes.rb

@@ -3,7 +3,12 @@ PgHero::Engine.routes.draw do
   get "indexes", to: "home#indexes"
   get "space", to: "home#space"
   get "queries", to: "home#queries"
+  get "query_stats", to: "home#query_stats"
+  get "explain", to: "home#explain"
 
   post "kill", to: "home#kill"
   post "kill_all", to: "home#kill_all"
+  post "enable_query_stats", to: "home#enable_query_stats"
+  post "explain", to: "home#explain"
+  post "reset_query_stats", to: "home#reset_query_stats"
 end

data/gemfiles/activerecord31.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in searchkick.gemspec
+gemspec path: "../"
+
+gem "activerecord", "~> 3.1.0"

data/gemfiles/activerecord32.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in searchkick.gemspec
+gemspec path: "../"
+
+gem "activerecord", "~> 3.2.0"

data/gemfiles/activerecord40.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in searchkick.gemspec
+gemspec path: "../"
+
+gem "activerecord", "~> 4.0.0"

data/lib/pghero.rb

@@ -1,4 +1,5 @@
 require "pghero/version"
+require "active_record"
 require "pghero/engine" if defined?(Rails)
 
 module PgHero
@@ -169,7 +170,7 @@ module PgHero
     end
 
     def kill(pid)
-      connection.execute("SELECT pg_cancel_backend(#{pid.to_i})").first["pg_cancel_backend"] == "t"
+      execute("SELECT pg_cancel_backend(#{pid.to_i})").first["pg_cancel_backend"] == "t"
     end
 
     def kill_all
@@ -185,14 +186,137 @@ module PgHero
       true
     end
 
+    # http://www.craigkerstiens.com/2013/01/10/more-on-postgres-performance/
+    def query_stats
+      if query_stats_enabled?
+        select_all %Q{
+          SELECT
+            query,
+            (total_time / 1000 / 60) as total_minutes,
+            (total_time / calls) as average_time,
+            calls
+          FROM
+            pg_stat_statements
+          INNER JOIN
+            pg_database ON pg_database.oid = pg_stat_statements.dbid
+          WHERE
+            pg_database.datname = current_database()
+          ORDER BY
+            total_minutes DESC
+          LIMIT 100
+        }
+      else
+        []
+      end
+    end
+
+    def slow_queries
+      if query_stats_enabled?
+        select_all %Q{
+          SELECT
+            query,
+            (total_time / 1000 / 60) as total_minutes,
+            (total_time / calls) as average_time,
+            calls
+          FROM
+            pg_stat_statements
+          INNER JOIN
+            pg_database ON pg_database.oid = pg_stat_statements.dbid
+          WHERE
+            pg_database.datname = current_database()
+            AND calls >= 100
+            AND (total_time / calls) >= 20
+          ORDER BY
+            total_minutes DESC
+          LIMIT 100
+        }
+      else
+        []
+      end
+    end
+
+    def query_stats_available?
+      select_all("SELECT COUNT(*) AS count FROM pg_available_extensions WHERE name = 'pg_stat_statements'").first["count"].to_i > 0
+    end
+
+    def query_stats_enabled?
+      select_all("SELECT COUNT(*) AS count FROM pg_extension WHERE extname = 'pg_stat_statements'").first["count"].to_i > 0 && query_stats_readable?
+    end
+
+    def query_stats_readable?
+      begin
+        # ensure the user has access to the table
+        select_all("SELECT has_table_privilege(current_user, 'pg_stat_statements', 'SELECT')").first["has_table_privilege"] == "t"
+      rescue ActiveRecord::StatementInvalid
+        false
+      end
+    end
+
+    def enable_query_stats
+      execute("CREATE EXTENSION pg_stat_statements")
+    end
+
+    def disable_query_stats
+      execute("DROP EXTENSION IF EXISTS pg_stat_statements")
+      true
+    end
+
+    def reset_query_stats
+      if query_stats_enabled?
+        execute("SELECT pg_stat_statements_reset()")
+        true
+      else
+        false
+      end
+    end
+
+    def rds?
+      !!(Connection.connection_config[:host].to_s =~ /rds\.amazonaws\.com\z/)
+    end
+
+    def explain(sql)
+      sql = squish(sql)
+      explanation = nil
+      explain_safe = explain_safe?
+
+      # use transaction for safety
+      Connection.transaction do
+        if !explain_safe and (sql.sub(/;\z/, "").include?(";") or sql.upcase.include?("COMMIT"))
+          raise ActiveRecord::StatementInvalid, "Unsafe statement"
+        end
+        explanation = select_all("EXPLAIN #{sql}").map{|v| v["QUERY PLAN"] }.join("\n")
+        raise ActiveRecord::Rollback
+      end
+
+      explanation
+    end
+
+    def explain_safe?
+      begin
+        select_all("SELECT 1; SELECT 1")
+        false
+      rescue ActiveRecord::StatementInvalid
+        true
+      end
+    end
+
     def select_all(sql)
       # squish for logs
-      connection.select_all(sql.squish).to_a
+      connection.select_all(squish(sql)).to_a
+    end
+
+    def execute(sql)
+      connection.execute(sql)
     end
 
     def connection
       @connection ||= Connection.connection
     end
 
+    # from ActiveSupport
+    def squish(str)
+      str.to_s.gsub(/\A[[:space:]]+/, '').gsub(/[[:space:]]+\z/, '').gsub(/[[:space:]]+/, ' ')
+    end
+
   end
 end

data/lib/pghero/version.rb

@@ -1,3 +1,3 @@
 module PgHero
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/pghero.gemspec

@@ -18,6 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "pg"
+  spec.add_dependency "activerecord"
+
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
 end

data/test/pghero_test.rb

@@ -0,0 +1,20 @@
+require_relative "test_helper"
+
+class TestPgHero < Minitest::Test
+
+  def setup
+    User.delete_all
+  end
+
+  def test_explain
+    User.create!
+    PgHero.explain("ANALYZE DELETE FROM users")
+    assert_equal 1, User.count
+  end
+
+  def test_explain_multiple_statements
+    User.create!
+    assert_raises(ActiveRecord::StatementInvalid){ PgHero.explain("ANALYZE DELETE FROM users; DELETE FROM users; COMMIT") }
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require "bundler/setup"
+Bundler.require(:default)
+require "minitest/autorun"
+require "minitest/pride"
+
+# for Minitest < 5
+Minitest::Test = MiniTest::Unit::TestCase unless defined?(Minitest::Test)
+
+ActiveRecord::Base.establish_connection adapter: "postgresql", database: "pghero_test"
+
+ActiveRecord::Migration.create_table :users, force: true do |t|
+  # just id
+end
+
+class User < ActiveRecord::Base
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: pghero
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-23 00:00:00.000000000 Z
+date: 2014-08-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Database insights made easy
 email:
 - andrew@chartkick.com
@@ -54,15 +96,23 @@ files:
 - app/controllers/pg_hero/home_controller.rb
 - app/views/layouts/pg_hero/application.html.erb
 - app/views/pg_hero/home/_queries_table.html.erb
+- app/views/pg_hero/home/_query_stats_table.html.erb
+- app/views/pg_hero/home/explain.html.erb
 - app/views/pg_hero/home/index.html.erb
 - app/views/pg_hero/home/indexes.html.erb
 - app/views/pg_hero/home/queries.html.erb
+- app/views/pg_hero/home/query_stats.html.erb
 - app/views/pg_hero/home/space.html.erb
 - config/routes.rb
+- gemfiles/activerecord31.gemfile
+- gemfiles/activerecord32.gemfile
+- gemfiles/activerecord40.gemfile
 - lib/pghero.rb
 - lib/pghero/engine.rb
 - lib/pghero/version.rb
 - pghero.gemspec
+- test/pghero_test.rb
+- test/test_helper.rb
 homepage: https://github.com/ankane/pghero
 licenses:
 - MIT
@@ -87,5 +137,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Database insights made easy
-test_files: []
+test_files:
+- test/pghero_test.rb
+- test/test_helper.rb
 has_rdoc: