pghero 1.6.2 → 1.6.3

data/app/assets/stylesheets/pghero/application.css

@@ -47,6 +47,10 @@ h1, p {
   margin-bottom: 20px;
 }
 
+h3 {
+  text-align: center;
+}
+
 ul {
   list-style-type: none;
   padding: 0;
@@ -422,3 +426,10 @@ body {
 #periods a {
   margin-right: 20px;
 }
+
+.chart {
+  height: 300px;
+  line-height: 300px;
+  text-align: center;
+  color: #999;
+}

data/app/controllers/pg_hero/home_controller.rb

@@ -19,14 +19,15 @@ module PgHero
       @extended = params[:extended]
       @query_stats = @database.query_stats(historical: true, start_at: 3.hours.ago)
       @slow_queries = @database.slow_queries(query_stats: @query_stats)
-      @long_running_queries = @database.long_running_queries
+      @autovacuum_queries, @long_running_queries = @database.long_running_queries.partition { |q| q["query"].starts_with?("autovacuum:") }
+
       if @extended
         @index_hit_rate = @database.index_hit_rate
         @table_hit_rate = @database.table_hit_rate
         @good_cache_rate = @table_hit_rate >= @database.cache_hit_rate_threshold.to_f / 100 && @index_hit_rate >= @database.cache_hit_rate_threshold.to_f / 100
       end
 
-      @unused_indexes = @database.unused_indexes.select { |q| q["index_scans"].to_i == 0 }
+      @unused_indexes = @database.unused_indexes.select { |q| q["index_scans"].to_i == 0 } if @extended
       @invalid_indexes = @database.invalid_indexes
       @duplicate_indexes = @database.duplicate_indexes
       unless @query_stats_enabled

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

@@ -1,10 +1,3 @@
-<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>

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

@@ -8,11 +8,10 @@
     </tr>
   </thead>
   <tbody>
-    <% now = Time.now %>
     <% queries.reverse.each do |query| %>
       <tr>
         <td><%= query["pid"] %></td>
-        <td><%= query["started_at"] ? "#{number_with_delimiter(((now - Time.parse(query["started_at"])) * 1000).round)} ms" : nil %></td>
+        <td><%= number_with_delimiter(query["duration_ms"].to_f.round) %> ms</td>
         <td><%= query["state"] %></td>
         <td class="text-right">
           <% button_path, button_options = Rails.version >= "4.1" ? [explain_path, {params: {query: query["query"]}}] : [explain_path(query: query["query"]), {}] %>

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

@@ -1,5 +1,33 @@
 <div class="content">
   <h1>Connections</h1>
 
-  <%= render partial: "connections_table", locals: {total_connections: @total_connections, connection_sources: @connection_sources, show_message: false} %>
+  <p><%= pluralize(@total_connections, "connection") %></p>
+
+  <h3>By Database</h3>
+
+  <% top_connections = Hash.new(0) %>
+  <% @connection_sources.each do |source| %>
+    <% top_connections[source["database"]] += source["total_connections"].to_i %>
+  <% end %>
+  <% top_connections = top_connections.sort_by { |k, v| [-v, k] } %>
+
+  <div id="chart-1" class="chart" style="height: 260px; line-height: 260px; margin-bottom: 20px;">Loading...</div>
+  <script>
+    new Chartkick.PieChart("chart-1", <%= json_escape(top_connections.to_json).html_safe %>);
+  </script>
+
+  <h3>By User</h3>
+
+  <% top_connections = Hash.new(0) %>
+  <% @connection_sources.each do |source| %>
+    <% top_connections[source["user"]] += source["total_connections"].to_i %>
+  <% end %>
+  <% top_connections = top_connections.sort_by { |k, v| [-v, k] } %>
+
+  <div id="chart-2" class="chart" style="height: 260px; line-height: 260px; margin-bottom: 20px;">Loading...</div>
+  <script>
+    new Chartkick.PieChart("chart-2", <%= json_escape(top_connections.to_json).html_safe %>);
+  </script>
+
+  <%= render partial: "connections_table", locals: {connection_sources: @connection_sources} %>
 </div>

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

@@ -23,5 +23,7 @@
     <% end %>
   <% elsif @error %>
     <div class="alert alert-danger"><%= @error %></div>
+  <% else %>
+    <p class="text-muted">Note: The analyze and visualize buttons can add load to your database for long running queries, so be careful.</p>
   <% end %>
 </div>

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

@@ -15,6 +15,9 @@
     <% else %>
       No long running queries
     <% end %>
+    <% if @autovacuum_queries.any? %>
+      <span class="tiny"><%= @autovacuum_queries.size %> autovacuum</span>
+    <% end %>
   </div>
   <% if @extended %>
     <div class="alert alert-<%= @good_cache_rate ? "success" : "warning" %>">
@@ -81,6 +84,15 @@
       No slow queries
     <% end %>
   </div>
+  <% if @extended %>
+    <div class="alert alert-<%= @unused_indexes.empty? ? "success" : "warning" %>">
+      <% if @unused_indexes.any? %>
+        <%= pluralize(@unused_indexes.size, "unused index", "unused indexes") %>
+      <% else %>
+        No unused indexes
+      <% end %>
+    </div>
+  <% end %>
 </div>
 
 <% if @replica && !@good_replication_lag %>
@@ -120,7 +132,11 @@
 <% if !@good_total_connections %>
   <div class="content">
     <h1>High Number of Connections</h1>
-    <%= render partial: "connections_table", locals: {total_connections: @total_connections, connection_sources: @database.connection_sources(by_database_and_user: true).first(10), show_message: true} %>
+    <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>
+
+    <%= render partial: "connections_table", locals: {connection_sources: @database.connection_sources(by_database_and_user: true).first(10)} %>
   </div>
 <% end %>
 
@@ -310,3 +326,41 @@ pg_stat_statements.track = all</pre>
     <%= render partial: "queries_table", locals: {queries: @slow_queries} %>
   </div>
 <% end %>
+
+<% if @extended && @unused_indexes.any? %>
+  <div class="content">
+    <h1>Unused Indexes</h1>
+
+    <p>
+      Unused indexes cause unnecessary overhead. Remove them
+      <% if @show_migrations %>
+        <a href="javascript: void(0);" onclick="document.getElementById('migration').style.display = 'block';">with a migration</a>
+      <% end %>
+      for faster writes.
+    </p>
+
+    <div id="migration" style="display: none;">
+      <pre>rails g migration remove_unused_indexes</pre>
+      <p>And paste</p>
+      <pre style="overflow: scroll; white-space: pre; word-break: normal;"><% @unused_indexes.each do |query| %>
+remove_index <%= query["table"].to_sym.inspect %>, name: <%= query["index"].to_s.inspect %><% end %></pre>
+    </div>
+
+    <table class="table">
+      <thead>
+        <tr>
+          <th>Name</th>
+          <th style="width: 20%;">Index Size</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @unused_indexes.each do |query| %>
+          <tr>
+            <td><%= query["index"] %><div class="text-muted">on <%= query["table"] %></div></td>
+            <td><%= query["index_size"] %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+<% end %>

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

@@ -1,9 +1,11 @@
 <div class="content">
   <h1>Live Queries</h1>
 
+  <p><%= pluralize(@running_queries.size, "query") %></p>
+
   <%= render partial: "live_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>
+  <p class="text-muted">You may need to restart your app server afterwards.</p>
 </div>

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

@@ -7,16 +7,28 @@
   <% path_options = {duration: params[:duration], period: params[:period]} %>
 
   <h1>CPU</h1>
-  <div style="margin-bottom: 20px;"><%= line_chart cpu_usage_path(path_options), max: 100, colors: ["#5bc0de"] %></div>
+  <div id="chart-1" class="chart" style="margin-bottom: 20px;">Loading...</div>
+  <script>
+    new Chartkick.LineChart("chart-1", <%= json_escape(cpu_usage_path(path_options).to_json).html_safe %>, {max: 100, colors: ["#5bc0de"]})
+  </script>
 
   <h1>Load</h1>
-  <div style="margin-bottom: 20px;"><%= line_chart load_stats_path(path_options), colors: ["#5bc0de", "#d9534f"] %></div>
+  <div id="chart-2" class="chart" style="margin-bottom: 20px;">Loading...</div>
+  <script>
+    new Chartkick.LineChart("chart-2", <%= json_escape(load_stats_path(path_options).to_json).html_safe %>, {colors: ["#5bc0de", "#d9534f"]})
+  </script>
 
   <h1>Connections</h1>
-  <div style="margin-bottom: 20px;"><%= line_chart connection_stats_path(path_options), colors: ["#5bc0de"] %></div>
+  <div id="chart-3" class="chart" style="margin-bottom: 20px;">Loading...</div>
+  <script>
+    new Chartkick.LineChart("chart-3", <%= json_escape(connection_stats_path(path_options).to_json).html_safe %>, {colors: ["#5bc0de"]})
+  </script>
 
   <% if @database.replica? %>
     <h1>Replication Lag</h1>
-    <div style="margin-bottom: 20px;"><%= line_chart replication_lag_stats_path(path_options), colors: ["#5bc0de"] %></div>
+    <div id="chart-4" class="chart" style="margin-bottom: 20px;">Loading...</div>
+    <script>
+      new Chartkick.LineChart("chart-4", <%= json_escape(replication_lag_stats_path(path_options).to_json).html_safe %>, {colors: ["#5bc0de"]})
+    </script>
   <% end %>
 </div>

data/guides/Rails.md

@@ -38,7 +38,7 @@ ENV["PGHERO_PASSWORD"] = "hyrule"
 #### Devise
 
 ```ruby
-authenticate :user, lambda { |user| user.admin? } do
+authenticate :user, -> (user) { user.admin? } do
   mount PgHero::Engine, at: "pghero"
 end
 ```
@@ -78,11 +78,10 @@ ENV["PGHERO_STATS_DATABASE_URL"]
 
 ## System Stats
 
-CPU usage is available for Amazon RDS.  Add these lines to your application’s Gemfile:
+CPU usage, IOPS, and other stats are available for Amazon RDS. Add these lines to your application’s Gemfile:
 
 ```ruby
 gem 'aws-sdk'
-gem 'chartkick'
 ```
 
 And add these variables to your environment:

data/lib/generators/pghero/config_generator.rb

@@ -0,0 +1,13 @@
+require "rails/generators"
+
+module Pghero
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_initializer
+        template "config.yml", "config/pghero.yml"
+      end
+    end
+  end
+end

data/lib/generators/pghero/templates/config.yml

@@ -0,0 +1,23 @@
+databases:
+  main:
+    # Database URL (defaults to app database)
+    # url: <%= ENV["DATABASE_URL"] %>
+
+    # Minimum time for long running queries
+    # long_running_query_sec: 60
+
+    # Minimum average time for slow queries
+    # slow_query_ms: 20
+
+    # Minimum calls for slow queries
+    # slow_query_calls: 100
+
+    # Minimum connections for high connections warning
+    # total_connections_threshold: 100
+
+  # Add more databases
+  # other:
+  #   url: <%= ENV["OTHER_DATABASE_URL"] %>
+
+# Time zone (defaults to app time zone)
+# time_zone: "Pacific Time (US & Canada)"

data/lib/pghero.rb

@@ -65,10 +65,12 @@ module PgHero
       Thread.current[:pghero_config] ||= begin
         path = "config/pghero.yml"
 
-        config =
-          (YAML.load(ERB.new(File.read(path)).result)[env] if File.exist?(path))
+        config = YAML.load(ERB.new(File.read(path)).result) if File.exist?(path)
+        config ||= {}
 
-        if config
+        if config[env]
+          config[env]
+        elsif config["databases"] # preferred format
           config
         else
           {

data/lib/pghero/database.rb

@@ -20,7 +20,7 @@ module PgHero
 
     def initialize(id, config)
       @id = id
-      @config = config
+      @config = config || {}
     end
 
     def name

data/lib/pghero/methods/explain.rb

@@ -8,7 +8,10 @@ module PgHero
 
         # use transaction for safety
         connection_model.transaction do
-          if !explain_safe && (sql.sub(/;\z/, "").include?(";") || sql.upcase.include?("COMMIT"))
+          # protect the DB with a 10 second timeout
+          # this could potentially increase the timeout, but 10 seconds should be okay
+          select_all("SET LOCAL statement_timeout = 10000")
+          if (sql.sub(/;\z/, "").include?(";") || sql.upcase.include?("COMMIT")) && !explain_safe
             raise ActiveRecord::StatementInvalid, "Unsafe statement"
           end
           explanation = select_all("EXPLAIN #{sql}").map { |v| v["QUERY PLAN"] }.join("\n")

data/lib/pghero/methods/queries.rb

@@ -12,6 +12,7 @@ module PgHero
             #{server_version_num >= 90600 ? "(wait_event IS NOT NULL) AS waiting" : "waiting"},
             query,
             COALESCE(query_start, xact_start) AS started_at,
+            EXTRACT(EPOCH FROM NOW() - COALESCE(query_start, xact_start)) * 1000.0 AS duration_ms,
             usename AS user
           FROM
             pg_stat_activity
@@ -30,11 +31,6 @@ module PgHero
         running_queries(min_duration: long_running_query_sec)
       end
 
-      def slow_queries(options = {})
-        query_stats = options[:query_stats] || self.query_stats(options.except(:query_stats))
-        query_stats.select { |q| q["calls"].to_i >= slow_query_calls.to_i && q["average_time"].to_i >= slow_query_ms.to_i }
-      end
-
       def locks
         select_all <<-SQL
           SELECT DISTINCT ON (pid)

data/lib/pghero/methods/query_stats.rb

@@ -66,6 +66,8 @@ module PgHero
       # http://stackoverflow.com/questions/20582500/how-to-check-if-a-table-exists-in-a-given-schema
       def historical_query_stats_enabled?
         # TODO use schema from config
+        # make sure primary database is PostgreSQL first
+        ["PostgreSQL", "PostGIS"].include?(stats_connection.adapter_name) &&
         PgHero.truthy?(stats_connection.select_all(squish <<-SQL
           SELECT EXISTS (
             SELECT
@@ -148,6 +150,11 @@ module PgHero
         end
       end
 
+      def slow_queries(options = {})
+        query_stats = options[:query_stats] || self.query_stats(options.except(:query_stats))
+        query_stats.select { |q| q["calls"].to_i >= slow_query_calls.to_i && q["average_time"].to_i >= slow_query_ms.to_i }
+      end
+
       private
 
       def stats_connection

data/lib/pghero/version.rb

@@ -1,3 +1,3 @@
 module PgHero
-  VERSION = "1.6.2"
+  VERSION = "1.6.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pghero
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-27 00:00:00.000000000 Z
+date: 2017-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -153,8 +153,10 @@ files:
 - guides/Query-Stats.md
 - guides/Rails.md
 - guides/Suggested-Indexes.md
+- lib/generators/pghero/config_generator.rb
 - lib/generators/pghero/query_stats_generator.rb
 - lib/generators/pghero/space_stats_generator.rb
+- lib/generators/pghero/templates/config.yml
 - lib/generators/pghero/templates/query_stats.rb
 - lib/generators/pghero/templates/space_stats.rb
 - lib/pghero.rb
@@ -206,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A performance dashboard for Postgres