ganeshan 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 376a01f404d1f85b76e56c668faabc6a6fa67b6b4f16535bf00fa90c33534800
+  data.tar.gz: 26eaf6346c7a3dacbf917a495cfd0193d2c3ff3488345ba37eb63243d540e665
+SHA512:
+  metadata.gz: c709b5a4b2db67451e36ed5a87b4405fea582b5d3016bb56a3a5dffb63b760568cefedd59652cecc55dd1c38ca6efbbf5bc82f424aedade75f96c566dec855dd
+  data.tar.gz: 5d5b3b3f970b488a81d18ea8255c83dfce902b959883a2c8ec58c53befd24c18f954ec53d796fc8dd95fa70885c0931a07af90b1adc30338b5d98666a808f460

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mkawasaki@sbihg.co.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ganesh.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    ganeshan (0.1.0)
+      activerecord
+      coderay
+      pg
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.1)
+    pg (1.2.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ganeshan!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Masumi Kawasaki
+
+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,152 @@
+# Ganeshan
+
+Ganeshan is a gem to find slow query with EXPAIN.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ganeshan'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ganeshan
+
+## Usage
+
+You can enable it with config/environments/development.rb
+```rb
+Ganeshan.enabled = true
+```
+
+Or You can use it without rails, but with active_record.
+
+```rb
+#!/usr/bin/env ruby
+
+require "bundler/inline"
+
+gemfile(true) do
+  source "https://rubygems.org"
+  git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+  gem "ganeshan"
+end
+
+
+require 'active_record'
+require 'ganeshan'
+
+ActiveRecord::Base.establish_connection(
+  host:     '127.0.0.1',
+  adapter:  'postgresql',
+  username: 'hoge',
+  password: 'password',
+  database: 'ganeshan'
+)
+
+Ganeshan.enabled = true
+
+ActiveRecord::Schema.define do
+  create_table :products, force: true do |t|
+    t.text :name
+  end
+end
+
+class Product < ActiveRecord::Base
+end
+
+p Product.all.to_a.count
+p Product.all
+p Product.limit(1)
+p Product.where(id: 1).limit(10)
+```
+
+then, output is like this.
+
+```rb
+Ganeshan  INFO    2020-08-14 02:30:34 +0900       {
+  "sql": "SELECT \"products\".* FROM \"products\"",
+  "explain": [
+    {
+      "line": 1,
+      "QUERY PLAN": "Seq Scan on products  (cost=0.00..22.00 rows=1200 width=40)"
+    }
+  ]
+}
+2
+
+Ganeshan  INFO    2020-08-14 02:30:34 +0900       {
+  "sql": "SELECT \"products\".* FROM \"products\" LIMIT $1",
+  "explain": [
+    {
+      "line": 1,
+      "QUERY PLAN": "Limit  (cost=0.00..0.20 rows=11 width=40)"
+    },
+    {
+      "line": 2,
+      "QUERY PLAN": "  ->  Seq Scan on products  (cost=0.00..22.00 rows=1200 width=40)"
+    }
+  ]
+}
+#<ActiveRecord::Relation [#<Product id: 2, name: "test2">, #<Product id: 1, name: "test1">]>
+
+Ganeshan  INFO    2020-08-14 02:30:34 +0900       {
+  "sql": "SELECT \"products\".* FROM \"products\" LIMIT $1",
+  "explain": [
+    {
+      "line": 1,
+      "QUERY PLAN": "Limit  (cost=0.00..0.02 rows=1 width=40)"
+    },
+    {
+      "line": 2,
+      "QUERY PLAN": "  ->  Seq Scan on products  (cost=0.00..22.00 rows=1200 width=40)"
+    }
+  ]
+}
+#<ActiveRecord::Relation [#<Product id: 2, name: "test2">]>
+
+Ganeshan  INFO    2020-08-14 02:30:34 +0900       {
+  "sql": "SELECT \"products\".* FROM \"products\" WHERE \"products\".\"id\" = $1 LIMIT $2",
+  "explain": [
+    {
+      "line": 1,
+      "QUERY PLAN": "Limit  (cost=0.15..8.17 rows=1 width=40)"
+    },
+    {
+      "line": 2,
+      "QUERY PLAN": "  ->  Index Scan using products_pkey on products  (cost=0.15..8.17 rows=1 width=40)"
+    },
+    {
+      "line": 3,
+      "QUERY PLAN": "        Index Cond: (id = '1'::bigint)"
+    }
+  ]
+}
+#<ActiveRecord::Relation [#<Product id: 1, name: "test1">]>
+
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/geeknees/ganeshan. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/geeknees/ganeshan/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ganeshan project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/geeknees/ganeshan/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ganesh"
+
+# 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(__FILE__)

data/bin/setup

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

data/ganeshan.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/ganeshan/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ganeshan"
+  spec.version       = Ganeshan::VERSION
+  spec.authors       = ["Masumi Kawasaki"]
+  spec.email         = ["mkawasaki@sbihg.co.jp"]
+
+  spec.summary       = %q{show EXPLAIN log with postgresql.}
+  spec.description   = %q{show EXPLAIN log with postgresql to help in detecting slow queries.}
+  spec.homepage      = "https://github.com/geeknees/ganeshan"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/geeknees/ganeshan"
+  spec.metadata["changelog_uri"] = "https://github.com/geeknees/ganeshan"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'coderay'
+  spec.add_dependency 'pg'
+end

data/lib/ganeshan.rb

@@ -0,0 +1,15 @@
+require 'logger'
+require 'active_support'
+require 'coderay'
+require 'pg'
+
+require 'ganeshan/config'
+require 'ganeshan/error'
+require 'ganeshan/explainer'
+require 'ganeshan/json_logger'
+require 'ganeshan/version'
+
+ActiveSupport.on_load :active_record do
+  require 'active_record/connection_adapters/postgresql_adapter'
+  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend Ganeshan::Explainer
+end

data/lib/ganeshan/config.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Ganeshan
+  @enabled = (/\A(1|true)\z/i =~ ENV['GANESH_ENABLED'])
+
+  @logger = Logger.new(ENV['GANESH_LOG'] || $stdout).tap do |logger|
+    logger.formatter = lambda do |severity, datetime, _progname, msg|
+      "\n#{self}\t#{severity}\t#{datetime}\t#{msg}\n"
+    end
+  end
+
+  class << self
+    attr_accessor :enabled,
+                  :logger,
+                  :connection
+  end
+end

data/lib/ganeshan/error.rb

@@ -0,0 +1,4 @@
+module Ganeshan
+  class Error < StandardError
+  end
+end

data/lib/ganeshan/explainer.rb

@@ -0,0 +1,45 @@
+module Ganeshan
+  module Explainer
+    def exec_query(*args)
+      p args
+      _with_explain(sql: args.first, binds: args[2]) do
+        super
+      end
+    end
+
+    private
+
+    def _with_explain(sql:, binds:)
+      begin
+        if Ganeshan.enabled && sql =~ /\A\s*SELECT\b/i
+          conn = Ganeshan.connection || raw_connection
+
+          type_casted_binds = if binds
+                                type_casted_binds(binds)
+                              else
+                                []
+                              end
+
+          if type_casted_binds.empty?
+            exp = conn.query("EXPLAIN #{sql}").to_a
+          else
+            exp = conn.query("EXPLAIN #{sql}", type_casted_binds).to_a
+          end
+
+          _validate_explain(sql: sql, exp: exp)
+        end
+      rescue StandardError => e
+        Ganeshan.logger.error("#{e}\n\t#{e.backtrace.join("\n\t")}")
+      end
+
+      yield
+    end
+
+    def _validate_explain(sql:, exp:)
+      Ganeshan::JsonLogger.log(
+        sql: sql,
+        explain: exp,
+      )
+    end
+  end
+end

data/lib/ganeshan/json_logger.rb

@@ -0,0 +1,15 @@
+module Ganeshan
+  module JsonLogger
+    module_function
+
+    def log(sql:, explain:)
+      h = {
+        sql: sql,
+        explain: explain.each_with_index.map { |r, i| { line: i + 1 }.merge(r) },
+      }
+
+      line = CodeRay.scan(JSON.pretty_generate(h), :json).terminal
+      Ganeshan.logger.info(line)
+    end
+  end
+end

data/lib/ganeshan/version.rb

@@ -0,0 +1,3 @@
+module Ganeshan
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: ganeshan
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masumi Kawasaki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: show EXPLAIN log with postgresql to help in detecting slow queries.
+email:
+- mkawasaki@sbihg.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ganeshan.gemspec
+- lib/.DS_Store
+- lib/ganeshan.rb
+- lib/ganeshan/config.rb
+- lib/ganeshan/error.rb
+- lib/ganeshan/explainer.rb
+- lib/ganeshan/json_logger.rb
+- lib/ganeshan/version.rb
+homepage: https://github.com/geeknees/ganeshan
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/geeknees/ganeshan
+  source_code_uri: https://github.com/geeknees/ganeshan
+  changelog_uri: https://github.com/geeknees/ganeshan
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: show EXPLAIN log with postgresql.
+test_files: []