pghero 0.1.10 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b36df22eb125725ef48c4c9c1cb4094a2cd346b8
-  data.tar.gz: d683feef9adc1a6b0b09ed8ea844159e24b250cd
+  metadata.gz: 5007ffa26cad91ceca6b39cf0049c0f935933637
+  data.tar.gz: 505386ddd4f407457b0d88d06840007d3aa27059
 SHA512:
-  metadata.gz: 42c4d3ccc26df2ac3a0011051acad9f9b06e8f61da89eed183a275d5d3a1752bbcb5a7a756ea26f3bfb20e6e05832c310c1bc87b63cfc6be194eb2b2ce46f247
-  data.tar.gz: 1e584dd852a119509488d59f6fb5346d211e43da9cf221000f96899cb71ea9bf8002780b00d1e70586664c435bfea764a09816cfd992ac642ae350fe4a1ccea3
+  metadata.gz: abb53d06f528e1e0461864b5afbc2e8a27cc2c425ad3a04e3ad4e1cee6bf45f4a1bd44d549dbb56df94052c0aa1bf53164d3a84d780530047368ee06fa190178
+  data.tar.gz: d2ae582ac7093732798ad45b6914b6adc4caab8af229e229a899342811f3fe2a94aeb918babb40ad8ef316e3ba2740040e313829a5a2f6bbdbbc35ac7ca96f34

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 1.0.0
+
+- More platforms!
+- Support for multiple databases!
+- Added `replica?` method
+- Added `replication_lag` method
+- Added `ssl_used?` method
+- Added `kill_long_running_queries` method
+- Added env vars for settings
+
 ## 0.1.10
 
 - Added connections page

data/README.md

@@ -4,245 +4,30 @@ Postgres insights made easy
 
 [View the demo](https://pghero.herokuapp.com/)
 
-![Screenshot](https://pghero.herokuapp.com/assets/screenshot-d09df77e5e1de184ae1fcfb2e5f49387.png)
-
-Supports PostgreSQL 9.2+
+[![Screenshot](https://pghero.herokuapp.com/assets/screenshot-34a33ee68c77d64c1f89f143f6297a47.png)](https://pghero.herokuapp.com/)
 
 :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) 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:
-
 ## Installation
 
-Add this line to your application’s Gemfile:
-
-```ruby
-gem 'pghero'
-```
-
-And mount the dashboard in your `config/routes.rb`:
-
-```ruby
-mount PgHero::Engine, at: "pghero"
-```
-
-Be sure to [secure the dashboard](#security) in production.
-
-## Insights
-
-```ruby
-PgHero.running_queries
-PgHero.long_running_queries
-PgHero.index_usage
-PgHero.missing_indexes
-PgHero.unused_indexes
-PgHero.unused_tables
-PgHero.database_size
-PgHero.relation_sizes
-PgHero.index_hit_rate
-PgHero.table_hit_rate
-PgHero.total_connections
-```
-
-Kill queries
-
-```ruby
-PgHero.kill(pid)
-PgHero.kill_all
-```
-
-Query stats
-
-```ruby
-PgHero.query_stats_enabled?
-PgHero.enable_query_stats
-PgHero.disable_query_stats
-PgHero.reset_query_stats
-PgHero.query_stats
-PgHero.slow_queries
-```
-
-## Users
-
-Create a user
-
-```ruby
-PgHero.create_user("link")
-# {password: "zbTrNHk2tvMgNabFgCo0ws7T"}
-```
-
-This generates and returns a secure password.  The user has full access to the `public` schema.
-
-Read-only access
-
-```ruby
-PgHero.create_user("epona", readonly: true)
-```
-
-Set the password
-
-```ruby
-PgHero.create_user("zelda", password: "hyrule")
-```
-
-Drop a user
-
-```ruby
-PgHero.drop_user("ganondorf")
-```
-
-## Security
-
-#### Basic Authentication
-
-Set the following variables in your environment or an initializer.
-
-```ruby
-ENV["PGHERO_USERNAME"] = "andrew"
-ENV["PGHERO_PASSWORD"] = "secret"
-```
-
-#### Devise
-
-```ruby
-authenticate :user, lambda {|user| user.admin? } do
-  mount PgHero::Engine, at: "pghero"
-end
-```
-
-## Query Stats
-
-The [pg_stat_statements module](http://www.postgresql.org/docs/9.3/static/pgstatstatements.html) is used for query stats.
-
-### Installation
-
-If you have trouble enabling query stats from the dashboard, try doing it manually.
-
-Add the following to your `postgresql.conf`:
-
-```conf
-shared_preload_libraries = 'pg_stat_statements'
-pg_stat_statements.track = all
-pg_stat_statements.max = 10000
-track_activity_query_size = 2048
-```
+PgHero can be installed as a standalone app or a Rails engine.
 
-Then restart PostgreSQL. As a superuser from the `psql` console, run:
+### Standalone
 
-```psql
-CREATE extension pg_stat_statements;
-```
+[Linux](guides/Linux.md) - Ubuntu, Debian, and more
 
-#### Amazon RDS
+[Docker](guides/Docker.md)
 
-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.
+[Heroku](guides/Heroku.md)
 
-As a superuser from the `psql` console, run:
+### Rails
 
-```psql
-CREATE extension pg_stat_statements;
-```
+[Rails](guides/Rails.md)
 
-### Common Issues
+## Credits
 
-#### pg_stat_statements must be loaded via shared_preload_libraries
-
-Follow the instructions above.
-
-#### FATAL: could not access file "pg_stat_statements": No such file or directory
-
-Run `apt-get install postgresql-contrib-9.3` and follow the instructions above.
-
-#### The database user does not have permission to ...
-
-The database user is not a superuser.  You can manually enable stats from the `psql` console with:
-
-```psql
-CREATE extension pg_stat_statements;
-```
-
-and reset stats with:
-
-```psql
-SELECT pg_stat_statements_reset();
-```
-
-#### Queries show up as `<insufficient privilege>`
-
-For security reasons, only superusers can see queries executed by other users.
-
-## System Stats
-
-CPU usage is 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:
-
-```sh
-PGHERO_ACCESS_KEY_ID=accesskey123
-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
-```
-
-Minimum connections for high connections warning
-
-```ruby
-PgHero.total_connections_threshold = 100 # default
-```
-
-## Bonus Projects
-
-- See where queries come from with [Marginalia](https://github.com/basecamp/marginalia) - comments appear on the Live Queries tab.
-- Get weekly news and articles with [Postgres Weekly](http://postgresweekly.com)
-- Optimize your configuration with [PgTune](http://pgtune.leopard.in.ua) and [pgBench](http://www.postgresql.org/docs/devel/static/pgbench.html)
-
-## TODO
-
-- suggest indexes
-- suggest paramater values
-- better explanations on dashboard
+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 and [Bootswatch](https://github.com/thomaspark/bootswatch) for the theme :clap:
 
 Know a bit about PostgreSQL? [Suggestions](https://github.com/ankane/pghero/issues) are greatly appreciated.
 
-## Thanks
-
-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 and [Bootswatch](https://github.com/thomaspark/bootswatch) for the theme.
-
-## History
-
-View the [changelog](https://github.com/ankane/pghero/blob/master/CHANGELOG.md)
-
-## Contributing
-
-Everyone is encouraged to help improve this project. Here are a few ways you can help:
-
-- [Report bugs](https://github.com/ankane/pghero/issues)
-- Fix bugs and [submit pull requests](https://github.com/ankane/pghero/pulls)
-- Write, clarify, or fix documentation
-- Suggest or add new features
+:tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)

data/app/controllers/pg_hero/home_controller.rb

@@ -6,10 +6,11 @@ module PgHero
 
     http_basic_authenticate_with name: ENV["PGHERO_USERNAME"], password: ENV["PGHERO_PASSWORD"] if ENV["PGHERO_PASSWORD"]
 
+    around_filter :set_database
     before_filter :set_query_stats_enabled
 
     def index
-      @title = "Status"
+      @title = "Overview"
       @slow_queries = PgHero.slow_queries
       @long_running_queries = PgHero.long_running_queries
       @index_hit_rate = PgHero.index_hit_rate
@@ -20,10 +21,15 @@ module PgHero
       @query_stats_available = PgHero.query_stats_available?
       @total_connections = PgHero.total_connections
       @good_total_connections = @total_connections < PgHero.total_connections_threshold
+      @replica = PgHero.replica?
+      if @replica
+        @replication_lag = PgHero.replication_lag
+        @good_replication_lag = @replication_lag < 5
+      end
     end
 
-    def indexes
-      @title = "Indexes"
+    def index_usage
+      @title = "Index Usage"
       @index_usage = PgHero.index_usage
     end
 
@@ -33,20 +39,30 @@ module PgHero
       @relation_sizes = PgHero.relation_sizes
     end
 
-    def queries
+    def live_queries
       @title = "Live Queries"
       @running_queries = PgHero.running_queries
     end
 
-    def query_stats
+    def queries
       @title = "Queries"
       @query_stats = PgHero.query_stats
     end
 
-    def system_stats
-      @title = "System Stats"
-      @cpu_usage = PgHero.cpu_usage.map { |k, v| [k, v.round] }
-      @connection_stats = PgHero.connection_stats
+    def system
+      @title = "System"
+    end
+
+    def cpu_usage
+      render json: PgHero.cpu_usage.map { |k, v| [k, v.round] }
+    end
+
+    def connection_stats
+      render json: PgHero.connection_stats
+    end
+
+    def replication_lag_stats
+      render json: PgHero.replication_lag_stats
     end
 
     def explain
@@ -81,6 +97,11 @@ module PgHero
       end
     end
 
+    def kill_long_running_queries
+      PgHero.kill_long_running_queries
+      redirect_to :back, notice: "Queries killed"
+    end
+
     def kill_all
       PgHero.kill_all
       redirect_to :back, notice: "Connections killed"
@@ -102,6 +123,23 @@ module PgHero
 
     protected
 
+    def set_database
+      @databases = PgHero.config["databases"].keys
+      if params[:database]
+        PgHero.with(params[:database]) do
+          yield
+        end
+      elsif @databases.size > 1
+        redirect_to url_for(params.slice(:controller, :action).merge(database: PgHero.primary_database))
+      else
+        yield
+      end
+    end
+
+    def default_url_options
+      {database: params[:database]}
+    end
+
     def set_query_stats_enabled
       @query_stats_enabled = PgHero.query_stats_enabled?
       @system_stats_enabled = PgHero.system_stats_enabled?

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

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
   <head>
-    <title><%= @title %> - PgHero</title>
+    <title><%= [@databases.size > 1 ? PgHero.current_database.titleize : "PgHero", @title].compact.join(" / ") %></title>
 
     <meta charset="utf-8" />
 
@@ -9,7 +9,7 @@
       body {
         margin: 0;
         padding: 20px;
-        background-color: #2b3e50;
+        background-color: #eee;
       }
 
       body, textarea {
@@ -65,7 +65,7 @@
       }
 
       pre {
-        background-color: #ddd;
+        background-color: #eee;
         padding: 10px;
         white-space: pre-wrap;
         word-break: break-word;
@@ -74,7 +74,7 @@
       textarea {
         width: 100%;
         height: 100px;
-        border: solid 1px #ccc;
+        border: solid 1px #ddd;
         padding: 10px;
       }
 
@@ -94,13 +94,18 @@
         margin-left: 6px;
       }
 
+      .tiny {
+        font-size: 12px;
+        margin-left: 6px;
+      }
+
       #status, .content, .alert {
         margin-bottom: 20px;
       }
 
       .content {
         padding: 20px 20px 1px 20px;
-        background-color: #eee;
+        background-color: #fff;
       }
 
       .queries td {
@@ -114,18 +119,25 @@
       /* nav */
 
       .nav a {
-        color: #fff;
+        color: #333;
         text-decoration: none;
         display: block;
         padding: 12px 20px;
       }
 
       .nav li.active a {
-        background-color: #df691a;
+        background-color: #ddd;
       }
 
       .nav a:hover {
-        background-color: #4e5d6c;
+        background-color: #ddd;
+      }
+
+      .nav-header {
+        font-weight: bold;
+        color: #333;
+        padding: 12px 20px 12px 0;
+        margin: 0;
       }
 
       /* buttons */
@@ -146,7 +158,7 @@
       }
 
       .btn-danger {
-        background-color: #df691a;
+        background-color: #d9534f;
       }
 
       .btn-info {
@@ -173,7 +185,7 @@
       }
 
       .alert-danger {
-        background-color: #df691a;
+        background-color: #d9534f;
       }
 
       .alert a {
@@ -349,22 +361,37 @@
 
       <div class="grid">
         <div class="col-3-12">
+          <% if @databases.size > 1 %>
+            <p class="nav-header"><%= PgHero.current_database.titleize %></p>
+          <% end %>
+
           <ul class="nav">
             <!-- poor man's active_link_to -->
-            <li class="<%= controller.action_name == "index" ? "active" : "" %>"><%= link_to "Status", root_path %></li>
+            <li class="<%= controller.action_name == "index" ? "active" : "" %>"><%= link_to "Overview", root_path %></li>
             <% if @system_stats_enabled %>
-              <li class="<%= controller.action_name == "system_stats" ? "active" : "" %>"><%= link_to "System", system_stats_path %></li>
+              <li class="<%= controller.action_name == "system" ? "active" : "" %>"><%= link_to "System", system_path %></li>
             <% end %>
             <% if @query_stats_enabled %>
-              <li class="<%= controller.action_name == "query_stats" ? "active" : "" %>"><%= link_to "Queries", query_stats_path %></li>
+              <li class="<%= controller.action_name == "queries" ? "active" : "" %>"><%= link_to "Queries", queries_path %></li>
             <% end %>
-            <li class="<%= controller.action_name == "indexes" ? "active" : "" %>"><%= link_to "Indexes", indexes_path %></li>
+            <li class="<%= controller.action_name == "index_usage" ? "active" : "" %>"><%= link_to "Index Usage", index_usage_path %></li>
             <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 == "live_queries" ? "active" : "" %>"><%= link_to "Live Queries", live_queries_path %></li>
+            <li class="<%= controller.action_name == "explain" ? "active" : "" %>"><%= link_to "Explain", explain_path %></li>
             <li class="<%= controller.action_name == "tune" ? "active" : "" %>"><%= link_to "Tune", tune_path %></li>
           </ul>
+
+          <% if @databases.size > 1 %>
+            <p class="nav-header">Other Databases</p>
+            <ul class="nav">
+              <% (@databases - [PgHero.current_database]).each do |database| %>
+                <li>
+                  <%= link_to database.titleize, root_path(database: database) %>
+                </li>
+              <% end %>
+            </ul>
+          <% end %>
         </div>
 
         <div class="col-9-12">