rails_log_profiling 0.1.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7800e088ecfa2142aa4fad1f77da49da36df9600
+  data.tar.gz: abe57b18ab6d405b3a2a84d2bf867f041f0a5a4c
+SHA512:
+  metadata.gz: 14315a93ed0c74e6086edd7220e1fec2609a9841c7bc9bb8941d2187ad8be70dbac744a2e0adf4fe9ecdf29ea5b7f7618bdf12ded068d71add8fe894cfdeab2a
+  data.tar.gz: bb2ba48c71eb404926f8d1a3188b3f68c779bbbda564fe4fd2494529498dbb18727bfaa007eb8c885e36c8121611224ac6426fce39899e3b5b31d206041f7ae8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,22 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3.0
+  - 2.3.1
+before_install:
+  - gem install bundler
+gemfile:
+  - gemfiles/Gemfile.rails.5.0
+  - gemfiles/Gemfile.rails.4.2
+  - gemfiles/Gemfile.rails.4.1
+  - gemfiles/Gemfile.rails.4.0
+script: "bundle exec rake spec"
+
+matrix:
+  exclude:
+  - rvm: 2.1
+    gemfile: gemfiles/Gemfile.rails.5.0
+  - rvm: 2.2
+    gemfile: gemfiles/Gemfile.rails.5.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 fukumone
+
+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,75 @@
+# Rails::Log::Profiling
+
+![Build Status](https://travis-ci.org/fukumone/rails_log_profiling.svg)
+
+Rails専用のパフォーマンスツール
+ - クエリプロファイリング：クエリを降順、昇順に整理してログに出力
+ - Viewプロファイリング：view、レンダリングにかかったページを降順、昇順に整理してログに出力
+ - メソッドの実行箇所を表示
+
+TODO:
+  - Beta1
+    - クエリプロファイリング機能追加
+  - Beta2
+    - Viewプロファイル機能追加
+    - メソッドの実行箇所検知機能追加
+  - Beta3
+    - Rails4.0、Rails4.1、Rails4.2、Rails5.0正式サポート
+
+## Installation
+
+- gemとしてインストール
+
+```
+$ gem install rails_log_profiling --pre
+```
+
+- gemfileに追加
+
+```
+gem 'rails_log_profiling', '~> 0.1.0.beta1', :group => "development"
+```
+
+## Usage
+  Gemをインストールした状態でRails Serverを起動
+  log/以下にログファイルが作られ、記録されます
+
+```
+$ tail -f log/rails_log_profiling.log
+
+# output
+  PostsController#index
+
+  2件のクエリの検知
+  1:  Post Load (1.4ms)  SELECT `posts`.* FROM `posts`
+
+  2:  Article Load (0.8ms)  SELECT  `articles`.* FROM `articles` ORDER BY `articles`.`id` ASC LIMIT 1
+```
+
+## Configuration
+Rails::Log::Profilingは初期の段階ではなにも行いません、動作させるには
+config/environments/development.rbに下記の設定を追加してください
+
+```:devlopment.rb
+Rails::Log::Profiling.enable = true
+```
+
+Rails::Log::Profilingはオプションが用意されています
+  - `Rails::Log::Profiling.enable`： true => Rails::Log::Profilingを有効にする
+  - `Rails::Log::Profiling.sort_order`: クエリの並び順を指定する、降順はdesc、昇順はascと設定してください。初期設定はdescになっています
+
+## Inspire
+ - [rack-mini-profiler](https://github.com/MiniProfiler/rack-mini-profiler)
+ - [Activerecord::Cause](https://github.com/joker1007/activerecord-cause)
+ - [Bullet](https://github.com/flyerhzm/bullet)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+MIT

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 "rails/log/profiling"
+
+# 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,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/gemfiles/Gemfile.rails.4.0

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec :path => "../"
+
+gem 'rails', '~> 4.0.0'
+gem "rspec"

data/gemfiles/Gemfile.rails.4.1

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec :path => "../"
+
+gem 'rails', '~> 4.1.0'
+gem "rspec"

data/gemfiles/Gemfile.rails.4.2

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec :path => "../"
+
+gem 'rails', '~> 4.2.0'
+gem "rspec"

data/gemfiles/Gemfile.rails.5.0

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec :path => "../"
+
+gem 'rails', '~> 5.0.0'
+gem "rspec"

data/lib/rails/log/profiling/action_controller.rb

@@ -0,0 +1,20 @@
+require 'action_controller'
+
+module ActionController
+  class Base
+    include Rails::Log::Profiling
+    before_action :controller_action_message
+    after_action :logger_execute
+
+    private
+      def controller_action_message
+        controller_name = params[:controller].split("_").map(&:capitalize).join
+        Rails::Log::Profiling.logger.info("\n \033[36m #{controller_name}Controller##{params[:action]}")
+      end
+
+      def logger_execute
+        Rails::Log::Profiling.logger.info("\n \033[36m" + Rails::Log::Profiling.sqls.count.to_s + "件のクエリの検知")
+        Rails::Log::Profiling::QueryProfiling.execute
+      end
+  end
+end

data/lib/rails/log/profiling/logger.rb

@@ -0,0 +1,22 @@
+module Rails
+  module Log
+    module Profiling
+      class Logger
+        def self.run
+          require 'fileutils'
+          root_path = Rails.root.to_s
+          FileUtils.mkdir_p(root_path + '/log')
+          log_file = root_path + '/log/rails_profiling.log'
+          if File.exist?(log_file)
+            f = File.open(log_file, 'a')
+          else
+            f = File.open("#{root_path}/log/rails_profiling.log", 'a+')
+          end
+          f.binmode
+          f.sync = true
+          Rails::Log::Profiling.logger = ActiveSupport::Logger.new f
+        end
+      end
+    end
+  end
+end

data/lib/rails/log/profiling/query_log_subscriber.rb

@@ -0,0 +1,70 @@
+require "active_record"
+require "active_record/log_subscriber"
+
+module Rails::Log::Profiling
+  class QueryLogSubscriber < ActiveRecord::LogSubscriber
+    def sql(event)
+      payload = event.payload
+
+      return if IGNORE_PAYLOAD_NAMES.include?(payload[:name])
+
+      if ActiveRecord.version >= Gem::Version.new("5.0.0.beta")
+        ar_ver_5(event)
+      else
+        ar_ver_4(event)
+      end
+    end
+
+    private
+
+      def ar_ver_5(event)
+        payload = event.payload
+        name  = "#{payload[:name]} (#{event.duration.round(1)}ms)"
+        sql   = payload[:sql]
+        binds = nil
+
+        unless (payload[:binds] || []).empty?
+          binds = "  " + payload[:binds].map { |attr| render_bind(attr) }.inspect
+        end
+
+        name = colorize_payload_name(name, payload[:name])
+        sql  = color(sql, sql_color(sql), true)
+
+        if !name.match(/.*ActiveRecord::SchemaMigration.*/) && name.match(/.*Load.\(.*ms\).*/)
+          Rails::Log::Profiling.sqls << [ "#{event.duration.round(1)}".to_f, "  #{name}  #{sql}#{binds}"]
+        end
+      end
+
+      def ar_ver_4(event)
+        payload = event.payload
+        name  = '%s (%.1fms)' % [payload[:name], event.duration]
+        sql   = payload[:sql].squeeze(' ')
+        binds = nil
+
+        unless (payload[:binds] || []).empty?
+          binds = "  " + payload[:binds].map { |col,v|
+            if col
+              [col.name, v]
+            else
+              [nil, v]
+            end
+          }.inspect
+        end
+
+        if odd?
+          name = color(name, CYAN, true)
+          sql  = color(sql, nil, true)
+        else
+          name = color(name, MAGENTA, true)
+        end
+
+        if !name.match(/.*ActiveRecord::SchemaMigration.*/) && name.match(/.*Load.\(.*ms\).*/)
+          Rails::Log::Profiling.sqls << [ "#{event.duration.round(1)}".to_f, "  #{name}  #{sql}#{binds}" ]
+        end
+      end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  Rails::Log::Profiling::QueryLogSubscriber.attach_to :active_record
+end

data/lib/rails/log/profiling/query_profiling.rb

@@ -0,0 +1,25 @@
+module Rails
+  module Log
+    module Profiling
+      class QueryProfiling
+        def self.execute
+          return if Rails::Log::Profiling.sqls.empty?
+          self.query_sort
+          Rails::Log::Profiling.sqls.each.with_index(1) do |val, ind|
+            Rails::Log::Profiling.logger.debug("\n \033[36m #{ind}:" + val[1]) # colorで出力
+          end
+          Rails::Log::Profiling.sqls.clear
+        end
+
+        protected
+          def self.query_sort
+            if Rails::Log::Profiling.sort_order == "desc"
+              Rails::Log::Profiling.sqls.sort! { |a, b| b[0] <=> a[0] }
+            else # sort_order asc
+              Rails::Log::Profiling.sqls.sort!
+            end
+          end
+      end
+    end
+  end
+end

data/lib/rails/log/profiling/version.rb

@@ -0,0 +1,7 @@
+module Rails
+  module Log
+    module Profiling
+      VERSION = "0.1.0.beta1"
+    end
+  end
+end

data/lib/rails_log_profiling.rb

@@ -0,0 +1,40 @@
+require "rails/log/profiling/version"
+
+module Rails
+  module Log
+    module Profiling
+      include ActiveSupport::Configurable
+
+      config_accessor :logger, instance_accessor: false  do
+        ""
+      end
+
+      config_accessor :sqls, instance_accessor: false  do
+        []
+      end
+
+      config_accessor :enable, instance_accessor: false do
+        false
+      end
+
+      config_accessor :sort_order, instance_accessor: false do
+        "desc"
+      end
+
+      if defined?(Rails)
+        class Railtie < ::Rails::Railtie
+          initializer "rails_log_profiling.configure_rails_initialization" do
+            if Rails::Log::Profiling.enable
+              require 'rails/log/profiling/logger'
+              require 'rails/log/profiling/query_profiling'
+              require 'rails/log/profiling/query_log_subscriber'
+              ::Rails::Log::Profiling::Logger.run
+              require 'rails/log/profiling/action_controller'
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/rails_log_profiling.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails/log/profiling/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_log_profiling"
+  spec.version       = Rails::Log::Profiling::VERSION
+  spec.authors       = ["fukumone"]
+  spec.email         = ["fukuimone@gmail.com"]
+
+  spec.summary       = %q{Rails専用のログプロファイリング}
+  spec.description   = %q{Rails専用のログプロファイリング}
+  spec.homepage      = "https://github.com/fukumone/rails_log_profiling.git"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: rails_log_profiling
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta1
+platform: ruby
+authors:
+- fukumone
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Rails専用のログプロファイリング
+email:
+- fukuimone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/Gemfile.rails.4.0
+- gemfiles/Gemfile.rails.4.1
+- gemfiles/Gemfile.rails.4.2
+- gemfiles/Gemfile.rails.5.0
+- lib/rails/log/profiling/action_controller.rb
+- lib/rails/log/profiling/logger.rb
+- lib/rails/log/profiling/query_log_subscriber.rb
+- lib/rails/log/profiling/query_profiling.rb
+- lib/rails/log/profiling/version.rb
+- lib/rails_log_profiling.rb
+- rails_log_profiling.gemspec
+homepage: https://github.com/fukumone/rails_log_profiling.git
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Rails専用のログプロファイリング
+test_files: []