stackprofiler-middleware 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d729919c27abc83b5acf27ddd4e04ad31ab2133c
+  data.tar.gz: 1e281ffd39424e6a64978fc41a5c31e429faa4dd
+SHA512:
+  metadata.gz: b63e0670829efb526d09c7f5f2af6880ae2a368144102b4be63057ca17087b88975272c152f76fca5faa5ae2121f8c7ef40f7bda2f5140cfc76015e1ba552059
+  data.tar.gz: 17c75a289a50b7fdcf8411efbe8364dd7041e896a22cc0dbe04998bf3f9efd14b8aa08574879abac7e234ba5fece8b6eb290af992e396e819454b71528ba1c42

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Aidan Steele
+
+MIT License
+
+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,89 @@
+# Stackprofiler::Middleware
+
+Please read the [`stackprofiler`][1] gem README for background on Stackprofiler
+in general.
+
+This is a [Rack][2] middleware that makes benchmarking of Rack apps a breeze.
+It utilises the brilliant [`stackprof`][3] to enable low-overhead sampling of
+Ruby processes.
+
+much more fluid experience and provide a quicker turn-around time. It does
+this by passing along Pry's linebuffer to the Stackprofiler server so that
+code needn't be stored in the file system for Stackprofiler to annotate.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stackprofiler-middleware'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stackprofiler-middleware
+
+You should have also already installed the main Stackprofiler gem as well. If
+you haven't done that yet, head over to that gem's repo and come back here
+once you're done.
+
+## Usage
+
+First, boot up Stackprofiler's server in the background:
+
+    $ stackprofiler
+
+Using Stackprofiler at this stage is pretty simple on account of there
+not yet being much flexibility in the way of configuration. This will be
+fixed later - hopefully the simplicity can remain.
+
+Once installed, add Stackprofiler's middleware somewhere in your Rack
+chain, e.g.:
+
+```ruby
+config.middleware.use Stackprofiler::Middleware
+```
+
+Now start your server like normal. If you wish to profile a request,
+append `profile=true` to the query string. This will inform Stackprofiler
+that it should do its thing. Take note that the response will remain
+unchanged - Stackprofiler will record its statistics for your later perusal
+elsewhere. This is to make it easier to profile requests that don't return
+visible results, e.g. XHR.
+
+Once you have profiled a request or two, you can head over to Stackprofiler's
+GUI. This is probably at [http://localhost:9292/][4]. Read
+Stackprofiler's README to see how this web UI works.
+
+### Data collection configuration
+
+Stackprofiler's operation can be configured by passing in parameters to the
+middleware specified above. While the defaults should suit most applications,
+changing them is easy enough:
+
+```ruby
+config.middleware.use Stackprofiler::Middleware {
+  predicate: /profile=true/, # regex form for urls to be profiled
+  predicate: proc {|env| true }, # callable form for greater flexibility than regex
+  stackprof: { # options to be passed directly through to stackprof, e.g.:
+    interval: 1000 # sample every n micro-seconds
+  }
+}
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/glassechidna/stackprofiler-middleware/fork )
+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 a new Pull Request
+
+[1]: https://github.com/glassechidna/stackprofiler
+[2]: http://rack.github.io/
+[3]: https://github.com/tmm1/stackprof
+[4]: http://localhost:9292/

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/lib/stackprofiler/middleware.rb

@@ -0,0 +1,49 @@
+require 'stackprof'
+require 'rack'
+
+module Stackprofiler
+  class Middleware
+    attr_accessor :ui_url
+
+    def initialize(app, options={})
+      @app = app
+
+      pred = options[:predicate] || /profile=true/
+      if pred.respond_to? :call
+        @predicate = pred
+      else
+        regex = Regexp.new pred
+
+        @predicate = proc do |env|
+          req = Rack::Request.new env
+          req.fullpath =~ regex
+        end
+      end
+
+      @ui_url = options[:ui_url] || ENV['PRY_STACKPROFILER_UI_URL']
+      @stackprof_opts = {mode: :wall, interval: 1000, raw: true}.merge(options[:stackprof] || {})
+    end
+
+    def call(env)
+      if @predicate.call(env)
+        out = nil
+        profile = StackProf.run(@stackprof_opts) { out = @app.call env }
+
+        Thread.new do
+          profile[:name] = Rack::Request.new(env).fullpath
+
+          url = URI::parse ui_url
+          headers = {'Content-Type' => 'application/x-ruby-marshal'}
+          req = Net::HTTP::Post.new(url.to_s, headers)
+          req.body = Marshal.dump profile
+
+          response = Net::HTTP.new(url.host, url.port).start {|http| http.request(req) }
+        end
+
+        out
+      else
+        @app.call env
+      end
+    end
+  end
+end

data/stackprofiler-middleware.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = 'stackprofiler-middleware'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Aidan Steele']
+  spec.email         = ['aidan.steele@glassechidna.com.au']
+  spec.summary       = %q{Rack middleware for the Stackprofiler profiling gem.}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'stackprof', '~> 0.2'
+  spec.add_dependency 'rack'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: stackprofiler-middleware
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aidan Steele
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: stackprof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: 
+email:
+- aidan.steele@glassechidna.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stackprofiler/middleware.rb
+- stackprofiler-middleware.gemspec
+homepage: ''
+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: Rack middleware for the Stackprofiler profiling gem.
+test_files: []
+has_rdoc: