pghero 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5dea912ab838c4fae3ac427223c11432f059eec
-  data.tar.gz: 8615bc4cc2913aa1c639f8e75235985b29f50c76
+  metadata.gz: b36df22eb125725ef48c4c9c1cb4094a2cd346b8
+  data.tar.gz: d683feef9adc1a6b0b09ed8ea844159e24b250cd
 SHA512:
-  metadata.gz: 9f333855160f97440da34cb9395c91139af6d125c7d8c12ef957691478fdbeb9318c403584af294ded8826956b99a63d79b8b6bc6fc62adda88c7fd19afabcca
-  data.tar.gz: fd3c203da38d5238d493c33eae218403597c21f8791c84edc61f74db9ed20d08b8980cc1c2029873b6ef50ad77e7136823c48e82ba7cee35165d57538a2718c6
+  metadata.gz: 42c4d3ccc26df2ac3a0011051acad9f9b06e8f61da89eed183a275d5d3a1752bbcb5a7a756ea26f3bfb20e6e05832c310c1bc87b63cfc6be194eb2b2ce46f247
+  data.tar.gz: 1e584dd852a119509488d59f6fb5346d211e43da9cf221000f96899cb71ea9bf8002780b00d1e70586664c435bfea764a09816cfd992ac642ae350fe4a1ccea3

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.1.10
+
+- Added connections page
+- Added message for insufficient privilege
+- Added `ip` to `connection_sources`
+
 ## 0.1.9
 
 - Added tune page

data/Gemfile

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

data/Rakefile

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

data/app/controllers/pg_hero/home_controller.rb

@@ -45,7 +45,7 @@ module PgHero
 
     def system_stats
       @title = "System Stats"
-      @cpu_usage = PgHero.cpu_usage.map{|k, v| [k, v.round] }
+      @cpu_usage = PgHero.cpu_usage.map { |k, v| [k, v.round] }
       @connection_stats = PgHero.connection_stats
     end
 
@@ -54,7 +54,7 @@ module PgHero
       @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
+      if request.post? && @query
         begin
           @explanation = PgHero.explain(@query)
         rescue ActiveRecord::StatementInvalid => e
@@ -68,6 +68,11 @@ module PgHero
       @settings = PgHero.settings
     end
 
+    def connections
+      @title = "Connections"
+      @total_connections = PgHero.total_connections
+    end
+
     def kill
       if PgHero.kill(params[:pid])
         redirect_to root_path, notice: "Query killed"
@@ -82,21 +87,17 @@ module PgHero
     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
+      PgHero.enable_query_stats
+      redirect_to :back, notice: "Query stats enabled"
+    rescue ActiveRecord::StatementInvalid
+      redirect_to :back, alert: "The database user does not have permission to enable query stats"
     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
+      PgHero.reset_query_stats
+      redirect_to :back, notice: "Query stats reset"
+    rescue ActiveRecord::StatementInvalid
+      redirect_to :back, alert: "The database user does not have permission to reset query stats"
     end
 
     protected
@@ -105,6 +106,5 @@ module PgHero
       @query_stats_enabled = PgHero.query_stats_enabled?
       @system_stats_enabled = PgHero.system_stats_enabled?
     end
-
   end
 end

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

@@ -362,6 +362,7 @@
             <li class="<%= controller.action_name == "space" ? "active" : "" %>"><%= link_to "Space", space_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>
+            <li class="<%= controller.action_name == "connections" ? "active" : "" %>"><%= link_to "Connections", connections_path %></li>
             <li class="<%= controller.action_name == "tune" ? "active" : "" %>"><%= link_to "Tune", tune_path %></li>
           </ul>
         </div>

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

@@ -0,0 +1,23 @@
+<p><%= pluralize(total_connections, "connection") %></p>
+<% if show_message %>
+  <p>
+    <%= link_to "Use connection pooling", "http://www.craigkerstiens.com/2014/05/22/on-connection-pooling/", target: "_blank" %> for better performance. <%= link_to "PgBouncer", "https://wiki.postgresql.org/wiki/PgBouncer", target: "_blank" %> is a solid option.
+  </p>
+<% end %>
+
+<table class="table">
+  <thead>
+    <tr>
+      <th>Top Sources</th>
+      <th>Connections</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% PgHero.connection_sources.first(10).each do |source| %>
+      <tr>
+        <td><%= source["source"] %> <span class="text-muted"><%= source["ip"] %></span></td>
+        <td style="width: 20%;"><%= number_with_delimiter(source["total_connections"]) %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

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

@@ -26,7 +26,12 @@
         <td><%= number_with_delimiter(query["calls"].to_i) %></td>
       </tr>
       <tr>
-        <td colspan="3" style="border-top: none; padding: 0;"><pre><%= query["query"] %></pre></td>
+        <td colspan="3" style="border-top: none; padding: 0;">
+          <pre><%= query["query"] %></pre>
+          <% if query["query"] == "<insufficient privilege>" %>
+            <p class="text-muted">For security reasons, only superusers can see queries executed by other users.</p>
+          <% end %>
+        </td>
       </tr>
     <% end %>
   </tbody>

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

@@ -0,0 +1,5 @@
+<div class="content">
+  <h1>Connections</h1>
+
+  <%= render partial: "connections_table", locals: {total_connections: @total_connections, show_message: false} %>
+</div>

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

@@ -73,27 +73,7 @@
 <% if !@good_total_connections %>
   <div class="content">
     <h1>High Number of Connections</h1>
-    <p><%= pluralize(@total_connections, "connection") %></p>
-    <p>
-      <%= link_to "Use connection pooling", "http://www.craigkerstiens.com/2014/05/22/on-connection-pooling/", target: "_blank" %> for better performance. <%= link_to "PgBouncer", "https://wiki.postgresql.org/wiki/PgBouncer", target: "_blank" %> is a solid option.
-    </p>
-
-    <table class="table">
-      <thead>
-        <tr>
-          <th>Top Sources</th>
-          <th>Connections</th>
-        </tr>
-      </thead>
-      <tbody>
-        <% PgHero.connection_sources.first(10).each do |source| %>
-          <tr>
-            <td><%= source["source"] %></td>
-            <td style="width: 20%;"><%= number_with_delimiter(source["total_connections"]) %></td>
-          </tr>
-        <% end %>
-      </tbody>
-    </table>
+    <%= render partial: "connections_table", locals: {total_connections: @total_connections, show_message: true} %>
   </div>
 <% end %>
 

data/config/routes.rb

@@ -7,6 +7,7 @@ PgHero::Engine.routes.draw do
   get "system_stats", to: "home#system_stats"
   get "explain", to: "home#explain"
   get "tune", to: "home#tune"
+  get "connections", to: "home#connections"
 
   post "kill", to: "home#kill"
   post "kill_all", to: "home#kill_all"

data/lib/pghero.rb

@@ -17,7 +17,6 @@ module PgHero
   self.total_connections_threshold = 100
 
   class << self
-
     def running_queries
       select_all <<-SQL
         SELECT
@@ -206,16 +205,19 @@ module PgHero
       select_all <<-SQL
         SELECT
           application_name AS source,
+          client_addr AS ip,
           COUNT(*) AS total_connections
         FROM
           pg_stat_activity
         WHERE
           pid <> pg_backend_pid()
         GROUP BY
-          application_name
+          application_name,
+          ip
         ORDER BY
           COUNT(*) DESC,
-          application_name ASC
+          application_name ASC,
+          client_addr ASC
       SQL
     end
 
@@ -315,12 +317,9 @@ module PgHero
     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
+      select_all("SELECT has_table_privilege(current_user, 'pg_stat_statements', 'SELECT')").first["has_table_privilege"] == "t"
+    rescue ActiveRecord::StatementInvalid
+      false
     end
 
     def enable_query_stats
@@ -363,7 +362,7 @@ module PgHero
           statistics: ["Average"]
         )
         data = {}
-        resp[:datapoints].sort_by{|d| d[:timestamp] }.each do |d|
+        resp[:datapoints].sort_by { |d| d[:timestamp] }.each do |d|
           data[d[:timestamp]] = d[:average]
         end
         data
@@ -459,10 +458,10 @@ module PgHero
 
       # use transaction for safety
       Connection.transaction do
-        if !explain_safe and (sql.sub(/;\z/, "").include?(";") or sql.upcase.include?("COMMIT"))
+        if !explain_safe && (sql.sub(/;\z/, "").include?(";") || sql.upcase.include?("COMMIT"))
           raise ActiveRecord::StatementInvalid, "Unsafe statement"
         end
-        explanation = select_all("EXPLAIN #{sql}").map{|v| v["QUERY PLAN"] }.join("\n")
+        explanation = select_all("EXPLAIN #{sql}").map { |v| v["QUERY PLAN"] }.join("\n")
         raise ActiveRecord::Rollback
       end
 
@@ -470,26 +469,24 @@ module PgHero
     end
 
     def explain_safe?
-      begin
-        select_all("SELECT 1; SELECT 1")
-        false
-      rescue ActiveRecord::StatementInvalid
-        true
-      end
+      select_all("SELECT 1; SELECT 1")
+      false
+    rescue ActiveRecord::StatementInvalid
+      true
     end
 
     def settings
-      names = %w[
+      names = %w(
         max_connections shared_buffers effective_cache_size work_mem
         maintenance_work_mem checkpoint_segments checkpoint_completion_target
         wal_buffers default_statistics_target
-      ]
-      values = Hash[ select_all(Connection.send(:sanitize_sql_array, ["SELECT name, setting, unit FROM pg_settings WHERE name IN (?)", names])).sort_by{|row| names.index(row["name"]) }.map{|row| [row["name"], friendly_value(row["setting"], row["unit"])] } ]
-      Hash[ names.map{|name| [name, values[name]] } ]
+      )
+      values = Hash[select_all(Connection.send(:sanitize_sql_array, ["SELECT name, setting, unit FROM pg_settings WHERE name IN (?)", names])).sort_by { |row| names.index(row["name"]) }.map { |row| [row["name"], friendly_value(row["setting"], row["unit"])] }]
+      Hash[names.map { |name| [name, values[name]] }]
     end
 
     def friendly_value(setting, unit)
-      if %w[kB 8kB].include?(unit)
+      if %w(kB 8kB).include?(unit)
         value = setting.to_i
         value *= 8 if unit == "8kB"
 
@@ -520,8 +517,7 @@ module PgHero
 
     # from ActiveSupport
     def squish(str)
-      str.to_s.gsub(/\A[[:space:]]+/, '').gsub(/[[:space:]]+\z/, '').gsub(/[[:space:]]+/, ' ')
+      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.9"
+  VERSION = "0.1.10"
 end

data/pghero.gemspec

@@ -1,15 +1,15 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'pghero/version'
+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.summary       = "Database insights made easy"
+  spec.description   = "Database insights made easy"
   spec.homepage      = "https://github.com/ankane/pghero"
   spec.license       = "MIT"
 

data/test/pghero_test.rb

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

data/test/test_helper.rb

@@ -8,7 +8,7 @@ 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|
+ActiveRecord::Migration.create_table :users, force: true do
   # just id
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pghero
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-26 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -95,8 +95,10 @@ files:
 - Rakefile
 - app/controllers/pg_hero/home_controller.rb
 - app/views/layouts/pg_hero/application.html.erb
+- app/views/pg_hero/home/_connections_table.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/connections.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
@@ -142,3 +144,4 @@ summary: Database insights made easy
 test_files:
 - test/pghero_test.rb
 - test/test_helper.rb
+has_rdoc: