Merge pull request #4 from instacart/jeffdoering/placeholder_capture_…

…blockers_rake_task

Placeholder integration hooks for rake task pghero:capture_query_bloc…

lib/pghero.rb

@@ -134,6 +134,16 @@ def capture_connection_stats(verbose: false)
       end
     end
 
+    def capture_query_blockers(verbose: false)
+      each_database do |database|
+        next unless database.capture_query_blockers?
+
+        puts "(Simulating) Capturing query blockers for #{database.id}..." if verbose
+        # TODO: actually implement database.capture_query_blockers
+      end
+      true
+    end
+
     def analyze_all(**options)
       each_database do |database|
         next if database.replica?

lib/pghero/database.rb

@@ -36,6 +36,10 @@ def capture_query_stats?
       config["capture_query_stats"] != false
     end
 
+    def capture_query_blockers?
+      config["capture_query_blockers"] != false
+    end
+
     def cache_hit_rate_threshold
       (config["cache_hit_rate_threshold"] || PgHero.config["cache_hit_rate_threshold"] || PgHero.cache_hit_rate_threshold).to_i
     end

lib/tasks/pghero.rake

@@ -14,6 +14,11 @@ namespace :pghero do
     PgHero.capture_connection_stats(verbose: true)
   end
 
+  desc 'capture_query_blockers'
+  task capture_query_blockers: :environment do
+    PgHero.capture_query_blockers(verbose: true)
+  end
+
   desc "analyze tables"
   task analyze: :environment do
     PgHero.analyze_all(verbose: true, min_size: ENV["MIN_SIZE_GB"].to_f.gigabytes)

test/capture_test.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'test_helper'
+
+class CaptureTest < Minitest::Test
+
+  def test_capture_query_blockers
+    # TODO: test needs to be in a transaction rollback as soon
+    # as capture_query_blockers implements real inserts
+    assert PgHero.capture_query_blockers(verbose: true)
+  end
+
+end