gc_stats 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a882e6bdca88461f7236b0317b28b4a254b9770
-  data.tar.gz: 54b1f6e9f5aadf736df908a3946057c51f3eb9dd
+  metadata.gz: c75eb722713e0615b6c77a1d9ec82951b46e01d3
+  data.tar.gz: fb63d4b8040d07029a89840785e3741c09cd859c
 SHA512:
-  metadata.gz: 8ab3712f723c3a715b5aa9d331fcac64e6b9f53531b5d668e80ce05415efb6e90e26ce94db09744268a821422aacda35cafa090bf7506f2a9c96b69878454efa
-  data.tar.gz: 098073dff26c728b5e9a4ff64b1ab49c50d4d0d16bbd38e3ffc0d620060086f6365e62275b2b29b3c2c4a0cd9c8cf6dffa0e12b2e9c463059229e4ffa0f8515a
+  metadata.gz: bf86d22063fffdaecdfe2c6f3c076347b6491b008bd093bc14efb3508754e516a474bd5afd2e66f3cb8f7fc2d62f9a897e2019873b183c21ee2fbe9ba073ab41
+  data.tar.gz: c0fca4ecb664d90cb59d19ed976f987630b2cfabfa78f0c0ab963526edea753f74287efb5c1349a66ee3edbdcfbd124a4ca36094445799a1dec59e4326cca61a

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+1.0.1
+-----
+* [Rename the the log message field name from 'Process.pid' to 'PID'](https://github.com/cerner/gc_stats/pull/1)
+* [Cleanup of formatting, require statements and keeping lines to 80 characters](https://github.com/cerner/gc_stats/pull/2)
+* [Rework GCStats::Middleware to simplify it and keep it thread safe](https://github.com/cerner/gc_stats/pull/4)
+* [Add a depdendency on Rails 4.1+](https://github.com/cerner/gc_stats/pull/5)
+
 1.0.0
 -----
 * Initial release

data/CONTRIBUTORS.md

@@ -4,4 +4,5 @@ Charles McDonald
 Kevin Shekleton
 Sam Bao
 Chris Gaul
-Jonathan Nye
+Jonathan Nye
+Nathan Beyer

data/README.md

@@ -1,5 +1,15 @@
 # gc_stats
 
+[![Build Status](https://api.travis-ci.org/cerner/gc_stats.svg)][travis]
+[![Gem Version](http://img.shields.io/gem/v/gc_stats.svg)][gem]
+[![Code Climate](http://img.shields.io/codeclimate/github/cerner/gc_stats.svg)][codeclimate]
+[![Dependencies Status](http://img.shields.io/gemnasium/cerner/gc_stats.svg)][gemnasium]
+
+[travis]: https://travis-ci.org/cerner/gc_stats
+[gem]: https://rubygems.org/gems/gc_stats
+[codeclimate]: https://codeclimate.com/github/cerner/gc_stats
+[gemnasium]: https://gemnasium.com/cerner/gc_stats
+
 gc_stats is a Ruby gem for Rails applications that collects and logs garbage collection statistics during each request. GC statistics are only logged if a GC event is detected. This allows you to track and analyze the GC characteristics of your Rails application.
 
 ## Installation
@@ -20,17 +30,17 @@ Once you have added a dependency to this gem and installed it, simply require th
 
 ## Usage
 
-With gc_stats, all of your final controller log messages will now contain the Process pid. For example:
+With gc_stats, all of your final controller log messages will now contain the PID of the Ruby process. For example:
 
-    Completed 200 OK in 5ms (Process.pid: 12875)
+    Completed 200 OK in 5ms (PID: 12875)
 
 If a garbage collection event occurs during a request, you will see additional information in this same final controller log message that will contain the GC statistics. For example:
 
-    Completed 200 OK in 38ms (Process.pid: 12875 | GC: [total_gc_time: 22.574 ms | num_events: 1 | major/minor/count: 9/24/33])
+    Completed 200 OK in 38ms (PID: 12875 | GC: [total_gc_time: 22.574 ms | num_events: 1 | major/minor/count: 9/24/33])
 
 An explanation of each field being logged follows:
 
-* Process.pid - The process id obtained from [Process.pid](http://ruby-doc.org/core-2.1.0/Process.html#method-c-pid)
+* PID - The process id obtained from [Process.pid](http://ruby-doc.org/core-2.1.0/Process.html#method-c-pid)
 * total_gc_time - The total time taken for garbage collection during this request, converted to milliseconds ([GC::Profiler.total_time](http://ruby-doc.org/core-2.1.0/GC/Profiler.html#method-c-total_time))
 * num_events - The number of garbage collection events that occurred during the request
 * major - The total number of GC runs that traversed the whole Ruby heap, including old, young and remembered objects over the life of this process
@@ -57,4 +67,3 @@ Copyright 2015 Cerner Innovation, Inc.
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
 
 http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-

data/lib/gc_stats.rb

@@ -1,8 +1,4 @@
-require 'gc_stats/initializer'
+# setup GCStats module
 require 'gc_stats/version'
-require 'gc_stats/middleware'
-require 'gc_stats/gc_logger'
-
-module GCStats
-
-end
+# setup GCStatus via Rails initializer
+require 'gc_stats/initializer'

data/lib/gc_stats/gc_logger.rb

@@ -1,21 +1,29 @@
 module GCStats
 
-  # ActionController hook to inject runtime info into the request notification event
+  # ActionController hook to inject runtime info into the request notification
+  # event
   module GCLogger
     extend ActiveSupport::Concern
 
     module ClassMethods
-      # ActionController hook to add the process id and GC info on to the info message
-      # to be logged as part of the request event.
+
+      # ActionController hook to add the process ID and GC info on to the info
+      # message to be logged as part of the request event.
       # @param [Hash] payload hash containing additional info to be logged
       def log_process_action(payload)
-        gc_time = GC::Profiler.total_time
         messages = super
-        messages << "Process.pid: #{Process.pid}"
-        messages << "GC: [total_gc_time: #{gc_time*1000} ms | num_events: #{GC::Profiler.raw_data.count} | major/minor/count: #{GC.stat[:major_gc_count]}/#{GC.stat[:minor_gc_count]}/#{GC.count}]" unless gc_time == 0
+        messages << "PID: #{Process.pid}"
+
+        gc_time = GC::Profiler.total_time
+        if gc_time > 0
+          messages << "GC: [total_gc_time: #{gc_time*1000} ms |" \
+            " num_events: #{GC::Profiler.raw_data.count} | major/minor/count:" \
+            " #{GC.stat[:major_gc_count]}/#{GC.stat[:minor_gc_count]}/#{GC.count}]"
+        end
+
         messages
       end
 
     end
   end
-end
+end

data/lib/gc_stats/initializer.rb

@@ -1,14 +1,23 @@
+require 'gc_stats/gc_logger'
+require 'gc_stats/middleware'
+
 module GCStats
+
   class Initializer < Rails::Railtie
 
     config.before_initialize do
+      # enable the GC Profiler
       GC::Profiler.enable
+
+      # Add the GCStats::Middlware to the application's middleware
       config.app_middleware.insert_before ::Rack::Runtime, GCStats::Middleware
 
+      # Include the GCStats::GCLogger mixin to base controller
       ActiveSupport.on_load(:action_controller) do
         include GCStats::GCLogger
       end
     end
 
   end
-end
+
+end

data/lib/gc_stats/middleware.rb

@@ -1,19 +1,23 @@
 module GCStats
+
+  # Rack middleware that clears out GC::Profiler's data on each request.
   class Middleware
+
     def initialize(app)
       @app = app
     end
 
     def call(env)
-      dup._call(env)
-    end
-
-    def _call(env)
+      # clear out the profiler's data
       GC::Profiler.clear
-      @status, @headers, @response = @app.call(env)
 
-      [@status, @headers, @response]
+      # pass the call onto the next link in the chain
+      status, headers, response = @app.call(env)
+
+      # pass the results back
+      [status, headers, response]
     end
 
   end
-end
+
+end

data/lib/gc_stats/version.rb

@@ -1,3 +1,3 @@
 module GCStats
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gc_stats
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Faiz Ahmed Shaik
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-13 00:00:00.000000000 Z
-dependencies: []
+date: 2015-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
 description: |2
       gc_stats is a Ruby gem for Rails applications that collects and logs garbage collection statistics
       during each request. GC statistics are only logged if a GC event is detected. This allows you to