postgres-vacuum-monitor 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bade52e5e9f33c876eeb297422bb537fdc08385858d5cff63b53534da656435
-  data.tar.gz: f9e898dcfb96040f1b4ea0b6d3f59374bac36b42e2015c9a8c5c30dca9cff5ae
+  metadata.gz: 6c398c3078e1b811e2f20aa747a7163089a18983b27a0f8717bbf0b31c3d6168
+  data.tar.gz: b1fd3ddf77ae9486cf3ed321d47485a69d7f2d6cf219a9281edc33a4defbd3ce
 SHA512:
-  metadata.gz: f3658515adbc097c69990e9c15f6a6b73e735ddd214840e0860ce540a362c3216eeac55f4dfef57c00cb1b59d32a1cb855efa2b6c12d6924021d41b69133d1bb
-  data.tar.gz: 65c6285452b08ee88853ad8f8be2b2bc37f2c2184c9ac1718f2b60c1491d51b8b8fb167b46072a7682c6535cb1aa02fae91cc60791d6640b16638dc208c88fc8
+  metadata.gz: 6c622be7d73d1ffe0232b98e05268aec917681b39e703f5fc82d1fab39faf2117669654e982bf6a04ac12849e2f6b18d33a8d6e98256f4bcaf7afa2d2244471f
+  data.tar.gz: cc422931d00b068cd17354f8fb74dafea4e31bd1fb0a1db94f5c769f505ad8fa14a8a94b681ddb14521336ea2b21b4a10c20cd9e1c1060861e803a1a6a20093e

data/.circleci/config.yml

@@ -0,0 +1,83 @@
+version: 2.1
+jobs:
+  lint:
+    docker:
+      - image: salsify/ruby_ci:2.5.8
+    working_directory: ~/postgres-vacuum-monitor
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-gems-ruby-2.5.8-{{ checksum "postgres-vacuum-monitor.gemspec" }}-{{ checksum "Gemfile" }}
+            - v1-gems-ruby-2.5.8-
+      - run:
+          name: Install Gems
+          command: |
+            if ! bundle check --path=vendor/bundle; then
+              bundle install --path=vendor/bundle --jobs=4 --retry=3
+              bundle clean
+            fi
+      - save_cache:
+          key: v1-gems-ruby-2.5.8-{{ checksum "postgres-vacuum-monitor.gemspec" }}-{{ checksum "Gemfile" }}
+          paths:
+            - "vendor/bundle"
+            - "gemfiles/vendor/bundle"
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop --config .rubocop.yml
+  test:
+    parameters:
+      gemfile:
+        type: string
+    docker:
+      - image: salsify/ruby_ci:2.5.8
+        environment:
+          TEST_DATABASE_URL: postgresql://circleci@localhost/circle_test
+      - image: circleci/postgres:9.6
+        environment:
+          POSTGRES_USER: "ubuntu"
+          POSTGRES_DB: "postgres_vacuum_monitor_test"
+          POSTGRES_HOST_AUTH_METHOD: "trust"
+    environment:
+      RACK_ENV: "test"
+      DB_HOST: 'localhost'
+      DB_USER: 'ubuntu'
+      RAILS_ENV: "test"
+      CIRCLE_TEST_REPORTS: "test-results"
+      BUNDLE_GEMFILE: << parameters.gemfile >>
+    working_directory: ~/postgres-vacuum-monitor
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-gems-ruby-2.5.8-{{ checksum "postgres-vacuum-monitor.gemspec" }}-{{ checksum "<< parameters.gemfile >>" }}
+            - v1-gems-ruby-2.5.8-
+      - run:
+          name: Install Gems
+          command: |
+            if ! bundle check --path=vendor/bundle; then
+              bundle install --path=vendor/bundle --jobs=4 --retry=3
+              bundle clean
+            fi
+      - save_cache:
+          key: v1-gems-ruby-2.5.8-{{ checksum "postgres-vacuum-monitor.gemspec" }}-{{ checksum "<< parameters.gemfile >>" }}
+          paths:
+            - "vendor/bundle"
+            - "gemfiles/vendor/bundle"
+      - run:
+          name: Run Tests
+          command: |
+            bundle exec rspec --format RspecJunitFormatter --out $CIRCLE_TEST_REPORTS/rspec/junit.xml --format progress spec
+      - store_test_results:
+          path: "test-results"
+workflows:
+  build:
+    jobs:
+      - lint
+      - test:
+          matrix:
+            parameters:
+              gemfile:
+                - "gemfiles/activerecord_5_2.gemfile"
+                - "gemfiles/activerecord_6_0.gemfile"
+                - "gemfiles/activerecord_6_1.gemfile"

data/.gitignore

@@ -10,4 +10,5 @@
 .idea/
 Gemfile.lock
 gemfiles/*.gemfile.lock
+gemfiles/.bundle/
 log/

data/.rubocop.yml

@@ -3,3 +3,6 @@ inherit_gem:
 
 AllCops:
   TargetRubyVersion: 2.4
+  Exclude:
+    - 'vendor/**/*'
+    - 'gemfiles/**/*'

data/Appraisals

@@ -1,7 +1,13 @@
-appraise 'activerecord-5' do
-  gem 'activerecord', '< 6.0.0'
+# frozen_string_literal: true
+
+appraise 'activerecord_5_2' do
+  gem 'activerecord', '~> 5.2.0'
+end
+
+appraise 'activerecord_6_0' do
+  gem 'activerecord', '~> 6.0.0'
 end
 
-appraise 'activerecord-6' do
-  gem 'activerecord', '< 6.1'
+appraise 'activerecord_6_1' do
+  gem 'activerecord', '~> 6.1.0'
 end

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # postgres-vacuum-monitor
 
+## v.11.0
+- Add support for rails 6.1
+
 ## v.10.1
 - Query bug fix.
 

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/salsify/postgres-vacuum-monitor.svg?branch=master)](https://travis-ci.org/salsify/postgres-vacuum-monitor)
+[![Build Status](https://circleci.com/gh/salsify/postgres-vacuum-monitor.svg?style=svg)][circleci]
 [![Maintainability](https://api.codeclimate.com/v1/badges/9ced178ca8fee231a935/maintainability)](https://codeclimate.com/github/salsify/postgres-vacuum-monitor/maintainability)
 [![Coverage Status](https://coveralls.io/repos/github/salsify/postgres-vacuum-monitor/badge.svg?branch=master)](https://coveralls.io/github/salsify/postgres-vacuum-monitor?branch=master)
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'bundler/setup'
 Bundler::GemHelper.install_tasks

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "postgres/vacuum/monitor"
+require 'bundler/setup'
+require 'postgres/vacuum/monitor'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "postgres/vacuum/monitor"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/gemfiles/activerecord_5_2.gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+# ActiveRecord is used to connect to DBs
+gem 'activerecord', '~> 5.2.0'
+
+gemspec path: '../'

data/gemfiles/activerecord_6_0.gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+# ActiveRecord is used to connect to DBs
+gem 'activerecord', '~> 6.0.0'
+
+gemspec path: '../'

data/gemfiles/activerecord_6_1.gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+# ActiveRecord is used to connect to DBs
+gem 'activerecord', '~> 6.1.0'
+
+gemspec path: '../'

data/lib/postgres/vacuum/compatibility.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Postgres
+  module Vacuum
+    class Compatibility
+      ACTIVE_RECORD_VERSION = ::Gem::Version.new(::ActiveRecord::VERSION::STRING).release
+      PRE_RAILS_6_1 = ACTIVE_RECORD_VERSION < ::Gem::Version.new('6.1.0')
+
+      def self.pre_rails_6_1?
+        PRE_RAILS_6_1
+      end
+
+    end
+  end
+end

data/lib/postgres/vacuum/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Postgres
   module Vacuum
     class Configuration

data/lib/postgres/vacuum/jobs/monitor_job.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module Postgres
   module Vacuum
     module Jobs
       class MonitorJob
 
-        AUTOVACUUM_LAGGING_EVENT = 'AutoVacuumLagging'.freeze
-        LONG_TRANSACTIONS = 'LongTransactions'.freeze
-        BLOCKED_QUERIES = 'BlockedQueries'.freeze
-        CONNECTION_STATE = 'ConnectionState'.freeze
-        CONNECTION_IDLE_TIME = 'ConnectionIdleTime'.freeze
+        AUTOVACUUM_LAGGING_EVENT = 'AutoVacuumLagging'
+        LONG_TRANSACTIONS = 'LongTransactions'
+        BLOCKED_QUERIES = 'BlockedQueries'
+        CONNECTION_STATE = 'ConnectionState'
+        CONNECTION_IDLE_TIME = 'ConnectionIdleTime'
 
         def perform(*)
           with_each_db_name_and_connection do |name, connection|
@@ -51,7 +53,12 @@ module Postgres
             end
 
             connection.execute(Postgres::Vacuum::Monitor::Query.connection_state).each do |row|
-              reporter_class.report_event(CONNECTION_STATE, database_name: name, state: row['state'], connection_count: row['connection_count'])
+              reporter_class.report_event(
+                CONNECTION_STATE,
+                database_name: name,
+                state: row['state'],
+                connection_count: row['connection_count']
+              )
             end
 
             connection.execute(Postgres::Vacuum::Monitor::Query.connection_idle_time).each do |row|
@@ -72,7 +79,9 @@ module Postgres
           return @reporter_class_name if @reporter_class_name
 
           @reporter_class_name = Postgres::Vacuum::Monitor.configuration.monitor_reporter_class_name&.safe_constantize
-          raise ConfigurationError.new('Missing or invalid report class name. Check your configuration') if @reporter_class_name.nil?
+          if @reporter_class_name.nil?
+            raise ConfigurationError.new('Missing or invalid report class name. Check your configuration')
+          end
 
           @reporter_class_name
         end
@@ -80,7 +89,12 @@ module Postgres
         def with_each_db_name_and_connection
           databases = Set.new
           ActiveRecord::Base.connection_handler.connection_pools.map do |connection_pool|
-            db_name = connection_pool.spec.config[:database]
+            db_name = if Postgres::Vacuum::Compatibility.pre_rails_6_1?
+                        connection_pool.spec.config[:database]
+                      else
+                        connection_pool.db_config.configuration_hash[:database]
+                      end
+
             # activerecord allocates a connection pool per call to establish_connection
             # multiple pools might interact with the same database so we use the
             # database name to dedup

data/lib/postgres/vacuum/monitor.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'active_record'
+require 'postgres/vacuum/compatibility'
 require 'postgres/vacuum/configuration'
 require 'postgres/vacuum/monitor/version'
 require 'postgres/vacuum/monitor/query'
@@ -12,7 +15,7 @@ module Postgres
       end
 
       def self.configuration
-        @config ||= Configuration.new
+        @configuration ||= Configuration.new
       end
 
       def self.reset

data/lib/postgres/vacuum/monitor/query.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Postgres
   module Vacuum
     module Monitor
@@ -5,10 +7,10 @@ module Postgres
         extend self
 
         STATES = ["'idle in transaction'", "'active'"].freeze
-        THRESHOLD_SETTING = "'autovacuum_vacuum_threshold'".freeze
-        SCALE_FACTOR_SETTING = "'autovacuum_vacuum_scale_factor'".freeze
-        MAX_AGE_SETTING = "'autovacuum_freeze_max_age'".freeze
-        PG_CATALOG = "'pg_catalog'".freeze
+        THRESHOLD_SETTING = "'autovacuum_vacuum_threshold'"
+        SCALE_FACTOR_SETTING = "'autovacuum_vacuum_scale_factor'"
+        MAX_AGE_SETTING = "'autovacuum_freeze_max_age'"
+        PG_CATALOG = "'pg_catalog'"
 
         def long_running_transactions
           <<-SQL
@@ -81,7 +83,7 @@ module Postgres
               blocking_activity.application_name AS blocking_application
             FROM pg_catalog.pg_locks blocked_locks
             JOIN pg_catalog.pg_stat_activity blocked_activity  ON blocked_activity.pid = blocked_locks.pid
-            JOIN pg_catalog.pg_locks blocking_locks 
+            JOIN pg_catalog.pg_locks blocking_locks
               ON blocking_locks.locktype = blocked_locks.locktype
               AND blocking_locks.DATABASE IS NOT DISTINCT FROM blocked_locks.DATABASE
               AND blocking_locks.relation IS NOT DISTINCT FROM blocked_locks.relation
@@ -100,10 +102,10 @@ module Postgres
 
         def connection_state
           <<-SQL
-            SELECT 
-              state, count(*) as connection_count 
-            FROM pg_stat_activity 
-            GROUP BY state 
+            SELECT
+              state, count(*) as connection_count
+            FROM pg_stat_activity
+            GROUP BY state
             ORDER BY connection_count DESC;
           SQL
         end

data/lib/postgres/vacuum/monitor/version.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Postgres
   module Vacuum
     module Monitor
-      VERSION = '0.10.1'.freeze
+      VERSION = '0.11.0'
     end
   end
 end

data/postgres-vacuum-monitor.gemspec

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'postgres/vacuum/monitor/version'
 
@@ -10,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['fgarces@salsify.com']
 
   spec.summary       = 'Simple stats collector for postgres auto vacuumer.'
-  spec.description   = 'Queries the Active Record DB for information regarding the auto vacuum process and long running queries.'
+  spec.description   = 'Queries ActiveRecord DBs for info regarding auto vacuum processes and long running queries.'
   spec.homepage      = 'https://github.com/salsify/postgres-vacuum-monitor'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
@@ -26,10 +27,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'coveralls_reborn', '>= 0.18.0'
   spec.add_development_dependency 'database_cleaner'
-  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rspec_junit_formatter'
   spec.add_development_dependency 'salsify_rubocop'
 
-  spec.add_dependency 'activerecord', '>= 5', '< 6.1'
+  spec.add_dependency 'activerecord', '< 6.2.0'
   spec.add_dependency 'pg', '>= 0.18', '< 2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postgres-vacuum-monitor
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Fernando Garces
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2020-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: salsify_rubocop
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,25 +109,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: salsify_rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: 6.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: 6.2.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -148,18 +156,18 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: Queries the Active Record DB for information regarding the auto vacuum
-  process and long running queries.
+description: Queries ActiveRecord DBs for info regarding auto vacuum processes and
+  long running queries.
 email:
 - fgarces@salsify.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -169,8 +177,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- gemfiles/activerecord_5.gemfile
-- gemfiles/activerecord_6.gemfile
+- gemfiles/activerecord_5_2.gemfile
+- gemfiles/activerecord_6_0.gemfile
+- gemfiles/activerecord_6_1.gemfile
+- lib/postgres/vacuum/compatibility.rb
 - lib/postgres/vacuum/configuration.rb
 - lib/postgres/vacuum/jobs/monitor_job.rb
 - lib/postgres/vacuum/monitor.rb

data/.travis.yml

@@ -1,14 +0,0 @@
-language: ruby
-rvm:
- - 2.5.8
- - 2.6.6
- - 2.7.1
-gemfile:
- - gemfiles/activerecord_5.gemfile
- - gemfiles/activerecord_6.gemfile
-services:
- - postgresql
-before_script:
- - psql -c 'create database postgres_vacuum_monitor_test;' -U postgres
-addons:
-  postgresql: '9.6'

data/gemfiles/activerecord_5.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "< 6.0.0"
-
-gemspec path: "../"

data/gemfiles/activerecord_6.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "< 6.1"
-
-gemspec path: "../"