rack-stackprof 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be98bd41340ec063dc940d7cc493e9273b61e90e8bb35639ea31193c4ce2abdf
+  data.tar.gz: 21a35e040a9831d8f1fdb2eaed43c97729b797457e63f28b2115dfb7172a1d05
+SHA512:
+  metadata.gz: f74cf3e2060bb1becaa3dad924dbcbddadfdb7a7031a5b24669161a249c7f56fad3f6b4663f951932b710150af9aa46f1b0a3e6492186aa4d45bdb11a882b84e
+  data.tar.gz: e633f6b4215cb383392e01e64957798940a8a0e805deba6da3847cdcea50950e80035ed36a0c099bd115b815efb07707d5e672c7089b53fb07da7df52e66a247

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rack-stackprof.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    rack-stackprof (0.1.0)
+      stackprof
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (12.3.0)
+    stackprof (0.2.11)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  rack-stackprof!
+  rake
+
+BUNDLED WITH
+   1.16.1.pre1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Takashi Kokubun
+
+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,44 @@
+# Rack::Stackprof
+
+Periodically dump StackProf profile result to `tmp` with easy-to-understand filenames
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-stackprof'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Usage
+
+```rb
+if ENV['STACKPROF_ENABLE'] == 'true'
+  Rails.application.middleware.use(
+    Rack::Stackprof,
+    profile_interval_seconds: 1,
+    sampling_interval_microseconds: 1000,
+    result_directory: 'tmp',
+  )
+end
+```
+
+After starting application with environment variable `STACKPROF_ENABLE=true`,
+files whose name is like following ones will be periodically (once per second as `profile_interval_seconds: 1`) dumped to `tmp`.
+
+```
+stackprof-20171004_175816-41860-GET_v1_users-0308ms.dump
+stackprof-20171004_175924-41860-GET_v1_accounts-0248ms.dump
+stackprof-20171004_175955-41860-GET_v1_comments-1029ms.dump
+...
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/stackprof"
+
+# 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(__FILE__)

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/stackprof/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class Stackprof
+    VERSION = '0.1.0'
+  end
+end

data/lib/rack/stackprof.rb

@@ -0,0 +1,47 @@
+require 'stackprof'
+require 'rack/stackprof/version'
+
+class Rack::Stackprof
+  def initialize(app, options = {})
+    @app = app
+    @profile_interval_seconds = options.fetch(:profile_interval_seconds)
+    @sampling_interval_microseconds = options.fetch(:sampling_interval_microseconds)
+    @last_profiled_at = nil
+    StackProf::Middleware.path = options.fetch(:result_directory) # for `StackProf::Middleware.save`
+  end
+
+  def call(env)
+    # Profile every X seconds (not everytime) to prevent from consuming disk excessively
+    profile_every(seconds: @profile_interval_seconds, env: env) do
+      @app.call(env)
+    end
+  end
+
+  private
+
+  def profile_every(seconds:, env:, &block)
+    if @last_profiled_at.nil? || @last_profiled_at < Time.now - seconds
+      @last_profiled_at = Time.now
+      with_profile(env) { block.call }
+    else
+      block.call
+    end
+  end
+
+  def with_profile(env)
+    started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_microsecond)
+    StackProf.start(mode: :wall, interval: @sampling_interval_microseconds)
+    yield
+  ensure
+    StackProf.stop
+    finished_at = Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_microsecond)
+
+    filename = result_filename(env: env, duration_milliseconds: (finished_at - started_at) / 1000)
+    StackProf::Middleware.save(filename)
+  end
+
+  # ex: "stackprof-20171004_175816-41860-GET_v1_users-0308ms.dump"
+  def result_filename(env:, duration_milliseconds:)
+    "stackprof-#{Time.now.strftime('%Y%m%d_%H%M%S')}-#{Process.pid}-#{env['REQUEST_METHOD']}#{env['REQUEST_PATH'].gsub(/[^\w]/, '_')}-#{'%04d' % duration_milliseconds.to_i}ms.dump"
+  end
+end

data/rack-stackprof.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/stackprof/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-stackprof'
+  spec.version       = Rack::Stackprof::VERSION
+  spec.authors       = ['Takashi Kokubun']
+  spec.email         = ['takashikkbn@gmail.com']
+
+  spec.summary       = %q{Periodically dump StackProf profile result to tmp directory with easy-to-understand filename}
+  spec.description   = %q{Periodically dump StackProf profile result to tmp directory with easy-to-understand filename}
+  spec.homepage      = 'https://github.com/k0kubun/rack-stackprof'
+  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_dependency 'stackprof'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: rack-stackprof
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takashi Kokubun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: stackprof
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Periodically dump StackProf profile result to tmp directory with easy-to-understand
+  filename
+email:
+- takashikkbn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/stackprof.rb
+- lib/rack/stackprof/version.rb
+- rack-stackprof.gemspec
+homepage: https://github.com/k0kubun/rack-stackprof
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Periodically dump StackProf profile result to tmp directory with easy-to-understand
+  filename
+test_files: []