pghero 1.2.2 → 1.2.3

data/lib/pghero/methods/system.rb

@@ -0,0 +1,70 @@
+module PgHero
+  module Methods
+    module System
+      def cpu_usage
+        rds_stats("CPUUtilization")
+      end
+
+      def connection_stats
+        rds_stats("DatabaseConnections")
+      end
+
+      def replication_lag_stats
+        rds_stats("ReplicaLag")
+      end
+
+      def read_iops_stats
+        rds_stats("ReadIOPS")
+      end
+
+      def write_iops_stats
+        rds_stats("WriteIOPS")
+      end
+
+      def rds_stats(metric_name)
+        if system_stats_enabled?
+          client =
+            if defined?(Aws)
+              Aws::CloudWatch::Client.new(access_key_id: access_key_id, secret_access_key: secret_access_key)
+            else
+              AWS::CloudWatch.new(access_key_id: access_key_id, secret_access_key: secret_access_key).client
+            end
+
+          now = Time.now
+          resp = client.get_metric_statistics(
+            namespace: "AWS/RDS",
+            metric_name: metric_name,
+            dimensions: [{name: "DBInstanceIdentifier", value: db_instance_identifier}],
+            start_time: (now - 1 * 3600).iso8601,
+            end_time: now.iso8601,
+            period: 60,
+            statistics: ["Average"]
+          )
+          data = {}
+          resp[:datapoints].sort_by { |d| d[:timestamp] }.each do |d|
+            data[d[:timestamp]] = d[:average]
+          end
+          data
+        else
+          {}
+        end
+      end
+
+      def system_stats_enabled?
+        !!((defined?(Aws) || defined?(AWS)) && access_key_id && secret_access_key && db_instance_identifier)
+      end
+
+      def access_key_id
+        ENV["PGHERO_ACCESS_KEY_ID"] || ENV["AWS_ACCESS_KEY_ID"]
+      end
+
+      def secret_access_key
+        ENV["PGHERO_SECRET_ACCESS_KEY"] || ENV["AWS_SECRET_ACCESS_KEY"]
+      end
+
+      def db_instance_identifier
+        databases[current_database].db_instance_identifier
+      end
+    end
+  end
+end

data/lib/pghero/methods/tables.rb

@@ -0,0 +1,68 @@
+module PgHero
+  module Methods
+    module Tables
+      def table_hit_rate
+        select_all(<<-SQL
+          SELECT
+            sum(heap_blks_hit) / nullif(sum(heap_blks_hit) + sum(heap_blks_read), 0) AS rate
+          FROM
+            pg_statio_user_tables
+        SQL
+        ).first["rate"].to_f
+      end
+
+      def table_caching
+        select_all <<-SQL
+          SELECT
+            relname AS table,
+            CASE WHEN heap_blks_hit + heap_blks_read = 0 THEN
+              0
+            ELSE
+              ROUND(1.0 * heap_blks_hit / (heap_blks_hit + heap_blks_read), 2)
+            END AS hit_rate
+          FROM
+            pg_statio_user_tables
+          ORDER BY
+            2 DESC, 1
+        SQL
+      end
+
+      def unused_tables
+        select_all <<-SQL
+          SELECT
+            schemaname AS schema,
+            relname AS table,
+            n_live_tup rows_in_table
+          FROM
+            pg_stat_user_tables
+          WHERE
+            idx_scan = 0
+          ORDER BY
+            n_live_tup DESC,
+            relname ASC
+         SQL
+      end
+
+      def table_stats(options = {})
+        schema = options[:schema]
+        tables = options[:table] ? Array(options[:table]) : nil
+        select_all <<-SQL
+          SELECT
+            nspname AS schema,
+            relname AS table,
+            reltuples::bigint
+          FROM
+            pg_class
+          INNER JOIN
+            pg_namespace ON pg_namespace.oid = pg_class.relnamespace
+          WHERE
+            relkind = 'r'
+            AND nspname = #{quote(schema)}
+            #{tables ? "AND relname IN (#{tables.map { |t| quote(t) }.join(", ")})" : nil}
+          ORDER BY
+            1, 2
+        SQL
+      end
+    end
+  end
+end

data/lib/pghero/methods/users.rb

@@ -0,0 +1,85 @@
+module PgHero
+  module Methods
+    module Users
+      def create_user(user, options = {})
+        password = options[:password] || random_password
+        schema = options[:schema] || "public"
+        database = options[:database] || connection_model.connection_config[:database]
+
+        commands =
+          [
+            "CREATE ROLE #{user} LOGIN PASSWORD #{quote(password)}",
+            "GRANT CONNECT ON DATABASE #{database} TO #{user}",
+            "GRANT USAGE ON SCHEMA #{schema} TO #{user}"
+          ]
+        if options[:readonly]
+          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
+          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
+        connection_model.transaction do
+          commands.each do |command|
+            execute command
+          end
+        end
+
+        {password: password}
+      end
+
+      def drop_user(user, options = {})
+        schema = options[:schema] || "public"
+        database = options[:database] || connection_model.connection_config[:database]
+
+        # thanks shiftb
+        commands =
+          [
+            "REVOKE CONNECT ON DATABASE #{database} FROM #{user}",
+            "REVOKE USAGE ON SCHEMA #{schema} FROM #{user}",
+            "REVOKE ALL PRIVILEGES ON ALL TABLES IN SCHEMA #{schema} FROM #{user}",
+            "REVOKE ALL PRIVILEGES ON ALL SEQUENCES IN SCHEMA #{schema} FROM #{user}",
+            "ALTER DEFAULT PRIVILEGES IN SCHEMA #{schema} REVOKE SELECT ON TABLES FROM #{user}",
+            "ALTER DEFAULT PRIVILEGES IN SCHEMA #{schema} REVOKE SELECT ON SEQUENCES FROM #{user}",
+            "ALTER DEFAULT PRIVILEGES IN SCHEMA #{schema} REVOKE ALL ON SEQUENCES FROM #{user}",
+            "ALTER DEFAULT PRIVILEGES IN SCHEMA #{schema} REVOKE ALL ON TABLES FROM #{user}",
+            "DROP ROLE #{user}"
+          ]
+
+        # run commands
+        connection_model.transaction do
+          commands.each do |command|
+            execute command
+          end
+        end
+
+        true
+      end
+
+      private
+
+      def random_password
+        require "securerandom"
+        SecureRandom.base64(40).delete("+/=")[0...24]
+      end
+
+      def table_grant_commands(privilege, tables, user)
+        tables.map do |table|
+          "GRANT #{privilege} ON TABLE #{table} TO #{user}"
+        end
+      end
+    end
+  end
+end

data/lib/pghero/query_stats.rb

@@ -0,0 +1,7 @@
+module PgHero
+  class QueryStats < ActiveRecord::Base
+    self.abstract_class = true
+    self.table_name = "pghero_query_stats"
+    establish_connection ENV["PGHERO_STATS_DATABASE_URL"] if ENV["PGHERO_STATS_DATABASE_URL"]
+  end
+end

data/lib/pghero/version.rb

@@ -1,3 +1,3 @@
 module PgHero
-  VERSION = "1.2.2"
+  VERSION = "1.2.3"
 end

data/lib/{pghero/tasks.rb → tasks/pghero.rake}

@@ -1,5 +1,3 @@
-require "rake"
-
 namespace :pghero do
   desc "capture query stats"
   task capture_query_stats: :environment do

data/test/suggested_indexes_test.rb

@@ -6,9 +6,10 @@ class SuggestedIndexesTest < Minitest::Test
   end
 
   def test_basic
+    # no pg_stat_statements
+    skip if ENV["TRAVIS_CI"]
+
     User.where(email: "person1@example.org").first
-    # User.where(email: "person1@example.org", city_id: 1).first
-    # User.where(city_id: 1).to_a
     assert_equal [{table: "users", columns: ["email"]}], PgHero.suggested_indexes.map { |q| q.except(:queries, :details) }
   end
 end

data/test/test_helper.rb

@@ -23,7 +23,7 @@ end
 class User < ActiveRecord::Base
 end
 
-if ENV["SEED"]
+unless ENV["SKIP_SEED"]
   ActiveRecord::Migration.create_table :users, force: true do |t|
     t.integer :city_id
     t.integer :login_attempts

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pghero
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-21 00:00:00.000000000 Z
+date: 2016-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -116,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -148,16 +149,30 @@ files:
 - lib/generators/pghero/query_stats_generator.rb
 - lib/generators/pghero/templates/query_stats.rb
 - lib/pghero.rb
+- lib/pghero/connection.rb
 - lib/pghero/database.rb
 - lib/pghero/engine.rb
-- lib/pghero/tasks.rb
+- lib/pghero/methods/basic.rb
+- lib/pghero/methods/connections.rb
+- lib/pghero/methods/databases.rb
+- lib/pghero/methods/explain.rb
+- lib/pghero/methods/indexes.rb
+- lib/pghero/methods/kill.rb
+- lib/pghero/methods/maintenance.rb
+- lib/pghero/methods/queries.rb
+- lib/pghero/methods/query_stats.rb
+- lib/pghero/methods/replica.rb
+- lib/pghero/methods/space.rb
+- lib/pghero/methods/suggested_indexes.rb
+- lib/pghero/methods/system.rb
+- lib/pghero/methods/tables.rb
+- lib/pghero/methods/users.rb
+- lib/pghero/query_stats.rb
 - lib/pghero/version.rb
+- lib/tasks/pghero.rake
 - pghero.gemspec
 - test/best_index_test.rb
 - test/explain_test.rb
-- test/gemfiles/activerecord31.gemfile
-- test/gemfiles/activerecord32.gemfile
-- test/gemfiles/activerecord40.gemfile
 - test/suggested_indexes_test.rb
 - test/test_helper.rb
 homepage: https://github.com/ankane/pghero
@@ -180,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.1
 signing_key: 
 specification_version: 4
 summary: The missing dashboard for Postgres
@@ -193,9 +208,6 @@ test_files:
 - guides/Suggested-Indexes.md
 - test/best_index_test.rb
 - test/explain_test.rb
-- test/gemfiles/activerecord31.gemfile
-- test/gemfiles/activerecord32.gemfile
-- test/gemfiles/activerecord40.gemfile
 - test/suggested_indexes_test.rb
 - test/test_helper.rb
 has_rdoc: 

data/test/gemfiles/activerecord31.gemfile

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in searchkick.gemspec
-gemspec path: "../../"
-
-gem "activerecord", "~> 3.1.0"

data/test/gemfiles/activerecord32.gemfile

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in searchkick.gemspec
-gemspec path: "../../"
-
-gem "activerecord", "~> 3.2.0"

data/test/gemfiles/activerecord40.gemfile

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in searchkick.gemspec
-gemspec path: "../../"
-
-gem "activerecord", "~> 4.0.0"