pghero 1.4.2 → 1.5.0

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

@@ -1,5 +1,5 @@
 <div class="content">
   <h1>Connections</h1>
 
-  <%= render partial: "connections_table", locals: {total_connections: @total_connections, connection_sources: PgHero.connection_sources(by_database: true), show_message: false} %>
+  <%= render partial: "connections_table", locals: {total_connections: @total_connections, connection_sources: @connection_sources, show_message: false} %>
 </div>

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

@@ -3,12 +3,21 @@
 
   <%= form_tag explain_path do %>
     <%= text_area_tag :query, @query, placeholder: "Enter a SQL query" %>
-    <p><%= submit_tag "Explain", class: "btn btn-info" %> <%= submit_tag "Analyze", class: "btn btn-danger" %></p>
+    <p>
+      <%= submit_tag "Explain", class: "btn btn-info", style: "margin-right: 10px;" %>
+      <%= submit_tag "Analyze", class: "btn btn-danger", style: "margin-right: 10px;" %>
+      <%= submit_tag "Visualize", class: "btn btn-danger" %>
+    </p>
   <% end %>
 
   <% if @explanation %>
+    <% if @visualize %>
+      <p>Paste the output below into the <%= link_to "Postgres Explain Visualizer", "http://tatiyants.com/pev/#/plans/new", target: "_blank" %></p>
+    <% end %>
     <pre><%= @explanation %></pre>
-    <p><%= link_to "See how to interpret this", "http://www.postgresql.org/docs/current/static/using-explain.html", target: "_blank" %></p>
+    <% unless @visualize %>
+      <p><%= link_to "See how to interpret this", "http://www.postgresql.org/docs/current/static/using-explain.html", target: "_blank" %></p>
+    <% end %>
     <% if (index = @suggested_index) %>
       <%= render partial: "suggested_index", locals: {index: index, details: index[:details]} %>
     <% end %>

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

@@ -18,7 +18,7 @@
   </div>
   <div class="alert alert-<%= @good_cache_rate ? "success" : "warning" %>">
     <% if @good_cache_rate %>
-      Cache hit rate above <%= PgHero.cache_hit_rate_threshold %>%
+      Cache hit rate above <%= @database.cache_hit_rate_threshold %>%
     <% else %>
       Low cache hit rate
     <% end %>
@@ -61,7 +61,7 @@
       <% end %>
     </div>
   <% end %>
-  <% if PgHero.suggested_indexes_enabled? %>
+  <% if @database.suggested_indexes_enabled? %>
     <div class="alert alert-<%= @suggested_indexes.empty? ? "success" : "warning" %>">
       <% if @suggested_indexes.any? %>
         <%= pluralize(@suggested_indexes.size, "suggested index", "suggested indexes") %>
@@ -126,7 +126,7 @@
 <% if !@good_total_connections %>
   <div class="content">
     <h1>High Number of Connections</h1>
-    <%= render partial: "connections_table", locals: {total_connections: @total_connections, connection_sources: PgHero.connection_sources(by_database: true).first(10), show_message: true} %>
+    <%= render partial: "connections_table", locals: {total_connections: @total_connections, connection_sources: @database.connection_sources(by_database_and_user: true).first(10), show_message: true} %>
   </div>
 <% end %>
 
@@ -335,7 +335,7 @@ pg_stat_statements.track = all</pre>
   <div class="content">
     <h1>Slow Queries</h1>
 
-    <p>Slow queries take <%= PgHero.slow_query_ms %> ms or more on average and have been called at least <%= PgHero.slow_query_calls %> times.</p>
+    <p>Slow queries take <%= @database.slow_query_ms %> ms or more on average and have been called at least <%= @database.slow_query_calls %> times.</p>
     <p><%= link_to "Explain queries", explain_path %> to see where to add indexes.</p>
 
     <%= render partial: "queries_table", locals: {queries: @slow_queries} %>

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

@@ -21,13 +21,13 @@
           <td>
             <% time = [table["last_autovacuum"], table["last_vacuum"]].compact.max %>
             <% if time %>
-              <%= PgHero.time_zone.parse(time).strftime("%m/%-e %l:%M %P") %>
+              <%= @time_zone.parse(time).strftime("%m/%-e %l:%M %P") %>
             <% end %>
           </td>
           <td>
             <% time = [table["last_autoanalyze"], table["last_analyze"]].compact.max %>
             <% if time %>
-              <%= PgHero.time_zone.parse(time).strftime("%m/%-e %l:%M %P") %>
+              <%= @time_zone.parse(time).strftime("%m/%-e %l:%M %P") %>
             <% end %>
           </td>
         </tr>

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

@@ -4,7 +4,7 @@
       <%= link_to name, system_path(options) %>
     <% end %>
   </p>
-  <% path_options = params.slice(:duration, :period) %>
+  <% 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>
@@ -15,7 +15,7 @@
   <h1>Connections</h1>
   <div style="margin-bottom: 20px;"><%= line_chart connection_stats_path(path_options), colors: ["#5bc0de"] %></div>
 
-  <% if PgHero.replica? %>
+  <% if @database.replica? %>
     <h1>Replication Lag</h1>
     <div style="margin-bottom: 20px;"><%= line_chart replication_lag_stats_path(path_options), colors: ["#5bc0de"] %></div>
   <% end %>

data/guides/Rails.md

@@ -244,6 +244,14 @@ PgHero.total_connections_threshold = 100 # default
 
 ## Upgrading
 
+### 1.5.0
+
+For query stats grouping by user, create a migration with:
+
+```ruby
+add_column :pghero_query_stats, :user, :text
+```
+
 ### 1.3.0
 
 For better query stats grouping with Postgres 9.4+, create a migration with:

data/lib/generators/pghero/space_stats_generator.rb

@@ -0,0 +1,29 @@
+# taken from https://github.com/collectiveidea/audited/blob/master/lib/generators/audited/install_generator.rb
+require "rails/generators"
+require "rails/generators/migration"
+require "active_record"
+require "rails/generators/active_record"
+
+module Pghero
+  module Generators
+    class SpaceStatsGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname) #:nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if ::ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+
+      def copy_migration
+        migration_template "space_stats.rb", "db/migrate/create_pghero_space_stats.rb"
+      end
+    end
+  end
+end

data/lib/generators/pghero/templates/space_stats.rb

@@ -0,0 +1,13 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_table :pghero_space_stats do |t|
+      t.text :database
+      t.text :schema
+      t.text :relation
+      t.integer :size, limit: 8
+      t.timestamp :captured_at
+    end
+
+    add_index :pghero_space_stats, [:database, :captured_at]
+  end
+end

data/lib/pghero.rb

@@ -1,16 +1,9 @@
 require "pghero/version"
 require "active_record"
-require "pghero/database"
-require "pghero/engine" if defined?(Rails)
-
-# models
-require "pghero/connection"
-require "pghero/query_stats"
 
 # methods
 require "pghero/methods/basic"
 require "pghero/methods/connections"
-require "pghero/methods/databases"
 require "pghero/methods/explain"
 require "pghero/methods/indexes"
 require "pghero/methods/kill"
@@ -25,6 +18,13 @@ require "pghero/methods/system"
 require "pghero/methods/tables"
 require "pghero/methods/users"
 
+require "pghero/database"
+require "pghero/engine" if defined?(Rails)
+
+# models
+require "pghero/connection"
+require "pghero/query_stats"
+
 module PgHero
   # settings
   class << self
@@ -38,20 +38,106 @@ module PgHero
   self.env = ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
   self.show_migrations = true
 
-  extend Methods::Basic
-  extend Methods::Connections
-  extend Methods::Databases
-  extend Methods::Explain
-  extend Methods::Indexes
-  extend Methods::Kill
-  extend Methods::Maintenance
-  extend Methods::Queries
-  extend Methods::QueryStats
-  extend Methods::Replica
-  extend Methods::Sequences
-  extend Methods::Space
-  extend Methods::SuggestedIndexes
-  extend Methods::System
-  extend Methods::Tables
-  extend Methods::Users
+  class << self
+    extend Forwardable
+    def_delegators :current_database, :access_key_id, :autoindex, :autoindex_all, :autovacuum_danger,
+      :best_index, :blocked_queries, :capture_query_stats, :connection_sources, :connection_stats,
+      :cpu_usage, :create_user, :database_size, :db_instance_identifier, :disable_query_stats, :drop_user,
+      :duplicate_indexes, :enable_query_stats, :explain, :historical_query_stats_enabled?, :index_caching,
+      :index_hit_rate, :index_usage, :indexes, :invalid_indexes, :kill, :kill_all, :kill_long_running_queries,
+      :locks, :long_running_queries, :maintenance_info, :missing_indexes, :query_stats,
+      :query_stats_available?, :query_stats_enabled?, :query_stats_extension_enabled?, :query_stats_readable?,
+      :rds_stats, :read_iops_stats, :region, :relation_sizes, :replica?, :replication_lag, :replication_lag_stats,
+      :reset_query_stats, :running_queries, :secret_access_key, :sequence_danger, :sequences, :settings,
+      :slow_queries, :ssl_used?, :stats_connection, :suggested_indexes, :suggested_indexes_by_query,
+      :suggested_indexes_enabled?, :system_stats_enabled?, :table_caching, :table_hit_rate, :table_stats,
+      :total_connections, :transaction_id_danger, :unused_indexes, :unused_tables, :write_iops_stats
+
+    def time_zone=(time_zone)
+      @time_zone = time_zone.is_a?(ActiveSupport::TimeZone) ? time_zone : ActiveSupport::TimeZone[time_zone.to_s]
+    end
+
+    def time_zone
+      @time_zone || Time.zone
+    end
+
+    def config
+      Thread.current[:pghero_config] ||= begin
+        path = "config/pghero.yml"
+
+        config =
+          (YAML.load(ERB.new(File.read(path)).result)[env] if File.exist?(path))
+
+        if config
+          config
+        else
+          {
+            "databases" => {
+              "primary" => {
+                "url" => ENV["PGHERO_DATABASE_URL"] || ActiveRecord::Base.connection_config,
+                "db_instance_identifier" => ENV["PGHERO_DB_INSTANCE_IDENTIFIER"]
+              }
+            }
+          }
+        end
+      end
+    end
+
+    def databases
+      @databases ||= begin
+        Hash[
+          config["databases"].map do |id, c|
+            [id, PgHero::Database.new(id, c)]
+          end
+        ]
+      end
+    end
+
+    def primary_database
+      databases.values.first
+    end
+
+    def current_database
+      Thread.current[:pghero_current_database] ||= primary_database
+    end
+
+    def current_database=(database)
+      raise "Database not found" unless databases[database.to_s]
+      Thread.current[:pghero_current_database] = databases[database.to_s]
+      database
+    end
+
+    def with(database)
+      previous_database = current_database
+      begin
+        self.current_database = database
+        yield
+      ensure
+        self.current_database = previous_database.id
+      end
+    end
+
+    def capture_query_stats
+      databases.each do |_, database|
+        database.capture_query_stats
+      end
+      true
+    end
+
+    def capture_space_stats
+      databases.each do |_, database|
+        database.capture_space_stats
+      end
+      true
+    end
+
+    # Handles Rails 4 ('t') and Rails 5 (true) values.
+    def truthy?(value)
+      value == true || value == 't'
+    end
+
+    def falsey?(value)
+      value == false || value == 'f'
+    end
+  end
 end

data/lib/pghero/database.rb

@@ -1,5 +1,21 @@
 module PgHero
   class Database
+    include Methods::Basic
+    include Methods::Connections
+    include Methods::Explain
+    include Methods::Indexes
+    include Methods::Kill
+    include Methods::Maintenance
+    include Methods::Queries
+    include Methods::QueryStats
+    include Methods::Replica
+    include Methods::Sequences
+    include Methods::Space
+    include Methods::SuggestedIndexes
+    include Methods::System
+    include Methods::Tables
+    include Methods::Users
+
     attr_reader :id, :config
 
     def initialize(id, config)
@@ -7,6 +23,36 @@ module PgHero
       @config = config
     end
 
+    def name
+      @name ||= @config["name"] || id.titleize
+    end
+
+    def db_instance_identifier
+      @db_instance_identifier ||= @config["db_instance_identifier"]
+    end
+
+    def capture_query_stats?
+      config["capture_query_stats"] != false
+    end
+
+    def cache_hit_rate_threshold
+      (config["cache_hit_rate_threshold"] || PgHero.config["cache_hit_rate_threshold"] || PgHero.cache_hit_rate_threshold).to_i
+    end
+
+    def total_connections_threshold
+      (config["total_connections_threshold"] || PgHero.config["total_connections_threshold"] || PgHero.total_connections_threshold).to_i
+    end
+
+    def slow_query_ms
+      (config["slow_query_ms"] || PgHero.config["slow_query_ms"] || PgHero.slow_query_ms).to_i
+    end
+
+    def slow_query_calls
+      (config["slow_query_calls"] || PgHero.config["slow_query_calls"] || PgHero.slow_query_calls).to_i
+    end
+
+    private
+
     def connection_model
       @connection_model ||= begin
         url = config["url"]
@@ -18,13 +64,5 @@ module PgHero
         end
       end
     end
-
-    def db_instance_identifier
-      @db_instance_identifier ||= @config["db_instance_identifier"]
-    end
-
-    def name
-      @name ||= @config["name"] || id.titleize
-    end
   end
 end

data/lib/pghero/engine.rb

@@ -2,7 +2,7 @@ module PgHero
   class Engine < ::Rails::Engine
     isolate_namespace PgHero
 
-    initializer "precompile", group: :all do |app|
+    initializer "pghero", group: :all do |app|
       if defined?(Sprockets) && Sprockets::VERSION >= "4"
         app.config.assets.precompile << "pghero/application.js"
         app.config.assets.precompile << "pghero/application.css"
@@ -11,6 +11,8 @@ module PgHero
         app.config.assets.precompile << proc { |path| path == "pghero/application.js" }
         app.config.assets.precompile << proc { |path| path == "pghero/application.css" }
       end
+
+      PgHero.time_zone = PgHero.config["time_zone"] if PgHero.config["time_zone"]
     end
   end
 end

data/lib/pghero/methods/basic.rb

@@ -1,36 +1,6 @@
 module PgHero
   module Methods
     module Basic
-      def time_zone=(time_zone)
-        @time_zone = time_zone.is_a?(ActiveSupport::TimeZone) ? time_zone : ActiveSupport::TimeZone[time_zone.to_s]
-      end
-
-      def time_zone
-        @time_zone || Time.zone
-      end
-
-      def config
-        Thread.current[:pghero_config] ||= begin
-          path = "config/pghero.yml"
-
-          config =
-            (YAML.load(ERB.new(File.read(path)).result)[env] if File.exist?(path))
-
-          if config
-            config
-          else
-            {
-              "databases" => {
-                "primary" => {
-                  "url" => ENV["PGHERO_DATABASE_URL"] || ActiveRecord::Base.connection_config,
-                  "db_instance_identifier" => ENV["PGHERO_DB_INSTANCE_IDENTIFIER"]
-                }
-              }
-            }
-          end
-        end
-      end
-
       def settings
         names = %w(
           max_connections shared_buffers effective_cache_size work_mem
@@ -45,19 +15,14 @@ module PgHero
         ssl_used = nil
         connection_model.transaction do
           execute("CREATE EXTENSION IF NOT EXISTS sslinfo")
-          ssl_used = truthy?(select_all("SELECT ssl_is_used()").first["ssl_is_used"])
+          ssl_used = PgHero.truthy?(select_all("SELECT ssl_is_used()").first["ssl_is_used"])
           raise ActiveRecord::Rollback
         end
         ssl_used
       end
 
-      # Handles Rails 4 ('t') and Rails 5 (true) values.
-      def truthy?(value)
-        value == true || value == 't'
-      end
-
-      def falsey?(value)
-        value == false || value == 'f'
+      def database_name
+        select_all("SELECT current_database()").first["current_database"]
       end
 
       private
@@ -88,10 +53,6 @@ module PgHero
         connection.execute(sql)
       end
 
-      def connection_model
-        databases[current_database].connection_model
-      end
-
       def connection
         connection_model.connection
       end