active_record-postgresql_analyzer 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 48346e9b45b296079f47b4f8e6ab72cdfcb0dd22
+  data.tar.gz: cea9476bc847cd85b0372c2248439d13af34a581
+SHA512:
+  metadata.gz: fa34f74a917896807b0df17d664402443964671e29aa7ed07b1f238b589cb84fd59ce0da8c4af9c29479bad478d46f4447d810c2a4680eeb1c52aa16903f08aa
+  data.tar.gz: 01b4c486af1fa7c0e16a205cb06220704c14244faf509730570bac382d2cc739d622c1a3c9cdded3f49101b1b0eda9acb089cacba09b3df3594bfa6427353b3c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+gemfiles/*.lock
+gemfiles/.bundle
+gemfiles/vendor

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.3
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_record-postgresql_analyzer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 M3, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# ActiveRecord::PostgreSQLAnalyzer
+
+[![Gem Version](https://badge.fury.io/rb/active_record-postgresql_analyzer.svg)](https://badge.fury.io/rb/active_record-postgresql_analyzer)
+
+Analyze the execution plan and write log if sequential scan is detected.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record-postgresql_analyzer', group: :development
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_record-postgresql_analyzer
+
+## Usage
+
+Output to a logfile if sequential scan is detected.
+
+```console
+------------ find Seq Scan query ------------
+SELECT  "todo".* FROM "todo" WHERE "todo"."user_id" = $1 LIMIT 1
+                                         QUERY PLAN
+---------------------------------------------------------------------------------------------
+ Limit  (cost=10000000000.00..10000000001.67 rows=1 width=81)
+   ->  Seq Scan on todo  (cost=10000000000.00..10000000001.67 rows=1 width=81)
+         Filter: (user_id = 13)
+(3 rows)
+
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/m3dev/active_record-postgresql_analyzer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,25 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
+
+namespace :spec do
+  Dir::glob('gemfiles/*.gemfile').each do |gemfile|
+    task_name = File.basename gemfile
+    desc "Run Tests by #{gemfile}"
+    task task_name do
+      Bundler.with_clean_env do
+        sh "BUNDLE_GEMFILE='#{gemfile}' bundle install --path vendor/bundle"
+        sh "BUNDLE_GEMFILE='#{gemfile}' bundle exec rspec"
+      end
+    end
+  end
+
+  desc "Run All Tests"
+  task :all do
+    Dir::glob('gemfiles/*.gemfile').each do |gemfile|
+      Rake::Task["spec:#{File.basename(gemfile)}"].invoke
+    end
+  end
+end

data/active_record-postgresql_analyzer.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/postgresql_analyzer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_record-postgresql_analyzer"
+  spec.version       = ActiveRecord::PostgreSQLAnalyzer::VERSION
+  spec.authors       = ["Takayuki Matsubara"]
+  spec.email         = ["takayuki.1229@gmail.com"]
+
+  spec.summary       = %q{Analyze the execution plan and write log if sequential scan is detected}
+  spec.description   = %q{Analyze the execution plan and write log if sequential scan is detected}
+  spec.homepage      = "https://github.com/m3dev/active_record-postgresql_analyzer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activerecord", ">= 3.2"
+
+  spec.add_development_dependency "bundler", ">= 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pg"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_record/postgresql_analyzer"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/3.2.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 3.2.0'
+
+gemspec path: '../'

data/gemfiles/4.1.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 4.1.0'
+
+gemspec path: '../'

data/gemfiles/4.2.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 4.2.0'
+
+gemspec path: '../'

data/lib/active_record/postgresql_analyzer.rb

@@ -0,0 +1,43 @@
+require "active_record"
+require "active_record/log_subscriber"
+
+require "active_record/postgresql_analyzer/version"
+
+module ActiveRecord
+  module PostgreSQLAnalyzer
+    class LogSubscriber < ActiveRecord::LogSubscriber
+      IGNORED_PAYLOADS = %w(SCHEMA EXPLAIN CACHE)
+      EXPLAINED_SQLS = /\A\s*(select|update|delete|insert)\b/i
+      SEQ_SCAN = /.*Seq Scan.*/
+
+      def sql(event)
+        payload = event.payload
+
+        return if ignore_payload?(payload)
+
+        # disable SeqScan when index exists
+        #   SEE ALSO: http://www.postgresql.org/docs/9.4/static/indexes-examine.html
+        ActiveRecord::Base.connection.execute("SET enable_seqscan TO off", "SCHEMA")
+
+        explain_result = ActiveRecord::Base.connection.explain(payload[:sql], payload[:binds])
+        if seq_scan?(explain_result)
+          debug '------------ find Seq Scan query ------------'
+          debug payload[:sql]
+          debug explain_result
+        end
+      end
+
+      def ignore_payload?(payload)
+        payload[:exception] || IGNORED_PAYLOADS.include?(payload[:name]) || payload[:sql] !~ EXPLAINED_SQLS
+      end
+
+      def seq_scan?(explain_result)
+        explain_result =~ SEQ_SCAN
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::PostgreSQLAnalyzer::LogSubscriber.attach_to :active_record
+end

data/lib/active_record/postgresql_analyzer/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module PostgreSQLAnalyzer
+    VERSION = "0.2.0"
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: active_record-postgresql_analyzer
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Takayuki Matsubara
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Analyze the execution plan and write log if sequential scan is detected
+email:
+- takayuki.1229@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record-postgresql_analyzer.gemspec
+- bin/console
+- bin/setup
+- gemfiles/3.2.gemfile
+- gemfiles/4.1.gemfile
+- gemfiles/4.2.gemfile
+- lib/active_record/postgresql_analyzer.rb
+- lib/active_record/postgresql_analyzer/version.rb
+homepage: https://github.com/m3dev/active_record-postgresql_analyzer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Analyze the execution plan and write log if sequential scan is detected
+test_files: []