pghero 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 408d3e02f0d03c8da95d11eaeea8a6c0fb8be19e
-  data.tar.gz: 557d0b3c72e111fe2355b80eda417ad731d2a345
+  metadata.gz: fb091e2ecc7b76f41e0af306855d6df60f9ace12
+  data.tar.gz: c82ae33d920f6b7862b8aa9cc46e7abe0fffa5c2
 SHA512:
-  metadata.gz: e480e555168eaea71a6eada2f669058ee6097d0ac54e1812648025deeae343727a35f7c30287af8abb5c451d2de6d481fd9c099cf96e76fc92b7becd82740e00
-  data.tar.gz: 8bd10dc018837518f2f623575d2b6f1c2f975b493b1434800fa31a2f999b933bc70318751041431e7ae7d63dc83602c2982b439e6c569dcd0dfd4de7442ef566
+  metadata.gz: c24fd383eb9069a9445a2e826e65dbb5eaeb3e9a7ab03c202dc1acaf42ef866e52f6895a8f202043f16b82eb41cc8ad297773d8e57811e5b0e928052e3cf699e
+  data.tar.gz: 0d7193d888ae03896d64080dfa14dd811fc6e8b7aea621c913b34f082a4baa7da113339aa3dfcca9828276034cf0c8c163599a73d5bb23ae5ede1dccca21d028

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.7
+
+- Added support for pg_stat_statments on Amazon RDS
+- Added `long_running_query_sec`, `slow_query_ms` and `slow_query_calls` options
+
 ## 0.1.6
 
 - Added methods to create and drop users

data/README.md

@@ -4,13 +4,13 @@ Postgres insights made easy
 
 [View the demo](https://pghero.herokuapp.com/)
 
-![Screenshot](https://pghero.herokuapp.com/assets/screenshot-57d07895ddb050f8dd46b98e73ef1415.png)
+![Screenshot](https://pghero.herokuapp.com/assets/screenshot-d09df77e5e1de184ae1fcfb2e5f49387.png)
 
 Supports PostgreSQL 9.2+
 
 :speech_balloon: Get [handcrafted updates](http://chartkick.us7.list-manage.com/subscribe?u=952c861f99eb43084e0a49f98&id=6ea6541e8e&group[0][32]=true) for new features
 
-For pure SQL, check out [PgHero.sql](https://github.com/ankane/pghero.sql)
+For pure SQL, check out [PgHero.sql](https://github.com/ankane/pghero.sql) and for a standalone app, check out [PgHero Solo](https://github.com/bmorton/pghero_solo)
 
 A big thanks to [Craig Kerstiens](http://www.craigkerstiens.com/2013/01/10/more-on-postgres-performance/) and [Heroku](https://blog.heroku.com/archives/2013/5/10/more_insight_into_your_database_with_pgextras) for the initial queries :clap:
 
@@ -115,9 +115,7 @@ end
 
 The [pg_stat_statements module](http://www.postgresql.org/docs/9.3/static/pgstatstatements.html) is used for query stats.
 
-### Common Issues
-
-#### Installation
+### Installation
 
 If you have trouble enabling query stats from the dashboard, try doing it manually.
 
@@ -134,7 +132,17 @@ Then restart PostgreSQL. As a superuser from the `psql` console, run:
 CREATE extension pg_stat_statements;
 ```
 
-**Note:** Query stats are not available on Amazon RDS. [Tell Amazon you want this.](https://forums.aws.amazon.com/thread.jspa?messageID=548724)
+#### Amazon RDS
+
+Change `shared_preload_libraries` to `pg_stat_statements` in your [Parameter Group](https://console.aws.amazon.com/rds/home?region=us-east-1#parameter-groups:) and restart the database instance.
+
+As a superuser from the `psql` console, run:
+
+```psql
+CREATE extension pg_stat_statements;
+```
+
+### Common Issues
 
 #### pg_stat_statements must be loaded via shared_preload_libraries
 
@@ -175,6 +183,26 @@ PGHERO_SECRET_ACCESS_KEY=secret123
 PGHERO_DB_INSTANCE_IDENTIFIER=datakick-production
 ```
 
+## Customize
+
+Minimum time for long running queries
+
+```ruby
+PgHero.long_running_query_sec = 60 # default
+```
+
+Minimum average time for slow queries
+
+```ruby
+PgHero.slow_query_ms = 20 # default
+```
+
+Minimum calls for slow queries
+
+```ruby
+PgHero.slow_query_calls = 100 # default
+```
+
 ## TODO
 
 - show exactly which indexes to add

data/app/controllers/pg_hero/home_controller.rb

@@ -18,7 +18,6 @@ module PgHero
       @unused_indexes = PgHero.unused_indexes
       @good_cache_rate = @table_hit_rate >= 0.99 && @index_hit_rate >= 0.99
       @query_stats_available = PgHero.query_stats_available?
-      @rds = PgHero.rds?
     end
 
     def indexes

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

@@ -1,13 +1,4 @@
 <div id="status">
-  <div class="alert alert-<%= @query_stats_enabled && @slow_queries.empty? ? "success" : "warning" %>">
-    <% if !@query_stats_enabled %>
-      Query stats must be enabled for slow queries
-    <% elsif @slow_queries.any? %>
-      <%= pluralize(@slow_queries.size, "slow query") %>
-    <% else %>
-      No slow queries
-    <% end %>
-  </div>
   <div class="alert alert-<%= @long_running_queries.empty? ? "success" : "warning" %>">
     <% if @long_running_queries.any? %>
       <%= pluralize(@long_running_queries.size, "long running query") %>
@@ -22,6 +13,15 @@
       Low cache hit rate
     <% end %>
   </div>
+  <div class="alert alert-<%= @query_stats_enabled && @slow_queries.empty? ? "success" : "warning" %>">
+    <% if !@query_stats_enabled %>
+      Query stats must be enabled for slow queries
+    <% elsif @slow_queries.any? %>
+      <%= pluralize(@slow_queries.size, "slow query") %>
+    <% else %>
+      No slow queries
+    <% end %>
+  </div>
   <div class="alert alert-<%= @missing_indexes.empty? ? "success" : "warning" %>">
     <% if @missing_indexes.any? %>
       <%= pluralize(@missing_indexes.size, "table appears", "tables appear") %> to be missing indexes
@@ -38,6 +38,31 @@
   </div>
 </div>
 
+<% if @long_running_queries.any? %>
+  <div class="content">
+    <h1>Long Running Queries</h1>
+
+    <%= render partial: "queries_table", locals: {queries: @long_running_queries} %>
+  </div>
+<% end %>
+
+<% if !@good_cache_rate %>
+  <div class="content">
+    <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>
+      The cache hit rate <%= link_to "should be above 99%", "https://devcenter.heroku.com/articles/understanding-postgres-data-caching", target: "_blank" %> in most cases.  You can often increase this by adding more memory.
+      <!-- TODO better suggestions -->
+    </p>
+  </div>
+<% end %>
+
 <% if !@query_stats_enabled %>
   <div class="content">
     <h1>Query Stats</h1>
@@ -47,8 +72,6 @@
         Query stats are available but not enabled.
         <%= button_to "Enable", enable_query_stats_path, class: "btn btn-info" %>
       </p>
-    <% elsif @rds %>
-      <p>Query stats are not available on Amazon RDS. <%= link_to "Tell Amazon you want this.", "https://forums.aws.amazon.com/thread.jspa?messageID=548724", target: "_blank" %></p>
     <% else %>
       <p>Make them available by adding the following lines to <code>postgresql.conf</code>:</p>
       <pre>shared_preload_libraries = 'pg_stat_statements'
@@ -62,39 +85,13 @@ pg_stat_statements.track = all</pre>
   <div class="content">
     <h1>Slow Queries</h1>
 
-    <p>Slow queries take 20 ms or more on average and have been called at least 100 times.</p>
-    <p><%= link_to "Run EXPLAIN", explain_path %> on queries to see where to add indexes.</p>
+    <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><%= link_to "Explain queries", explain_path %> to see where to add indexes.</p>
 
     <%= render partial: "query_stats_table", locals: {queries: @slow_queries} %>
   </div>
 <% end %>
 
-<% if @long_running_queries.any? %>
-  <div class="content">
-    <h1>Long Running Queries</h1>
-
-    <%= render partial: "queries_table", locals: {queries: @long_running_queries} %>
-  </div>
-<% end %>
-
-<% if !@good_cache_rate %>
-  <div class="content">
-    <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>
-      The cache hit rate <%= link_to "should be above 99%", "https://devcenter.heroku.com/articles/understanding-postgres-data-caching", target: "_blank" %> in most cases.  You can often increase this by adding more memory.
-      <!-- TODO better suggestions -->
-    </p>
-  </div>
-<% end %>
-
-
 <% if @missing_indexes.any? %>
   <div class="content">
     <h1>Missing Indexes</h1>

data/lib/pghero.rb

@@ -8,6 +8,13 @@ module PgHero
     establish_connection ENV["PGHERO_DATABASE_URL"] if ENV["PGHERO_DATABASE_URL"]
   end
 
+  class << self
+    attr_accessor :long_running_query_sec, :slow_query_ms, :slow_query_calls
+  end
+  self.long_running_query_sec = 60
+  self.slow_query_ms = 20
+  self.slow_query_calls = 100
+
   class << self
 
     def running_queries
@@ -47,7 +54,7 @@ module PgHero
           query <> '<insufficient privilege>'
           AND state <> 'idle'
           AND pid <> pg_backend_pid()
-          AND now() - query_start > interval '1 minutes'
+          AND now() - query_start > interval '#{long_running_query_sec.to_i} seconds'
         ORDER BY
           query_start DESC
       }
@@ -244,8 +251,8 @@ module PgHero
             pg_database ON pg_database.oid = pg_stat_statements.dbid
           WHERE
             pg_database.datname = current_database()
-            AND calls >= 100
-            AND (total_time / calls) >= 20
+            AND calls >= #{slow_query_calls.to_i}
+            AND (total_time / calls) >= #{slow_query_ms.to_i}
           ORDER BY
             total_minutes DESC
           LIMIT 100
@@ -256,7 +263,7 @@ module PgHero
     end
 
     def query_stats_available?
-      select_all("SELECT COUNT(*) AS count FROM pg_available_extensions WHERE name = 'pg_stat_statements'").first["count"].to_i > 0 && !rds?
+      select_all("SELECT COUNT(*) AS count FROM pg_available_extensions WHERE name = 'pg_stat_statements'").first["count"].to_i > 0
     end
 
     def query_stats_enabled?
@@ -393,11 +400,6 @@ module PgHero
       ENV["PGHERO_DB_INSTANCE_IDENTIFIER"]
     end
 
-    # TODO better RDS check
-    def rds?
-      !!(Connection.connection_config[:host].to_s =~ /rds\.amazonaws\.com\z/)
-    end
-
     def explain(sql)
       sql = squish(sql)
       explanation = nil

data/lib/pghero/version.rb

@@ -1,3 +1,3 @@
 module PgHero
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pghero
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord