pghero 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ed028006b69e4e3595170baffc6fb328de3cd3f
-  data.tar.gz: 05f3f70425c1506f3ba7e6106e1be4922b256fc6
+  metadata.gz: aca2a34abdf1aa45e33214683e898ef7b38cf4b5
+  data.tar.gz: d538fd497d9e85adef16551f3e4f54b2c0f81ae0
 SHA512:
-  metadata.gz: a7d7323653811a623f0a7843fd5aaec408570f96909a7ccec71f2aaae343619f67eb8ff81878f1f86cc035f9a1cc2c20539470025136ac004765aa0d67c6e75b
-  data.tar.gz: 951cf7cc4359047ec384905e6dcbd0e8f6de9c205a32a09c399a38191f9edcf10492b07b05f8af6a80948d1366c34ca9edc7c7f26b20812fc39f7f8b90f43e9a
+  metadata.gz: 3af44d86c65e316555e8a6ac6a8692214025649d2c4b05e64244b55e1bd6b7b538d5b13efc857238330d51adc8bd9cd6e222678679bbc5dd31740017a0d95191
+  data.tar.gz: 6ccddb176e5131effd878d5efb7074812918e3fe5ed80733e84a9621edf77127a1c3222ec6d3f011e974020bd6752539b853ce809c2aa50ca2982fd01b02703b

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.1.1
+
+- Added `tables` option to `create_user` method
+- Added ability to sort query stats by average_time and calls
+- Only show unused indexes with no index scans in UI
+
 ## 1.1.0
 
 - Added historical query stats

data/app/controllers/pg_hero/home_controller.rb

@@ -16,7 +16,7 @@ module PgHero
       @index_hit_rate = PgHero.index_hit_rate
       @table_hit_rate = PgHero.table_hit_rate
       @missing_indexes = PgHero.missing_indexes
-      @unused_indexes = PgHero.unused_indexes
+      @unused_indexes = PgHero.unused_indexes.select { |q| q["index_scans"].to_i == 0 }
       @good_cache_rate = @table_hit_rate >= 0.99 && @index_hit_rate >= 0.99
       @query_stats_available = PgHero.query_stats_available?
       @total_connections = PgHero.total_connections
@@ -47,6 +47,7 @@ module PgHero
     def queries
       @title = "Queries"
       @historical_query_stats_enabled = PgHero.historical_query_stats_enabled?
+      @sort = %w[average_time calls].include?(params[:sort]) ? params[:sort] : nil
 
       @query_stats =
         begin
@@ -58,7 +59,7 @@ module PgHero
           if @historical_query_stats_enabled && !request.xhr?
             []
           else
-            PgHero.query_stats(historical: true, start_at: @start_at, end_at: @end_at)
+            PgHero.query_stats(historical: true, start_at: @start_at, end_at: @end_at, sort: @sort)
           end
         rescue
           @error = true

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

@@ -124,6 +124,10 @@
         padding: 6px 140px 20px 140px;
       }
 
+      .queries-table th a {
+        color: inherit;
+      }
+
       #slider {
         margin-bottom: 20px;
       }

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

@@ -9,14 +9,14 @@
   <thead>
     <tr>
       <th>Top Sources</th>
-      <th>Connections</th>
+      <th style="width: 20%;">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>
+        <td><%= number_with_delimiter(source["total_connections"]) %></td>
       </tr>
     <% end %>
   </tbody>

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

@@ -1,10 +1,10 @@
-<table class="table">
+<table class="table queries-table">
   <% unless local_assigns[:xhr] %>
     <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>
+        <th style="width: 33.33%;"><%= local_assigns[:sort_headers] ? link_to("Total Time", {sort: nil}, data: {sort: nil}) : "Total Time" %></th>
+        <th style="width: 33.33%;"><%= local_assigns[:sort_headers] ? link_to("Average Time", {sort: "average_time"}, data: {sort: "average_time"}) : "Average Time" %></th>
+        <th style="width: 33.33%;"><%= local_assigns[:sort_headers] ? link_to("Calls", {sort: "calls"}, data: {sort: "calls"}) : "Calls" %></th>
       </tr>
     </thead>
   <% end %>

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

@@ -42,6 +42,8 @@
     return (num < 10) ? "0" + num : num;
   }
 
+  var sort = <%= @sort.to_json.html_safe %>;
+
   var months = ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
 
   var days = 1;
@@ -49,7 +51,7 @@
   var sliderStartAt = roundTime(now) - days * 24 * 60 * 60 * 1000;
   var sliderMax = 24 * 12 * days;
 
-  var startAt = <%= @start_at.to_i %> * 1000;
+  var startAt = <%= params[:start_at] ? @start_at.to_i * 1000 : "sliderStartAt" %>;
   var min = (startAt > 0) ? (startAt - sliderStartAt) / (1000 * 60 * 5) : 0;
 
   var endAt = <%= @end_at.to_i %> * 1000;
@@ -96,24 +98,40 @@
     return time.toISOString();
   }
 
+  function queriesPath(params) {
+    var path = "queries";
+    if (params.start_at || params.end_at || params.sort) {
+      path += "?" + $.param(params);
+    }
+    return path;
+  }
+
   function refreshStats(push) {
     var values = $slider.val();
-    var startAt = timeAt(values[0]);
+    var startAt = push ? timeAt(values[0]) : new Date(window.startAt);
     var endAt = timeAt(values[1]);
 
     var params = {}
-    if (startAt > sliderStartAt) {
+    if (startAt.getTime() != sliderStartAt) {
       params.start_at = timeParam(startAt);
     }
     if (endAt < now) {
       params.end_at = timeParam(endAt);
     }
-
-    var path = "queries";
-    if (params.start_at || params.end_at) {
-      path += "?" + $.param(params);
+    if (sort) {
+      params.sort = sort;
     }
 
+    var path = queriesPath(params);
+
+    $(".queries-table th a").each( function () {
+      var p = $.extend({}, params, {sort: $(this).data("sort")});
+      if (!p.sort) {
+        delete p.sort;
+      }
+      $(this).attr("href", queriesPath(p));
+    });
+
     $("#queries").html('<tr><td colspan="3"><p class="queries-info text-muted">...</p></td></tr>').load(path);
 
     if (push && history.pushState) {
@@ -125,5 +143,7 @@
     refreshStats(true);
   });
   updateText();
-  $(refreshStats);
+  $( function () {
+    refreshStats(false);
+  });
 </script>

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

@@ -174,16 +174,14 @@ remove_index <%= query["table"].to_sym.inspect %>, name: <%= query["index"].to_s
       <thead>
         <tr>
           <th>Name</th>
-          <th>Index Size</th>
-          <th>Index Scans</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 style="width: 15%;"><%= query["index_size"] %></td>
-            <td style="width: 15%;"><%= query["index_scans"] %></td>
+            <td><%= query["index_size"] %></td>
           </tr>
         <% end %>
       </tbody>

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

@@ -5,16 +5,16 @@
     <thead>
       <tr>
         <th>Table</th>
-        <th>% of Time Index Used</th>
-        <th>Rows</th>
+        <th style="width: 30%;">% of Time Index Used</th>
+        <th style="width: 20%;">Rows</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%;"><%= number_with_delimiter(query["rows_in_table"]) %></td>
+          <td><%= query["percent_of_times_index_used"] %></td>
+          <td><%= number_with_delimiter(query["rows_in_table"]) %></td>
         </tr>
       <% end %>
     </tbody>

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

@@ -13,7 +13,7 @@
     <% if @error %>
       <div class="alert alert-danger">Cannot understand start or end time.</div>
     <% elsif @query_stats.any? || @historical_query_stats_enabled %>
-      <%= render partial: "queries_table", locals: {queries: @query_stats} %>
+      <%= render partial: "queries_table", locals: {queries: @query_stats, sort_headers: true} %>
     <% else %>
       <p>Stats are not available yet. Come back soon!</p>
     <% end %>

data/guides/Heroku.md

@@ -21,6 +21,35 @@ For databases outside of Heroku, query stats can be enabled from the dashboard.
 
 If you run into issues, [view the guide](Query-Stats.md).
 
+## Historical Query Stats
+
+To track query stats over time, create a table to store them.
+
+```sql
+CREATE TABLE "pghero_query_stats" ("id" serial primary key, "database" text, "query" text, "total_time" float, "calls" bigint, "captured_at" timestamp)
+CREATE INDEX "index_pghero_query_stats_on_database_and_captured_at" ON "pghero_query_stats" ("database", "captured_at")
+```
+
+This table can be in the current database or another database. If another database, run:
+
+```sh
+heroku config:set PGHERO_STATS_DATABASE_URL=...
+```
+
+Schedule the task below to run every 5 minutes.
+
+```sh
+rake pghero:capture_query_stats
+```
+
+Or with a scheduler like Clockwork, use:
+
+```ruby
+PgHero.capture_query_stats
+```
+
+After this, a time range slider will appear on the Queries tab.
+
 ## System Stats
 
 CPU usage is available for Amazon RDS.  Add these variables to your environment:

data/guides/Linux.md

@@ -5,7 +5,9 @@ Packaged for:
 - Ubuntu 14.04 (Trusty)
 - Ubuntu 12.04 (Precise)
 - Debian 7 (Wheezy)
-- CentOS and RHEL 6
+- Debian 8 (Jesse)
+- CentOS / RHEL 6
+- CentOS / RHEL 7
 - Fedora 20
 - SUSE Linux Enterprise Server
 
@@ -40,7 +42,16 @@ sudo apt-get update
 sudo apt-get install pghero
 ```
 
-CentOS and RHEL 6
+Debian 8 (Jesse)
+
+```sh
+wget -qO - https://deb.packager.io/key | sudo apt-key add -
+echo "deb https://deb.packager.io/gh/pghero/pghero jessie master" | sudo tee /etc/apt/sources.list.d/pghero.list
+sudo apt-get update
+sudo apt-get install pghero
+```
+
+CentOS / RHEL 6
 
 ```sh
 sudo rpm --import https://rpm.packager.io/key
@@ -51,6 +62,17 @@ enabled=1" | sudo tee /etc/yum.repos.d/pghero.repo
 sudo yum install pghero
 ```
 
+CentOS / RHEL 7
+
+```sh
+sudo rpm --import https://rpm.packager.io/key
+echo "[pghero]
+name=Repository for pghero/pghero application.
+baseurl=https://rpm.packager.io/gh/pghero/pghero/centos7/master
+enabled=1" | sudo tee /etc/yum.repos.d/pghero.repo
+sudo yum install pghero
+```
+
 Fedora 20
 
 ```sh
@@ -126,6 +148,29 @@ sudo service pghero restart
 
 Query stats can be enabled from the dashboard. If you run into issues, [view the guide](Query-Stats.md).
 
+## Historical Query Stats
+
+To track query stats over time, create a table to store them.
+
+```sql
+CREATE TABLE "pghero_query_stats" ("id" serial primary key, "database" text, "query" text, "total_time" float, "calls" bigint, "captured_at" timestamp)
+CREATE INDEX "index_pghero_query_stats_on_database_and_captured_at" ON "pghero_query_stats" ("database", "captured_at")
+```
+
+This table can be in the current database or another database. If another database, run:
+
+```sh
+sudo pghero config:set PGHERO_STATS_DATABASE_URL=...
+```
+
+Schedule the task below to run every 5 minutes.
+
+```sh
+sudo pghero run rake pghero:capture_query_stats
+```
+
+After this, a time range slider will appear on the Queries tab.
+
 ## System Stats
 
 CPU usage is available for Amazon RDS.  Add these variables to your environment:

data/guides/Rails.md

@@ -32,6 +32,7 @@ PgHero.relation_sizes
 PgHero.index_hit_rate
 PgHero.table_hit_rate
 PgHero.total_connections
+PgHero.locks
 ```
 
 Kill queries
@@ -68,6 +69,8 @@ PgHero.replication_lag
 
 ## Users
 
+**Note:** It’s unsafe to pass user input to these commands.
+
 Create a user
 
 ```ruby
@@ -89,6 +92,12 @@ Set the password
 PgHero.create_user("zelda", password: "hyrule")
 ```
 
+Grant access to only certain tables
+
+```ruby
+PgHero.create_user("navi", tables: ["triforce"])
+```
+
 Drop a user
 
 ```ruby
@@ -141,7 +150,7 @@ PgHero.capture_query_stats
 
 After this, a time range slider will appear on the Queries tab.
 
-By default, historical query stats are stored in your primary database. Change this with:
+By default, query stats are stored in your app’s database. Change this with:
 
 ```ruby
 ENV["PGHERO_STATS_DATABASE_URL"]

data/lib/pghero.rb

@@ -325,7 +325,8 @@ module PgHero
         value["total_percent"] = value["total_minutes"] * 100.0 / (current_query_stats[query]["all_queries_total_minutes"].to_f + historical_query_stats[query]["all_queries_total_minutes"].to_f)
         query_stats << value
       end
-      query_stats.sort_by { |q| -q["total_minutes"] }.first(100)
+      sort = options[:sort] || "total_minutes"
+      query_stats.sort_by { |q| -q[sort] }.first(100)
     end
 
     def slow_queries(options = {})
@@ -477,13 +478,21 @@ module PgHero
           "GRANT USAGE ON SCHEMA #{schema} TO #{user}"
         ]
       if options[:readonly]
-        commands << "GRANT SELECT ON ALL TABLES IN SCHEMA #{schema} TO #{user}"
-        commands << "ALTER DEFAULT PRIVILEGES IN SCHEMA #{schema} GRANT SELECT ON TABLES TO #{user}"
+        if options[:tables]
+          commands.concat table_grant_commands("SELECT", options[:tables], user)
+        else
+          commands << "GRANT SELECT ON ALL TABLES IN SCHEMA #{schema} TO #{user}"
+          commands << "ALTER DEFAULT PRIVILEGES IN SCHEMA #{schema} GRANT SELECT ON TABLES TO #{user}"
+        end
       else
-        commands << "GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA #{schema} TO #{user}"
-        commands << "GRANT ALL PRIVILEGES ON ALL SEQUENCES IN SCHEMA #{schema} TO #{user}"
-        commands << "ALTER DEFAULT PRIVILEGES IN SCHEMA #{schema} GRANT ALL PRIVILEGES ON TABLES TO #{user}"
-        commands << "ALTER DEFAULT PRIVILEGES IN SCHEMA #{schema} GRANT ALL PRIVILEGES ON SEQUENCES TO #{user}"
+        if options[:tables]
+          commands.concat table_grant_commands("ALL PRIVILEGES", options[:tables], user)
+        else
+          commands << "GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA #{schema} TO #{user}"
+          commands << "GRANT ALL PRIVILEGES ON ALL SEQUENCES IN SCHEMA #{schema} TO #{user}"
+          commands << "ALTER DEFAULT PRIVILEGES IN SCHEMA #{schema} GRANT ALL PRIVILEGES ON TABLES TO #{user}"
+          commands << "ALTER DEFAULT PRIVILEGES IN SCHEMA #{schema} GRANT ALL PRIVILEGES ON SEQUENCES TO #{user}"
+        end
       end
 
       # run commands
@@ -581,10 +590,17 @@ module PgHero
 
     private
 
+    def table_grant_commands(privilege, tables, user)
+      tables.map do |table|
+        "GRANT #{privilege} ON TABLE #{table} TO #{user}"
+      end
+    end
+
     # http://www.craigkerstiens.com/2013/01/10/more-on-postgres-performance/
     def current_query_stats(options = {})
       if query_stats_enabled?
         limit = options[:limit] || 100
+        sort = options[:sort] || "total_minutes"
         select_all <<-SQL
           WITH query_stats AS (
             SELECT
@@ -609,7 +625,7 @@ module PgHero
           FROM
             query_stats
           ORDER BY
-            total_minutes DESC
+            #{quote_table_name(sort)} DESC
           LIMIT #{limit.to_i}
         SQL
       else
@@ -619,6 +635,7 @@ module PgHero
 
     def historical_query_stats(options = {})
       if historical_query_stats_enabled?
+        sort = options[:sort] || "total_minutes"
         stats_connection.select_all squish <<-SQL
           WITH query_stats AS (
             SELECT
@@ -645,7 +662,7 @@ module PgHero
           FROM
             query_stats
           ORDER BY
-            total_minutes DESC
+            #{quote_table_name(sort)} DESC
           LIMIT 100
         SQL
       else
@@ -695,5 +712,9 @@ module PgHero
     def quote(value)
       connection.quote(value)
     end
+
+    def quote_table_name(value)
+      connection.quote_table_name(value)
+    end
   end
 end

data/lib/pghero/version.rb

@@ -1,3 +1,3 @@
 module PgHero
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pghero
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-26 00:00:00.000000000 Z
+date: 2015-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord