rack_gc_profiler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 818e9a84a8736d7b598e63481606c1770f7cb98e
+  data.tar.gz: 08e73c92b9b8214b3197d19a448ef548e4dae748
+SHA512:
+  metadata.gz: 39bbb305043682bdbdde9d324e30c54d3684b6b62a35622c1aabc194ae944b35b347e840b30f9fa9a00f36fff753d5bd388ad423f65c3d639631c41ba19ad7db
+  data.tar.gz: 75dc3674db310a724c17ba2cba0fba91b6b37af16979ce6ca5901be722e559397910a6c16a22cf07819aea59f30b1d156a34c640e1cecc4df4974bc95dfbc078

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.7

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Andrew A Smith
+
+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,90 @@
+# RackGcProfiler
+
+A rack middleware for measuring GC activity during a request.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack_gc_profiler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack_gc_profiler
+
+## Usage
+
+Install the middleware into your application's list of rack middlewares.
+
+Issue a request to your application where GC will occur. Two extra headers will
+be appended to the response:
+
+```console
+$ curl -v -o /dev/null -sSq yourapp.example.com
+< HTTP/1.1 200 OK
+   :
+< GC-Runs: 1
+< GC-Time: 0.040000
+  :
+{ [1219 bytes data]
+* Connection #0 to host yourapp.example.com left intact
+```
+
+`GC-Runs` is the number of times garbage collection ran during the request.
+`GC-Time` is the duration of all the GC runs that occured, in seconds.
+
+### Production Usage
+
+Should you use this in production? Profiling anything always adds overhead. To
+measure this more concretely, a benchmark has been provided. See benchmark.rb in
+the root of the repo. On my machine, using MRI 2.3.1, GC profiling added 0.6%
+overhead. This equates to about 0.1ms on a 200ms request. Always evaluate in
+your own production environment first and decide for yourself before adding this
+to a production application.
+
+To prevent information leakage, the reverse proxy upstream from your
+application server should log and delete the two headers listed in the section
+above.
+
+### Rails
+
+To install in rails, add the following to your `application.rb`:
+
+```ruby
+config.middleware.use RackGcProfiler::Middleware
+```
+
+See http://guides.rubyonrails.org/rails_on_rack.html#configuring-middleware-stack
+for more details.
+
+### Sinatra
+
+To install in sinatra, add the following to your application:
+
+```ruby
+use RackGcProfiler::Middleware
+```
+
+See http://www.sinatrarb.com/intro#Rack%20Middleware for more details.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/aasmith/rack_gc_profiler.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/benchmark.rb

@@ -0,0 +1,39 @@
+require 'benchmark'
+
+def busywork
+  GC.disable
+  100_000.times do |i|
+    Object.new
+
+    if i % 10_000 == 0
+      GC.enable
+      GC.start
+      GC.disable
+    end
+  end
+  GC.enable
+end
+
+def busywork_with_profiling
+  GC::Profiler.enable
+  busywork
+  GC::Profiler.disable
+  GC::Profiler.clear
+end
+
+N = 1_000
+
+Benchmark.bmbm do |bm|
+  bm.report 'GC Profile' do
+    N.times do
+      busywork_with_profiling
+    end
+  end
+
+  bm.report 'No Profile' do
+    N.times do
+      busywork
+    end
+  end
+
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack_gc_profiler"
+
+# 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/lib/rack_gc_profiler.rb

@@ -0,0 +1,34 @@
+require "rack_gc_profiler/version"
+
+module RackGcProfiler
+  class Middleware
+
+    GC_TIME_FORMAT = "%0.6f".freeze
+    GC_TIME_HEADER = "GC-Time".freeze
+    GC_RUNS_HEADER = "GC-Runs".freeze
+
+    attr_reader :profiler
+
+    def initialize(app, profiler = GC::Profiler)
+      @app = app
+      @profiler = profiler
+    end
+
+    def call(env)
+      @profiler.enable
+
+      status, headers, body = @app.call(env)
+
+      headers[GC_TIME_HEADER] = GC_TIME_FORMAT % @profiler.total_time
+      headers[GC_RUNS_HEADER] = @profiler.raw_data.size.to_s
+
+      [status, headers, body]
+
+    ensure
+      @profiler.disable
+      @profiler.clear
+
+    end
+
+  end
+end

data/lib/rack_gc_profiler/version.rb

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

data/rack_gc_profiler.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack_gc_profiler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack_gc_profiler"
+  spec.version       = RackGcProfiler::VERSION
+  spec.authors       = ["Andrew A Smith"]
+  spec.email         = ["andy@tinnedfruit.org"]
+
+  spec.summary       = %q{A rack middleware for measuring GC activity during a request.}
+  spec.homepage      = "http://github.com/aasmith/rack_gc_profiler"
+  spec.license       = "MIT"
+
+  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 "minitest", "~> 5.0"
+
+  spec.add_dependency "rack", "~> 1.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: rack_gc_profiler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew A Smith
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-14 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email:
+- andy@tinnedfruit.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark.rb
+- bin/console
+- bin/setup
+- lib/rack_gc_profiler.rb
+- lib/rack_gc_profiler/version.rb
+- rack_gc_profiler.gemspec
+homepage: http://github.com/aasmith/rack_gc_profiler
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A rack middleware for measuring GC activity during a request.
+test_files: []