gctools-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cdc8d15dffd87f6c054da68038632f4cd243c5ad
+  data.tar.gz: c9ef627da0520a515ea2b0e5c1abca7640871aef
+SHA512:
+  metadata.gz: 7c0a16a9246b01abea5bf153bd134d50bd44dba208db076552eb4862020929e599cd708ece77ea3c1121cef139f6b93b8f4bb391c7b0b385ad4d76308a4c0789
+  data.tar.gz: c8495fbadbb6deb50f1fd2a2aa336277e051dd8a56ef0ed8498a921e7a90980d67f465f4446df26a9b2cb7d752b1f0a67f0f0f71b0f1bca1fc0614c64da78e8f

data/.gitignore

@@ -0,0 +1,3 @@
+/tmp
+/.bundle
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'activesupport'

data/README.md

@@ -0,0 +1,19 @@
+## gctools-rails
+
+Logs the amount of time spent in the MRI garbage collector to the Rails controller log. For example:
+
+```
+Completed 200 OK in 631ms (Views: 22.1ms | ActiveRecord: 18.7ms | GC=167.0ms | Search=0.0ms | Redis=2 | Memcache=7 | master-queries=3 | shard_0-queries=20 | shop_name=shop1.myshopify.io  | dest_host=shop1.myshopify.io  | pid=45776  | shop_id=1 | shard_id=0 | request_id=cfec5667-8f0b-4b11-b676-6300083bd04f | session_id=20ee8aefeeeae62ece61f6510eed6ac6446723cb315659084f760488bcac1857 | ssl=false | rev=1 )
+```
+
+### Install
+
+Add the following to your Gemfile:
+
+```ruby
+gem 'gctools-rails'
+```
+
+### Notes
+
+gctools-rails cannot be used at the same time as the [gctools logger](https://github.com/tmm1/gctools/blob/master/lib/gctools/logger.rb), as they both use `GCProf.after_gc_hook`.

data/Rakefile

@@ -0,0 +1,20 @@
+task :default => :test
+
+# ==========================================================
+# Packaging
+# ==========================================================
+
+GEMSPEC = eval(File.read('gctools-rails.gemspec'))
+
+require 'rubygems/package_task'
+Gem::PackageTask.new(GEMSPEC) do |pkg|
+end
+
+# ==========================================================
+# Testing
+# ==========================================================
+
+require 'rake/testtask'
+Rake::TestTask.new 'test' do |t|
+  t.test_files = FileList['test/test_*.rb']
+end

data/gctools-rails.gemspec

@@ -0,0 +1,18 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+
+require 'gctools/rails/version'
+
+Gem::Specification.new do |s|
+  s.name = 'gctools-rails'
+  s.version = Gctools::Rails::VERSION
+  s.summary = 'rails logging with gctools'
+  s.description = 'rails controller logging of GC stats using gctools'
+
+  s.homepage = 'https://github.com/csfrancis/gctools-rails'
+  s.authors = 'Scott Francis'
+  s.email   = 'scott.francis@shopify.com'
+  s.license = 'MIT'
+
+  s.files = `git ls-files`.split("\n")
+  s.add_runtime_dependency 'gctools', '~> 0.2', '>= 0.2.3'
+end

data/lib/gctools/rails.rb

@@ -0,0 +1,5 @@
+require 'gctools/gcprof'
+require 'gctools/rails/timer'
+require 'gctools/rails/time_logger'
+require 'gctools/rails/middleware'
+require 'gctools/rails/railtie' if defined?(Rails::Railtie)

data/lib/gctools/rails/middleware.rb

@@ -0,0 +1,16 @@
+module Gctools
+  module Rails
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        Timer.clear
+        @app.call(env)
+      ensure
+        Timer.clear
+      end
+    end
+  end
+end

data/lib/gctools/rails/railtie.rb

@@ -0,0 +1,13 @@
+module Gctools
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer 'gctools_rails.configure_controller' do |app|
+        app.config.middleware.insert 0, Gctools::Rails::Middleware
+
+        ActiveSupport.on_load :action_controller do
+          include TimeLogger
+        end
+      end
+    end
+  end
+end

data/lib/gctools/rails/time_logger.rb

@@ -0,0 +1,22 @@
+require 'active_support'
+
+module Gctools
+  module Rails
+    module TimeLogger
+      extend ActiveSupport::Concern
+
+      def append_info_to_payload(payload)
+        super
+        payload[:gc_time] = Timer.value
+      end
+
+      module ClassMethods
+        def log_process_action(payload)
+          messages, gc_time = super, payload[:gc_time]
+          messages << ("GC=%.1fms" % gc_time) if gc_time
+          messages
+        end
+      end
+    end
+  end
+end

data/lib/gctools/rails/timer.rb

@@ -0,0 +1,21 @@
+module Gctools
+  module Rails
+    module Timer
+      def self.value
+        Thread.current[:gctools_time] ||= 0
+      end
+
+      def self.add(gc_time_ms)
+        Thread.current[:gctools_time] = value + gc_time_ms
+      end
+
+      def self.clear
+        Thread.current[:gctools_time] = 0
+      end
+    end
+  end
+end
+
+GCProf.after_gc_hook = Proc.new { |info, start, end_mark, end_sweep|
+  Gctools::Rails::Timer.add((end_mark[:time] - start[:time]) * 1000) if end_sweep
+}

data/lib/gctools/rails/version.rb

@@ -0,0 +1,5 @@
+module Gctools
+  module Rails
+    VERSION = '0.0.1'
+  end
+end

data/test/test_rails.rb

@@ -0,0 +1,57 @@
+require 'minitest/autorun'
+require 'gctools/rails'
+
+class FakeBaseController
+  def append_info_to_payload(payload); payload;  end
+  def self.log_process_action(payload); ''; end
+end
+
+class FakeController < FakeBaseController
+  include Gctools::Rails::TimeLogger
+end
+
+class TestRails < MiniTest::Test
+  def setup
+    Gctools::Rails::Timer.clear
+  end
+
+  def test_timer_is_thread_local
+    t = Gctools::Rails::Timer
+
+    assert_equal 0, t.value
+    t.add(100)
+    assert_equal 100, t.value
+
+    th = Thread.new do
+      assert_equal 0, t.value
+    end
+  ensure
+    th.join if th
+  end
+
+  def test_time_logger_updates_payload
+    c = FakeController.new
+
+    Gctools::Rails::Timer.add(100)
+
+    p = {}
+    c.append_info_to_payload(p)
+    assert_equal 100, p[:gc_time]
+
+    assert c.class.log_process_action(p) =~ /GC=/
+  end
+
+  def test_middleware_clears_timer
+    c = Class.new do
+      def call(env)
+        v = Gctools::Rails::Timer.value
+        Gctools::Rails::Timer.add(100)
+        v
+      end
+    end.new
+
+    Gctools::Rails::Timer.add(100)
+    assert_equal 0, Gctools::Rails::Middleware.new(c).call({})
+    assert_equal 0, Gctools::Rails::Timer.value
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: gctools-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Scott Francis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gctools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+description: rails controller logging of GC stats using gctools
+email: scott.francis@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- gctools-rails.gemspec
+- lib/gctools/rails.rb
+- lib/gctools/rails/middleware.rb
+- lib/gctools/rails/railtie.rb
+- lib/gctools/rails/time_logger.rb
+- lib/gctools/rails/timer.rb
+- lib/gctools/rails/version.rb
+- test/test_rails.rb
+homepage: https://github.com/csfrancis/gctools-rails
+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: rails logging with gctools
+test_files: []