pghero 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f98183aaa8abc79d3692c7a697fdbdacce963db5
+  data.tar.gz: a475c402a6e8e22ae5cb56aeab69ded88cec46e7
+SHA512:
+  metadata.gz: 1754f5562b4479fca325777469b3fb1c5f393616b29644c8158d89e0640bc3ccf3c3bf7ba7eeca8f81e720c6b7e44d226be65d25c9432d8b2f0ca61fc791da83
+  data.tar.gz: ebd54924ec01f64d71d3e37d0e6558d77838aa44b5a25b324186d5b02e8965cb557449253dd1f32facee0c71f3f771e351923f73f9ee8870a99472fa8a6b2aa8

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Kane, 2008-2014 Heroku (initial queries)
+
+MIT License
+
+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,78 @@
+# PgHero
+
+:tada: Database insights made easy
+
+Supports PostgreSQL 9.2+
+
+For pure SQL, check out [PgHero.sql](https://github.com/ankane/pghero.sql)
+
+:clap: Initial queries and inspiration by [Heroku](https://blog.heroku.com/archives/2013/5/10/more_insight_into_your_database_with_pgextras)
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'pghero'
+```
+
+And mount the dashboard in your router.
+
+```ruby
+mount PgHero::Engine, at: "pghero"
+```
+
+Be sure to [protect the dashboard](#security) in production.
+
+## Insights
+
+```ruby
+PgHero.running_queries
+PgHero.long_running_queries
+PgHero.index_usage
+PgHero.missing_indexes
+PgHero.unused_indexes
+PgHero.relation_sizes
+PgHero.index_hit_rate
+PgHero.table_hit_rate
+
+# kill queries
+PgHero.kill(pid)
+PgHero.kill_all
+```
+
+## Security
+
+#### Basic Authentication
+
+Set the following variables in your environment or an initializer.
+
+```ruby
+ENV["PGHERO_USERNAME"] = "andrew"
+ENV["PGHERO_PASSWORD"] = "secret"
+```
+
+#### Devise
+
+```ruby
+authenticate :user, lambda {|user| user.admin? } do
+  mount PgHero::Engine, at: "pghero"
+end
+```
+
+## TODO
+
+- demo
+- better explanations on dashboard
+- more space metrics
+- poll for running queries
+- better design (no bootstrap)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/pghero/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/pghero/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/app/controllers/pg_hero/home_controller.rb

@@ -0,0 +1,48 @@
+module PgHero
+  class HomeController < ActionController::Base
+    layout "pg_hero/application"
+
+    protect_from_forgery
+
+    http_basic_authenticate_with name: ENV["PGHERO_USERNAME"], password: ENV["PGHERO_PASSWORD"] if ENV["PGHERO_PASSWORD"]
+
+    def index
+      @title = "Status"
+      @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
+    end
+
+    def indexes
+      @title = "Indexes"
+      @index_usage = PgHero.index_usage
+    end
+
+    def space
+      @title = "Space"
+      @relation_sizes = PgHero.relation_sizes
+    end
+
+    def queries
+      @title = "Queries"
+      @running_queries = PgHero.running_queries
+    end
+
+    def kill
+      if PgHero.kill(params[:pid])
+        redirect_to root_path, notice: "Query killed"
+      else
+        redirect_to :back, notice: "Query no longer running"
+      end
+    end
+
+    def kill_all
+      PgHero.kill_all
+      redirect_to :back, notice: "Connections killed"
+    end
+
+  end
+end

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

@@ -0,0 +1,73 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= @title %> - PgHero</title>
+
+    <meta charset="utf-8" />
+
+    <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
+
+    <style>
+      body {
+        padding-top: 20px;
+      }
+
+      h1 {
+        margin-top: 6px;
+        font-size: 20px;
+      }
+
+      h1, p {
+        margin-bottom: 20px;
+      }
+
+      .container {
+        max-width: 1000px;
+      }
+
+      #status {
+        margin-bottom: 20px;
+      }
+
+      #status div {
+        margin-bottom: 0;
+        border: none;
+        border-radius: 0;
+      }
+
+      .alert {
+        padding-top: 12px;
+        padding-bottom: 12px;
+      }
+
+      .queries > tbody > tr > td {
+        vertical-align: middle;
+      }
+    </style>
+  </head>
+  <body>
+    <div class="container">
+      <% if notice %>
+        <div class="alert alert-info"><%= notice %></div>
+      <% elsif Rails.env.development? %>
+        <div class="alert alert-info">Do not use development information to make decisions about your production environment</div>
+      <% end %>
+
+      <div class="row">
+        <div class="col-xs-3">
+          <ul class="nav nav-pills nav-stacked">
+            <!-- poor man's active_link_to -->
+            <li class="<%= controller.action_name == "index" ? "active" : "" %>"><%= link_to "Status", root_path %></li>
+            <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>
+          </ul>
+        </div>
+
+        <div class="col-xs-9">
+          <%= yield %>
+        </div>
+      </div>
+    </div>
+  </body>
+</html>

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

@@ -0,0 +1,27 @@
+<table class="table queries">
+  <thead>
+    <tr>
+      <th style="width: 10%;">Pid</th>
+      <th style="width: 10%;">State</th>
+      <th>Source</th>
+      <th style="width: 10%;">Waiting</th>
+      <th style="width: 15%;">Duration</th>
+      <th style="width: 10%;"></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% queries.each do |query| %>
+      <tr>
+        <td><%= query["pid"] %></td>
+        <td><%= query["state"] %></td>
+        <td><%= query["source"] %></td>
+        <td><%= query["waiting"] == "t" ? "true" : "false" %></td>
+        <td><%= query["duration"] %></td>
+        <td class="text-right"><%= button_to "Kill", kill_path(pid: query["pid"]), class: "btn btn-info" %></td>
+      </tr>
+      <tr>
+        <td colspan="6" style="border-top: none; padding-top: 0;"><pre><%= query["query"] %></pre></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

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

@@ -0,0 +1,101 @@
+<div id="status">
+  <div class="alert alert-<%= @long_running_queries.empty? ? "success" : "warning" %>">
+    <% if @long_running_queries.any? %>
+      <%= pluralize(@long_running_queries.size, "long running query") %>
+    <% else %>
+      No long running queries
+    <% end %>
+  </div>
+  <div class="alert alert-<%= @good_cache_rate ? "success" : "warning" %>">
+    <% if @good_cache_rate %>
+      Cache hit rate above 99%
+    <% else %>
+      Cache hit rate under 99%
+    <% end %>
+  </div>
+  <div class="alert alert-<%= @missing_indexes.empty? ? "success" : "warning" %>">
+    <% if @missing_indexes.any? %>
+      <%= pluralize(@missing_indexes.size, "possibly missing indexes") %>
+    <% else %>
+      No missing indexes
+    <% end %>
+  </div>
+  <div class="alert alert-<%= @unused_indexes.empty? ? "success" : "warning" %>">
+    <% if @unused_indexes.any? %>
+      <%= pluralize(@unused_indexes.size, "unused indexes") %>
+    <% else %>
+      No unused indexes
+    <% end %>
+  </div>
+</div>
+
+<% if @long_running_queries.any? %>
+  <h1>Long Running Queries</h1>
+
+  <%= render partial: "queries_table", locals: {queries: @long_running_queries} %>
+<% end %>
+
+<% if !@good_cache_rate %>
+  <h1>Low Cache Hit Rate</h1>
+
+  <p>
+    Index Hit Rate: <%= (@index_hit_rate * 100).round(1) %>%
+    <br />
+    Table Hit Rate: <%= (@table_hit_rate * 100).round(1) %>%
+  </p>
+
+  <p>
+    Try adding more memory.
+    <!-- TODO better suggestions -->
+  </p>
+<% end %>
+
+<% if @missing_indexes.any? %>
+  <h1>Missing Indexes</h1>
+
+  <p>These tables have a large number of rows and a lower % of time the index is used.  Consider adding indexes where it makes sense.</p>
+
+  <table class="table">
+    <thead>
+      <tr>
+        <th>Table</th>
+        <th>% of Time Index Used</th>
+        <th>Rows in Table</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @missing_indexes.each do |query| %>
+        <tr>
+          <td><%= query["table"] %></td>
+          <td style="width: 30%;"><%= query["percent_of_times_index_used"] %></td>
+          <td style="width: 20%;"><%= query["rows_in_table"] %></td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+<% end %>
+
+<% if @unused_indexes.any? %>
+  <h1>Unused Indexes</h1>
+
+  <p>Unused indexes cause unnecessary overhead.</p>
+
+  <table class="table">
+    <thead>
+      <tr>
+        <th>Name</th>
+        <th>Index Size</th>
+        <th>Index Scans</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @unused_indexes.each do |query| %>
+        <tr>
+          <td><%= query["index"] %><div class="text-muted">on <%= query["table"] %></div></td>
+          <td style="width: 15%;"><%= query["index_size"] %></td>
+          <td style="width: 15%;"><%= query["index_scans"] %></td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+<% end %>

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

@@ -0,0 +1,20 @@
+<h1>Index Usage</h1>
+
+<table class="table">
+  <thead>
+    <tr>
+      <th>Table</th>
+      <th>% of Time Index Used</th>
+      <th>Rows in Table</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @index_usage.each do |query| %>
+      <tr>
+        <td><%= query["table"] %></td>
+        <td style="width: 30%;"><%= query["percent_of_times_index_used"] %></td>
+        <td style="width: 20%;"><%= query["rows_in_table"] %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

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

@@ -0,0 +1,7 @@
+<h1>Queries</h1>
+
+<%= render partial: "queries_table", locals: {queries: @running_queries} %>
+
+<p><%= button_to "Kill all connections", kill_all_path, class: "btn btn-danger" %></p>
+
+<p class="text-muted">You may need to restart your Rails server afterwards.</p>

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

@@ -0,0 +1,20 @@
+<h1>Largest Relations</h1>
+
+<table class="table">
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th style="width: 20%;">Type</th>
+      <th style="width: 20%;">Size</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @relation_sizes.each do |query| %>
+      <tr>
+        <td><%= query["name"] %></td>
+        <td><%= query["type"] %></td>
+        <td><%= query["size"] %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/config/routes.rb

@@ -0,0 +1,9 @@
+PgHero::Engine.routes.draw do
+  root to: "home#index"
+  get "indexes", to: "home#indexes"
+  get "space", to: "home#space"
+  get "queries", to: "home#queries"
+
+  post "kill", to: "home#kill"
+  post "kill_all", to: "home#kill_all"
+end

data/lib/pghero.rb

@@ -0,0 +1,166 @@
+require "pghero/version"
+require "pghero/engine" if defined?(Rails)
+
+module PgHero
+  class << self
+
+    def running_queries
+      execute %Q{
+        SELECT
+          pid,
+          state,
+          application_name AS source,
+          age(now(), xact_start) AS duration,
+          waiting,
+          query
+        FROM
+          pg_stat_activity
+        WHERE
+          query <> '<insufficient privilege>'
+          AND state <> 'idle'
+          AND pid <> pg_backend_pid()
+        ORDER BY
+          query_start DESC
+      }
+    end
+
+    def long_running_queries
+      execute %Q{
+        SELECT
+          pid,
+          state,
+          application_name AS source,
+          age(now(), xact_start) AS duration,
+          waiting,
+          query
+        FROM
+          pg_stat_activity
+        WHERE
+          query <> '<insufficient privilege>'
+          AND state <> 'idle'
+          AND pid <> pg_backend_pid()
+          AND now() - query_start > interval '5 minutes'
+        ORDER BY
+          query_start DESC
+      }
+    end
+
+    def index_hit_rate
+      execute(%Q{
+        SELECT
+          (sum(idx_blks_hit)) / nullif(sum(idx_blks_hit + idx_blks_read),0) AS rate
+        FROM
+          pg_statio_user_indexes
+      }).first["rate"].to_f
+    end
+
+    def table_hit_rate
+      execute(%Q{
+        SELECT
+          sum(heap_blks_hit) / nullif(sum(heap_blks_hit) + sum(heap_blks_read),0) AS rate
+        FROM
+          pg_statio_user_tables
+      }).first["rate"].to_f
+    end
+
+    def index_usage
+      execute %Q{
+        SELECT
+          relname AS table,
+          CASE idx_scan
+            WHEN 0 THEN 'Insufficient data'
+            ELSE (100 * idx_scan / (seq_scan + idx_scan))::text
+          END percent_of_times_index_used,
+          n_live_tup rows_in_table
+        FROM
+          pg_stat_user_tables
+        ORDER BY
+          n_live_tup DESC,
+          relname ASC
+       }
+    end
+
+    def missing_indexes
+      execute %Q{
+        SELECT relname AS table,
+          CASE idx_scan
+            WHEN 0 THEN 'Insufficient data'
+            ELSE (100 * idx_scan / (seq_scan + idx_scan))::text
+          END percent_of_times_index_used,
+          n_live_tup rows_in_table
+        FROM
+          pg_stat_user_tables
+        WHERE
+          idx_scan < 95
+          AND n_live_tup >= 10000
+        ORDER BY
+          n_live_tup DESC,
+          relname ASC
+       }
+    end
+
+    def unused_indexes
+      execute %Q{
+        SELECT
+          relname AS table,
+          indexrelname AS index,
+          pg_size_pretty(pg_relation_size(i.indexrelid)) AS index_size,
+          idx_scan as index_scans
+        FROM
+          pg_stat_user_indexes ui
+        INNER JOIN
+          pg_index i ON ui.indexrelid = i.indexrelid
+        WHERE
+          NOT indisunique
+          AND idx_scan < 50 AND pg_relation_size(relid) > 5 * 8192
+        ORDER BY
+          pg_relation_size(i.indexrelid) / nullif(idx_scan, 0) DESC NULLS FIRST,
+          pg_relation_size(i.indexrelid) DESC,
+          relname ASC
+      }
+    end
+
+    def relation_sizes
+      execute %Q{
+        SELECT
+          c.relname AS name,
+          CASE WHEN c.relkind = 'r' THEN 'table' ELSE 'index' END AS type,
+          pg_size_pretty(pg_table_size(c.oid)) AS size
+        FROM
+          pg_class c
+        LEFT JOIN
+          pg_namespace n ON (n.oid = c.relnamespace)
+        WHERE
+          n.nspname NOT IN ('pg_catalog', 'information_schema')
+          AND n.nspname !~ '^pg_toast'
+          AND c.relkind IN ('r', 'i')
+        ORDER BY
+          pg_table_size(c.oid) DESC,
+          name ASC
+      }
+    end
+
+    def kill(pid)
+      ActiveRecord::Base.connection.execute("SELECT pg_cancel_backend(#{pid.to_i})").first["pg_cancel_backend"] == "t"
+    end
+
+    def kill_all
+      execute %Q{
+        SELECT
+          pg_terminate_backend(pid)
+        FROM
+          pg_stat_activity
+        WHERE
+          pid <> pg_backend_pid()
+          AND query <> '<insufficient privilege>'
+      }
+      true
+    end
+
+    def execute(sql)
+      # squish for logs
+      ActiveRecord::Base.connection.select_all(sql.squish).to_a
+    end
+
+  end
+end

data/lib/pghero/engine.rb

@@ -0,0 +1,5 @@
+module PgHero
+  class Engine < ::Rails::Engine
+    isolate_namespace PgHero
+  end
+end

data/lib/pghero/version.rb

@@ -0,0 +1,3 @@
+module PgHero
+  VERSION = "0.0.1"
+end

data/pghero.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pghero/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pghero"
+  spec.version       = PgHero::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+  spec.summary       = %q{Database insights made easy}
+  spec.description   = %q{Database insights made easy}
+  spec.homepage      = "https://github.com/ankane/pghero"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: pghero
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- 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/index.html.erb
+- app/views/pg_hero/home/indexes.html.erb
+- app/views/pg_hero/home/queries.html.erb
+- app/views/pg_hero/home/space.html.erb
+- config/routes.rb
+- lib/pghero.rb
+- lib/pghero/engine.rb
+- lib/pghero/version.rb
+- pghero.gemspec
+homepage: https://github.com/ankane/pghero
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Database insights made easy
+test_files: []
+has_rdoc: