pghero 1.5.2 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c2d5754086d5f05286f922a611306630605f73b
-  data.tar.gz: ca7b5dcb1a2e9d58bd54c7aacd0e6994bfd7123e
+  metadata.gz: 822e5e1791b9a405db29590569bad48b312738aa
+  data.tar.gz: 628fdcaad3d38fedd644bd2574582c3676cfb37b
 SHA512:
-  metadata.gz: c1dbde4deefd73421ffa1bb3f8f7bcb55026cd945b2c2ff9add537585d3169b01955c1e50140eec4356406aa1d7a17892b46eb6ca09b3523917b482dac41ad2e
-  data.tar.gz: 75c4b1ee8ddcf1d7153df87a1ff0aad0108bad8eded953061c342c66c01313d17f8ee3a19b28d37ef693b567c7dff90c8c111452e8a878d71a24ef5b56604975
+  metadata.gz: f586c4e66499887b8694463665b0be0bf4b90f4428b470635750cd65d83e1071018730f9954819e8203b8b5cafefad360d254e7e843174c3afb4d3a940ffcd51
+  data.tar.gz: 2a0ef31b0a3a9510ae835535cf9563180974781f9d4d761a2224866a82b5e845ac5750d00709c054700416479bc3492d09d0cc28e978f05cdb76dfd5bc63d628

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.5.3
+
+- Fixed Rails 5 error with multiple databases
+- Fixed duplicate index detection with expressions
+
 ## 1.5.2
 
 - Added support for PostgreSQL 9.6

data/app/controllers/pg_hero/home_controller.rb

@@ -213,7 +213,7 @@ module PgHero
       if params[:database]
         @database = PgHero.databases[params[:database]]
       elsif @databases.size > 1
-        redirect_to url_for(params.slice(:controller, :action).merge(database: @databases.first.id))
+        redirect_to url_for(controller: controller_name, action: action_name, database: @databases.first.id)
       else
         @database = @databases.first
       end

data/guides/Docker.md

@@ -1,5 +1,43 @@
 # PgHero for Docker
 
-:fire: [Get it](https://github.com/bmorton/pghero_solo)
+PgHero is available as a [Docker image](https://hub.docker.com/r/ankane/pghero/).
 
-More instructions coming soon
+```sh
+docker run -ti -e DATABASE_URL=postgres://user:password@hostname:5432/dbname -p 8080:8080 ankane/pghero
+```
+
+And visit [http://localhost:8080](http://localhost:8080).
+
+## Query Stats
+
+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,
+  "user" text,
+  "query" text,
+  "query_hash" bigint,
+  "total_time" float,
+  "calls" bigint,
+  "captured_at" timestamp
+)
+CREATE INDEX ON "pghero_query_stats" ("database", "captured_at")
+```
+
+Schedule the task below to run every 5 minutes.
+
+```sh
+docker run -ti -e DATABASE_URL=... ankane/pghero bin/rake pghero:capture_query_stats
+```
+
+After this, a time range slider will appear on the Queries tab.
+
+## Credits
+
+Thanks to [Brian Morton](https://github.com/bmorton) for the [original Docker image](https://github.com/bmorton/pghero_solo).

data/guides/Heroku.md

@@ -26,8 +26,17 @@ If you run into issues, [view the guide](Query-Stats.md).
 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")
+CREATE TABLE "pghero_query_stats" (
+  "id" serial primary key,
+  "database" text,
+  "user" text,
+  "query" text,
+  "query_hash" bigint,
+  "total_time" float,
+  "calls" bigint,
+  "captured_at" timestamp
+)
+CREATE INDEX ON "pghero_query_stats" ("database", "captured_at")
 ```
 
 This table can be in the current database or another database. If another database, run:

data/guides/Linux.md

@@ -2,19 +2,27 @@
 
 Packaged for:
 
+- Ubuntu 16.04 (Xenial)
 - Ubuntu 14.04 (Trusty)
 - Ubuntu 12.04 (Precise)
 - Debian 7 (Wheezy)
 - Debian 8 (Jesse)
-- CentOS / RHEL 6
 - CentOS / RHEL 7
-- Fedora 20
-- SUSE Linux Enterprise Server
+- SUSE Linux Enterprise Server 12
 
 64-bit only
 
 ## Installation
 
+Ubuntu 16.04 (Xenial)
+
+```sh
+wget -qO - https://deb.packager.io/key | sudo apt-key add -
+echo "deb https://deb.packager.io/gh/pghero/pghero xenial master" | sudo tee /etc/apt/sources.list.d/pghero.list
+sudo apt-get update
+sudo apt-get -y install pghero
+```
+
 Ubuntu 14.04 (Trusty)
 
 ```sh
@@ -36,6 +44,7 @@ sudo apt-get -y install pghero
 Debian 7 (Wheezy)
 
 ```sh
+sudo apt-get -y install apt-transport-https
 wget -qO - https://deb.packager.io/key | sudo apt-key add -
 echo "deb https://deb.packager.io/gh/pghero/pghero wheezy master" | sudo tee /etc/apt/sources.list.d/pghero.list
 sudo apt-get update
@@ -52,17 +61,6 @@ sudo apt-get update
 sudo apt-get -y install pghero
 ```
 
-CentOS / RHEL 6
-
-```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/centos6/master
-enabled=1" | sudo tee /etc/yum.repos.d/pghero.repo
-sudo yum install pghero
-```
-
 CentOS / RHEL 7
 
 ```sh
@@ -71,21 +69,10 @@ 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
+sudo yum -y install pghero
 ```
 
-Fedora 20
-
-```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/fedora20/master
-enabled=1" | sudo tee /etc/yum.repos.d/pghero.repo
-sudo yum install pghero
-```
-
-SUSE Linux Enterprise Server
+SUSE Linux Enterprise Server 12
 
 ```sh
 sudo rpm --import https://rpm.packager.io/key
@@ -108,16 +95,18 @@ sudo pghero config:set PGHERO_USERNAME=link
 sudo pghero config:set PGHERO_PASSWORD=hyrule
 ```
 
-Start the server - defaults to port `6000`.
+Start the server
 
 ```sh
+sudo pghero config:set PORT=3001
+sudo pghero config:set RAILS_LOG_TO_STDOUT=disabled
 sudo pghero scale web=1
 ```
 
 Confirm it’s running with:
 
 ```sh
-curl -v http://localhost:6000/
+curl -v http://localhost:3001/
 ```
 
 To open to the outside world, add a proxy. Here’s how to do it with Nginx on Ubuntu.
@@ -129,7 +118,7 @@ server {
   listen          80;
   server_name     "";
   location / {
-    proxy_pass    http://localhost:6000;
+    proxy_pass    http://localhost:3001;
   }
 }
 EOF
@@ -145,6 +134,12 @@ sudo service pghero stop
 sudo service pghero restart
 ```
 
+View logs
+
+```sh
+sudo pghero logs
+```
+
 ## Query Stats
 
 Query stats can be enabled from the dashboard. If you run into issues, [view the guide](Query-Stats.md).
@@ -154,8 +149,17 @@ Query stats can be enabled from the dashboard. If you run into issues, [view the
 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")
+CREATE TABLE "pghero_query_stats" (
+  "id" serial primary key,
+  "database" text,
+  "user" text,
+  "query" text,
+  "query_hash" bigint,
+  "total_time" float,
+  "calls" bigint,
+  "captured_at" timestamp
+)
+CREATE INDEX ON "pghero_query_stats" ("database", "captured_at")
 ```
 
 This table can be in the current database or another database. If another database, run:
@@ -184,12 +188,6 @@ sudo pghero config:set PGHERO_DB_INSTANCE_IDENTIFIER=epona
 
 ## Customize
 
-Change the port - you cannot use a privileged port like `80` or `443`
-
-```sh
-sudo pghero config:set PORT=6000 # default
-```
-
 Minimum time for long running queries
 
 ```sh
@@ -223,7 +221,7 @@ sudo apt-get update
 sudo apt-get install --only-upgrade pghero
 ```
 
-CentOS, RHEL, and Fedora
+CentOS and RHEL
 
 ```sh
 sudo yum update

data/guides/Rails.md

@@ -1,9 +1,5 @@
 # PgHero for Rails
 
-:gem:
-
-## Installation
-
 Add this line to your application’s Gemfile:
 
 ```ruby
@@ -28,100 +24,6 @@ gem 'pg_query'
 
 and make sure [query stats](#query-stats) are enabled. Read about how it works [here](Suggested-Indexes.md).
 
-## Insights
-
-```ruby
-PgHero.running_queries
-PgHero.long_running_queries
-PgHero.index_usage
-PgHero.invalid_indexes
-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
-PgHero.locks
-```
-
-Kill queries
-
-```ruby
-PgHero.kill(pid)
-PgHero.kill_long_running_queries
-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
-```
-
-Suggested indexes
-
-```ruby
-PgHero.suggested_indexes
-PgHero.best_index(query)
-```
-
-Security
-
-```ruby
-PgHero.ssl_used?
-```
-
-Replication
-
-```ruby
-PgHero.replica?
-PgHero.replication_lag
-```
-
-## Users
-
-**Note:** It’s unsafe to pass user input to these commands.
-
-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")
-```
-
-Grant access to only certain tables
-
-```ruby
-PgHero.create_user("navi", tables: ["triforce"])
-```
-
-Drop a user
-
-```ruby
-PgHero.drop_user("ganondorf")
-```
-
 ## Security
 
 #### Basic Authentication
@@ -210,12 +112,6 @@ production:
   <<: *default
 ```
 
-Specify a database with:
-
-```ruby
-PgHero.with(:replica) { PgHero.running_queries }
-```
-
 ## Customize
 
 Minimum time for long running queries
@@ -242,6 +138,108 @@ Minimum connections for high connections warning
 PgHero.total_connections_threshold = 100 # default
 ```
 
+## Methods
+
+Insights
+
+```ruby
+PgHero.running_queries
+PgHero.long_running_queries
+PgHero.index_usage
+PgHero.invalid_indexes
+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
+PgHero.locks
+```
+
+Kill queries
+
+```ruby
+PgHero.kill(pid)
+PgHero.kill_long_running_queries
+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
+```
+
+Suggested indexes
+
+```ruby
+PgHero.suggested_indexes
+PgHero.best_index(query)
+```
+
+Security
+
+```ruby
+PgHero.ssl_used?
+```
+
+Replication
+
+```ruby
+PgHero.replica?
+PgHero.replication_lag
+```
+
+If you have multiple databases, specify a database with:
+
+```ruby
+PgHero.databases["db2"].running_queries
+```
+
+## Users
+
+**Note:** It’s unsafe to pass user input to these commands.
+
+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")
+```
+
+Grant access to only certain tables
+
+```ruby
+PgHero.create_user("navi", tables: ["triforce"])
+```
+
+Drop a user
+
+```ruby
+PgHero.drop_user("ganondorf")
+```
+
 ## Upgrading
 
 ### 1.5.0

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

@@ -2,6 +2,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration
   def change
     create_table :pghero_query_stats do |t|
       t.text :database
+      t.text :user
       t.text :query
       t.integer :query_hash, limit: 8
       t.float :total_time

data/lib/pghero/database.rb

@@ -51,6 +51,10 @@ module PgHero
       (config["slow_query_calls"] || PgHero.config["slow_query_calls"] || PgHero.slow_query_calls).to_i
     end
 
+    def long_running_query_sec
+      (config["long_running_query_sec"] || PgHero.config["long_running_query_sec"] || PgHero.long_running_query_sec).to_i
+    end
+
     private
 
     def connection_model

data/lib/pghero/methods/indexes.rb

@@ -141,7 +141,7 @@ module PgHero
 
         indexes_by_table = self.indexes.group_by { |i| i["table"] }
         indexes_by_table.values.flatten.select { |i| PgHero.falsey?(i["primary"]) && PgHero.falsey?(i["unique"]) && !i["indexprs"] && !i["indpred"] && PgHero.truthy?(i["valid"]) }.each do |index|
-          covering_index = indexes_by_table[index["table"]].find { |i| index_covers?(i["columns"], index["columns"]) && i["using"] == index["using"] && i["name"] != index["name"] && PgHero.truthy?(i["valid"]) }
+          covering_index = indexes_by_table[index["table"]].find { |i| index_covers?(i["columns"], index["columns"]) && i["using"] == index["using"] && i["name"] != index["name"] && !i["indexprs"] && !i["indpred"] && PgHero.truthy?(i["valid"]) }
           if covering_index
             indexes << {"unneeded_index" => index, "covering_index" => covering_index}
           end

data/lib/pghero/methods/queries.rb

@@ -27,12 +27,12 @@ module PgHero
       end
 
       def long_running_queries
-        running_queries(min_duration: PgHero.long_running_query_sec)
+        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 >= PgHero.slow_query_calls.to_i && q["average_time"].to_i >= PgHero.slow_query_ms.to_i }
+        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

data/lib/pghero/version.rb

@@ -1,3 +1,3 @@
 module PgHero
-  VERSION = "1.5.2"
+  VERSION = "1.5.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pghero
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.5.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-02 00:00:00.000000000 Z
+date: 2016-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord