trashed 2.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: abfbb3ba8576bac0d578d9821479635dda52e57b
+  data.tar.gz: b5439fd5e664b3f439860b6fd6dd548248d1594c
+SHA512:
+  metadata.gz: 7748860b9937a18abcffb575cb51a2cfb0ed352b9d1ffb824dceafa67a47c22afbfd4bfd1d4e89974f20e5137996cd4ae65cc7285bc3e9c7eef117fb92a8cbf9
+  data.tar.gz: 6af120ce83a1048254fc0df2d41f1cef0c32bfd99c9ea81eb5bd1ef063562c447f32bf28e137e23d92f8e712f11536bc4f85b5d49c7d7f9451c86edd2e306349

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 37signals, LLC
+
+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,34 @@
+## Trashed
+# Keep an eye on resource usage.
+
+
+ - Logs per-request object counts, heap growth, and GC time.
+ - Sends periodic resource usage snapshots to StatsD & NewRelic.
+ - Requires Ruby 1.9 or REE.
+
+
+## Setup
+
+### Rails 3
+
+On Rails 3, add this to the top of `config/application.rb`:
+
+    require 'trashed/railtie'
+
+And in the body of your app config:
+
+    module YourApp
+      class Application < Rails::Application
+        config.trashed[:statsd] = YourApp.statsd
+
+
+### Rails 2
+
+On Rails 2, add the middleware to `config/environment.rb`:
+
+    Rails::Initializer.run do |config|
+      config.middleware.use Trashed::Rack::MeasureResourceUsage, :statsd => YourApp.statsd
+
+And set up the sampler in `config/initializers/trashed.rb`:
+
+    Trashed::Newrelic.sample Trashed::ResourceUsage, :statsd => YourApp.statsd

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake/testtask'
+require 'rdoc/task'
+
+desc 'Default: run unit tests'
+task :default => :test
+
+desc 'Run unit tests'
+Rake::TestTask.new :test do |t|
+  t.libs << 'test/lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate RDoc documentation'
+Rake::RDocTask.new :rdoc do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'Trashed'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('MIT-LICENSE')
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require 'trashed'

data/lib/trashed.rb

@@ -0,0 +1,5 @@
+module Trashed
+  require 'trashed/meter'
+  require 'trashed/resource_usage'
+  require 'trashed/rack'
+end

data/lib/trashed/meter.rb

@@ -0,0 +1,40 @@
+module Trashed
+  class Meter
+    attr_reader :counters, :gauges
+
+    def initialize(&block)
+      @counters, @gauges = {}, {}
+      instance_eval(&block) if block_given?
+    end
+
+    def counts(name, &block) @counters[name] = block end
+    def count; read @counters end
+
+    def gauges(name, &block) @gauges[name] = block end
+    def gauge; read @gauges end
+
+    def instrument
+      before = count
+      yield
+      delta before, count
+    end
+
+    private
+
+    def delta(before, after)
+      delta = {}
+      after.each { |k, v| delta[k] = v - before[k] }
+      delta
+    end
+
+    def read(measures)
+      data = {}
+      measures.each do |name, measure|
+        measure.call.each do |key, value|
+          data["#{name}.#{key}"] = value
+        end
+      end
+      data
+    end
+  end
+end

data/lib/trashed/new_relic.rb

@@ -0,0 +1,47 @@
+module Trashed
+  module NewRelic
+    def self.sample(meter, options = {})
+      ::NewRelic::Agent.instance.stats_engine.add_sampler Sampler.new(meter, options)
+    end
+
+    class Sampler
+      attr_accessor :stats_engine
+
+      def initialize(meter, options = {})
+        @meter  = meter
+        @label  = options[:label] || 'Custom/%s'
+        @statsd = options[:statsd]
+      end
+
+      def poll
+        record @meter.count
+        record @meter.gauge
+      end
+
+      def record(data)
+        data.each do |name, value|
+          record_newrelic name, value
+          record_statsd   name, value if @statsd
+        end
+      end
+
+      private
+
+      def record_statsd(name, value)
+        @statsd.timing name, value
+      end
+
+      def record_newrelic(name, value)
+        stats_for(label_for(name)).record_data_point(value)
+      end
+
+      def stats_for(metric)
+        stats_engine.get_stats(metric, false)
+      end
+
+      def label_for(name)
+        @label % name.gsub('.', '/')
+      end
+    end
+  end
+end

data/lib/trashed/rack.rb

@@ -0,0 +1,66 @@
+module Trashed
+  module Rack
+    class MeasureResourceUsage
+      def initialize(app, options = {})
+        @app = app
+        @debug, @logger, @statsd, @sample_rate = options.values_at(:debug, :logger, :statsd, :sample_rate)
+        @sample_rate ||= 0.1
+
+        @request_namespaces, @sampler_namespaces = options.values_at(:statsd_request_namespaces, :statsd_sampler_namespaces)
+      end
+
+      def call(env)
+        response = nil
+        instrument(env) { response = @app.call(env) }
+        response
+      end
+
+      def instrument(env, &block)
+        change = ResourceUsage.instrument(&block)
+        usage  = ResourceUsage.gauge
+        record env, change, usage
+      end
+
+      def record(env, change, usage)
+        record_env    env, change, usage
+        record_logger env, change, usage if @logger
+        record_statsd env, change, usage if @statsd
+      end
+
+      def record_env(env, change, usage)
+        env['trashed.change'] = change
+        env['trashed.usage']  = usage
+      end
+
+      def record_logger(env, change, usage)
+        @logger.info "Rack handled in %dms (GC runs: %d)" % change.values_at('Time.wall', 'GC.count')
+        record_debug_logger env, change, usage if @debug
+      end
+
+      def record_debug_logger(env, change, usage)
+        @logger.debug "Changes: #{change.to_yaml}"
+        @logger.debug "Usage: #{usage.to_yaml}"
+      end
+
+      def record_statsd(env, change, usage)
+        record_statsd_timing change, :'Rack.Request.All'
+        record_statsd_timing usage,  :'Rack.Server.All'
+
+        Array(@request_namespaces.call(env)).each do |namespace|
+          record_statsd_timing change, "Rack.Request.#{namespace}"
+        end if @request_namespaces
+
+        Array(@sampler_namespaces.call(env)).each do |namespace|
+          record_statsd_timing usage, "Rack.Server.#{namespace}"
+        end if @sampler_namespaces
+      end
+
+      def record_statsd_timing(data, namespace = nil)
+        data.each do |name, value|
+          name = "#{namespace}.#{name}" if namespace
+          @statsd.timing name, value, @sample_rate
+        end
+      end
+    end
+  end
+end

data/lib/trashed/railtie.rb

@@ -0,0 +1,61 @@
+require 'trashed'
+require 'rails/railtie'
+require 'active_support/ordered_options'
+
+module Trashed
+  class Railtie < ::Rails::Railtie
+    config.trashed = ActiveSupport::OrderedOptions.new
+    config.trashed.statsd = ActiveSupport::OrderedOptions.new
+
+    initializer 'trashed' do |app|
+      # Debug data sent to statsd. Class-level config only :/
+      Statsd.logger = app.config.trashed.logger if app.config.trashed.debug
+
+      app.config.trashed.sample_rate ||= 0.1
+      app.config.trashed.logger = Rails.logger
+      app.config.trashed.statsd = connect_to_statsd(app.config.trashed.statsd)
+
+      app.config.trashed.statsd_request_namespaces = lambda do |env|
+        # Rails 3.2. Record request controller, action, and format.
+        if controller = env['action_controller.instance']
+          name    = controller.controller_name
+          action  = controller.action_name
+          format  = controller.request.format.try(:to_sym)
+          [ "Controllers.#{name}",
+            "Formats.#{format}",
+            "Actions.#{name}.#{action}.#{format}" ]
+        end
+      end
+
+      hostname = `hostname -s`.chomp
+      app.config.trashed.statsd_sampler_namespaces = lambda do |env|
+        # Rails 3.2. Record hostname.
+        [ "Hosts.#{hostname}" ]
+      end
+    end
+
+    initializer 'trashed.middleware', :after => 'trashed', :before => 'trashed.newrelic' do |app|
+      app.middleware.insert_after 'Rack::Runtime', Trashed::Rack::MeasureResourceUsage, app.config.trashed
+    end
+
+    initializer 'trashed.newrelic', :after => 'newrelic_rpm.start_plugin' do |app|
+      if defined?(NewRelic::Control) && NewRelic::Control.instance.agent_enabled?
+        require 'trashed/new_relic'
+        Trashed::NewRelic.sample ResourceUsage, app.config.trashed
+      end
+    end
+
+    def connect_to_statsd(options)
+      require 'statsd'
+
+      case options
+      when Statsd
+        options
+      when Hash
+        Statsd.new(options[:host], options[:port]).tap do |statsd|
+          statsd.namespace = options[:namespace]
+        end
+      end
+    end
+  end
+end

data/lib/trashed/resource_usage.rb

@@ -0,0 +1,48 @@
+module Trashed
+  ResourceUsage = Meter.new do
+
+    # Wall clock time, in milliseconds since epoch
+    counts :Time do
+      { :wall => (Time.now.to_f * 1000).to_i }
+    end
+
+    # RailsBench GC patch / REE 1.8
+    if GC.respond_to? :enable_stats
+      GC.enable_stats
+
+      counts :Objects do
+        { :total => ObjectSpace.allocated_objects }
+      end
+
+      gauges :Objects do
+        { :live => ObjectSpace.live_objects }
+      end
+
+      counts :GC do
+        { :count => GC.collections, :elapsed => GC.time, :memory => GC.allocated_size }
+      end
+
+      gauges :GC do
+        { :growth => GC.growth }
+      end
+
+    # Ruby 1.9+
+    elsif ObjectSpace.respond_to? :count_objects
+      counts :Objects do
+        { :total => ObjectSpace.count_objects[:TOTAL] }
+      end
+
+      gauges :Objects do
+        ObjectSpace.count_objects
+      end
+
+      counts :GC do
+        { :count => GC.stat[:count] }
+      end
+
+      gauges :GC do
+        GC.stat
+      end
+    end
+  end
+end

data/test/lib/trashed/test_helper.rb

@@ -0,0 +1,3 @@
+require 'trashed'
+require 'minitest/unit'
+MiniTest::Unit.autorun

data/test/meter_test.rb

@@ -0,0 +1,15 @@
+require 'trashed/test_helper'
+
+class MeterTest < MiniTest::Unit::TestCase
+  def test_count
+    time = Trashed::ResourceUsage.count['Time.wall']
+    refute_nil time
+    assert_in_delta time, (Time.now.to_f * 1000), 1000
+  end
+
+  def test_instrument
+    elapsed = Trashed::ResourceUsage.instrument { nil }['Time.wall']
+    refute_nil elapsed
+    assert_in_delta elapsed, 0, 1000
+  end
+end

data/test/rack_test.rb

@@ -0,0 +1,18 @@
+require 'trashed/test_helper'
+
+class RackTest < MiniTest::Unit::TestCase
+  Hello = lambda { |env| [200, {}, %w(hello)] }
+
+  def test_instruments_app_and_stores_in_env
+    env = {}
+
+    response = Trashed::Rack::MeasureResourceUsage.new(Hello).call(env)
+
+    refute_nil env['trashed.change']
+    refute_nil env['trashed.usage']
+
+    elapsed = env['trashed.change']['Time.wall']
+    refute_nil elapsed
+    assert_in_delta elapsed, 0, 1000
+  end
+end

data/trashed.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name      = 'trashed'
+  s.version   = '2.0.5'
+  s.author    = 'Jeremy Kemper'
+  s.email     = 'jeremy@bitsweat.net'
+  s.homepage  = 'https://github.com/37signals/trashed'
+  s.summary   = 'Keep tabs on Ruby garbage collection: object counts, allocated bytes, GC time.'
+
+  s.add_dependency 'statsd-ruby', '>= 0.4'
+
+  s.files = Dir["#{File.dirname(__FILE__)}/**/*"]
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: trashed
+version: !ruby/object:Gem::Version
+  version: 2.0.5
+platform: ruby
+authors:
+- Jeremy Kemper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: statsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: 
+email: jeremy@bitsweat.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./MIT-LICENSE
+- ./README.md
+- ./Rakefile
+- ./init.rb
+- ./lib/trashed.rb
+- ./lib/trashed/meter.rb
+- ./lib/trashed/new_relic.rb
+- ./lib/trashed/rack.rb
+- ./lib/trashed/railtie.rb
+- ./lib/trashed/resource_usage.rb
+- ./test/lib/trashed/test_helper.rb
+- ./test/meter_test.rb
+- ./test/rack_test.rb
+- ./trashed.gemspec
+homepage: https://github.com/37signals/trashed
+licenses: []
+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: ! 'Keep tabs on Ruby garbage collection: object counts, allocated bytes,
+  GC time.'
+test_files: []