rails_runner 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 140270f54be56b6eb841de14c8d0b6489c3ad786
+  data.tar.gz: e93221ca8696a833cad6421d2a30d6ccca1f805f
+SHA512:
+  metadata.gz: 336638f0a7e7bdde650884ef05d823ea2633a09ba7c2735ec03e8fe2a2f875f95559895130ad6a5d3932f86e78cae38bd10b715ff6527fa1e100b3c669f5ef31
+  data.tar.gz: 96e042ca7425e45c388de5ffa75f94ae081e7a78c7efbc58495cbc7a8f3945cf16ca3419f8cf5aa978b66a61c914b6fba49c0f6186ec67f30120c6fc57bb545b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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.rdoc

@@ -0,0 +1,3 @@
+= RailsRunner
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsRunner'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/rails_runner/config.rb

@@ -0,0 +1,54 @@
+require 'socket'
+
+module RailsRunner
+  class Config
+    class ConfigurationMissing < StandardError
+      def initialize(filename)
+        @filename = filename
+      end
+
+      def message(*args)
+        "Please make sure the configuration file exists: #{@filename}"
+      end
+    end
+
+    def initialize(config_file)
+      @config_file = config_file
+      load_config
+    end
+
+    def load_config
+      raise ConfigurationMissing.new(@config_file) unless File.exist?(@config_file)
+      file = YAML.load(File.read(@config_file))
+      if file && file[env]
+        @configuration = file[env].with_indifferent_access
+      else
+        @configuration = {}
+      end
+    end
+
+    def collector_url
+      @configuration[:collector_url] ||= 'http://www.railsrunner.com'
+    end
+
+    def client_id
+      @configuration[:client_id]
+    end
+
+    def app_name
+      @configuration[:app_name] ||= Rails.application.class.parent_name
+    end
+
+    def active?
+      @configuration[:active] ||= !%w(test development).include?(env)
+    end
+
+    def hostname
+      @hostname ||= Socket.gethostname
+    end
+
+    def env
+      ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
+    end
+  end
+end

data/lib/rails_runner/instrumenter.rb

@@ -0,0 +1,47 @@
+module RailsRunner
+  class Instrumenter
+    MUTEX = Mutex.new
+
+    class << self
+      def current_request
+        Thread.current[:rails_runner_current_request]
+      end
+
+      def current_request=(request)
+        Thread.current[:rails_runner_current_request] = request
+      end
+
+      def start!
+        return @instance if @instance
+
+        MUTEX.synchronize do
+          return @instance if @instance
+          @instance = new.start
+        end
+      end
+
+      def instance
+        @instance
+      end
+    end
+
+    def start
+      @worker     = Worker.start!
+      @subscriber = Subscriber.new.register
+
+      self
+    end
+
+    def record(*args)
+      self.class.current_request = Request.new
+    end
+
+    def reset
+      self.class.current_request = nil
+    end
+
+    def publish(request)
+      @worker.push(request)
+    end
+  end
+end

data/lib/rails_runner/messages/action.rb

@@ -0,0 +1,25 @@
+module RailsRunner
+  class Action
+    include Beefcake::Message
+
+    required :category, :string, 1
+    required :object, :string, 2
+    required :start, :int64, 3
+    required :end, :int64, 4
+    required :duration, :int64, 5
+    required :explain, :string, 6
+    required :level, :int32, 7
+
+    def initialize(category, object, explain = '')
+      @category = category
+      @object   = object
+      @explain  = explain.to_s
+      @start    = Util.time_in_usec
+    end
+
+    def finish
+      @end      = Util.time_in_usec
+      @duration = @end - @start
+    end
+  end
+end

data/lib/rails_runner/messages/batch.rb

@@ -0,0 +1,38 @@
+module RailsRunner
+  class Batch
+    include Beefcake::Message
+
+    required :client_id, :string, 1
+    required :app_name, :string, 2
+    required :hostname, :string, 3
+
+    repeated :minutes, Minute, 5
+
+    def initialize
+      @client_id = RailsRunner.config.client_id
+      @app_name  = RailsRunner.config.app_name
+      @hostname  = RailsRunner.config.hostname
+
+      @_minutes   = {}
+    end
+
+    def current_minute
+      @_minutes[minute] ||= RailsRunner::Minute.new(minute)
+    end
+
+    def encode(*)
+      @minutes = @_minutes.values
+      super
+    end
+
+    def minutes
+      @minutes ||= @_minutes.values
+    end
+
+    private
+
+    def minute
+      Time.now.to_i / 60
+    end
+  end
+end

data/lib/rails_runner/messages/endpoint.rb

@@ -0,0 +1,31 @@
+module RailsRunner
+  class Endpoint
+    include Beefcake::Message
+    required :name, :string, 1
+    required :errors, :int64, 2
+    repeated :times, :int64, 3, packed: true
+    repeated :counts, :int64, 4, packed: true
+
+    def initialize(*args)
+      super
+      @errors = 0
+      @times  = Hash.new { |h, k| h[k] = 0 }
+    end
+
+    def add_time(time)
+      @times[time.to_i] += 1
+    end
+
+    def add_error
+      @errors += 1
+    end
+
+    def times
+      @times.keys
+    end
+
+    def counts
+      @times.values
+    end
+  end
+end

data/lib/rails_runner/messages/minute.rb

@@ -0,0 +1,80 @@
+module RailsRunner
+  class Minute
+    include Beefcake::Message
+
+    required :minute, :int64, 1
+    repeated :endpoints, Endpoint, 2, packed: true
+    repeated :traces, Request, 3, packed: true
+
+    def initialize(minute = Time.now.to_i)
+      @minute          = minute
+      @errors          = 0
+      @endpoints       = {}
+      @trace_endpoints = {}
+    end
+
+    def add_request(request)
+      add_error(request)
+
+      add_time(request)
+
+      add_trace(request)
+    end
+
+    def add_trace(request)
+      return if request.traceable?
+      return if slower_request_registered?(request)
+      @trace_endpoints[request.name] = request
+    end
+
+    def add_time(request)
+      time = rounded(request.duration)
+      endpoint(request.name).add_time(time) if request.name.present?
+      endpoint('total').add_time(time)
+    end
+
+    def traces
+      @trace_endpoints.values
+    end
+
+    def add_error(request)
+      return unless request.error?
+      endpoint(request.name || 'total').add_error
+    end
+
+    def endpoints
+      @endpoints.values
+    end
+
+    private
+
+    def endpoint(name)
+      @endpoints[name] ||= Endpoint.new(name: name)
+    end
+
+    def rounded(duration)
+      if duration < 500_000
+        mod = 10_000
+      elsif duration < 1000_000
+        mod = 50_000
+      elsif duration < 1500_000
+        mod = 100_000
+      elsif duration < 2250_000
+        mod = 150_000
+      elsif duration < 3000_000
+        mod = 200_000
+      else
+        return 3000_000
+      end
+      duration - (duration % mod)
+    end
+
+    def slower_request_registered?(request)
+      if @trace_endpoints[request.name]
+        @trace_endpoints[request.name].duration > request.duration
+      else
+        false
+      end
+    end
+  end
+end

data/lib/rails_runner/messages/request.rb

@@ -0,0 +1,48 @@
+module RailsRunner
+  class Request
+    include Beefcake::Message
+
+    optional :name, :string, 1
+    required :start, :int64, 2
+    required :end, :int64, 3
+    required :duration, :int64, 4
+    required :error, :bool, 5
+    repeated :actions, Action, 6, packed: true
+
+    attr_accessor :notifications
+
+    def initialize
+      @start         = Util.time_in_usec
+      @current_level = 0
+      @actions       = []
+      @notifications = []
+    end
+
+    def finish(error = false)
+      @end      = Util.time_in_usec
+      @duration = @end - @start
+      @error    = error
+      Instrumenter.instance.publish(self)
+    end
+
+    def add_action(action)
+      action.level   = @current_level
+      @current_level += 1
+      @actions << action
+    end
+
+    def finish_action(action)
+      return unless action
+      action.finish
+      @current_level -= 1
+    end
+
+    def traceable?
+      name.blank? || error?
+    end
+
+    def error?
+      @error
+    end
+  end
+end

data/lib/rails_runner/middleware.rb

@@ -0,0 +1,25 @@
+module RailsRunner
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      begin
+        request = instrumenter.record 'Rack', 'rack.request'
+        resp  = @app.call(env)
+        request.finish if request
+        resp
+      rescue Exception
+        request.finish(true) if request
+        raise
+      ensure
+        instrumenter.reset
+      end
+    end
+
+    def instrumenter
+      RailsRunner::Instrumenter.instance
+    end
+  end
+end

data/lib/rails_runner/notifications/default.rb

@@ -0,0 +1,42 @@
+module RailsRunner
+  class Notifications
+    class Default
+      class << self
+        def notification(name)
+          RailsRunner::Notifications.add_notification(name, self)
+        end
+      end
+
+      def to_action(request, payload)
+        nil #
+      end
+    end
+
+    class RenderDefault < Default
+      class << self
+        def mapped_paths
+          return @mapped_paths if @mapped_paths
+          @mapped_paths = {
+              Rails.root.to_s => ''
+          }
+          Gem.path.each do |path|
+            @mapped_paths[File.join(path, 'gems')] = 'gem'
+          end if defined?(Gem)
+
+          @mapped_paths
+        end
+
+        def prune_path(raw_path)
+          mapped_paths.each do |path, replacement|
+            raw_path = raw_path.gsub(path, replacement)
+          end
+          raw_path
+        end
+      end
+
+      def prune_path(path)
+        self.class.prune_path(path)
+      end
+    end
+  end
+end

data/lib/rails_runner/notifications/process_action.rb

@@ -0,0 +1,12 @@
+module RailsRunner
+  class Notifications
+    class ProcessAction < Default
+      notification 'process_action.action_controller'
+
+      def to_action(request, payload)
+        request.name = "#{payload[:controller]}##{payload[:action]}"
+        Action.new('Controller', request.name)
+      end
+    end
+  end
+end

data/lib/rails_runner/notifications/render_partial.rb

@@ -0,0 +1,11 @@
+module RailsRunner
+  class Notifications
+    class RenderPartial < RenderDefault
+      notification 'render_partial.action_view'
+
+      def to_action(request, payload)
+        Action.new('View', prune_path(payload[:identifier]))
+      end
+    end
+  end
+end

data/lib/rails_runner/notifications/render_template.rb

@@ -0,0 +1,11 @@
+module RailsRunner
+  class Notifications
+    class RenderTemplate < RenderDefault
+      notification 'render_template.action_view'
+
+      def to_action(request, payload)
+        Action.new('View', prune_path(payload[:identifier]))
+      end
+    end
+  end
+end

data/lib/rails_runner/notifications/sql.rb

@@ -0,0 +1,14 @@
+module RailsRunner
+  class Notifications
+    class Sql < Default
+      IGNORED_NAMES = %w(SCHEMA EXPLAIN CACHE) << nil
+
+      notification 'sql.active_record'
+
+      def to_action(request, payload)
+        return if IGNORED_NAMES.include? payload[:name]
+        Action.new('Database', payload[:name], payload[:sql])
+      end
+    end
+  end
+end

data/lib/rails_runner/notifications.rb

@@ -0,0 +1,17 @@
+module RailsRunner
+  class Notifications
+    class << self
+      DEFAULT_NOTIFICATION = Default.new
+
+      def add_notification(name, notification)
+        @notifications       ||= {}
+        @notifications[name] = notification.new
+      end
+
+      def to_action(request, name, payload)
+        notification = @notifications[name] || DEFAULT_NOTIFICATION
+        notification.to_action(request, payload)
+      end
+    end
+  end
+end

data/lib/rails_runner/railtie.rb

@@ -0,0 +1,11 @@
+module RailsRunner
+  class Railtie < Rails::Railtie
+    initializer 'rails_runner.configure' do |app|
+      Instrumenter.start!
+      app.middleware.insert 0, Middleware
+      RailsRunner.config = RailsRunner::Config.new(app.root.join('config/railsrunner.yml'))
+
+      puts "[RAILSRUNNER] started"
+    end
+  end
+end

data/lib/rails_runner/subscriber.rb

@@ -0,0 +1,34 @@
+module RailsRunner
+  class Subscriber
+    Notification = Struct.new(:name, :action)
+
+    def register
+      unregister if @subscriber
+      @subscriber = ActiveSupport::Notifications.subscribe nil, self
+    end
+
+    def start(name, id, payload)
+      request = Instrumenter.current_request
+      return unless request
+
+      if (action = Notifications.to_action(request, name, payload))
+        request.add_action(action)
+      end
+
+      request.notifications << Notification.new(name, action)
+    end
+
+    def finish(name, id, payload)
+      request = Instrumenter.current_request
+      return unless request
+
+      while (notification = request.notifications.pop)
+        if notification.name == name
+          request.finish_action(notification.action)
+          return
+        end
+      end
+    end
+
+  end
+end

data/lib/rails_runner/util.rb

@@ -0,0 +1,31 @@
+require 'zlib'
+require 'base64'
+
+module RailsRunner
+  class Util
+    class << self
+      def time_in_usec(time = Time.now)
+        time.to_i * 1_000_000 + time.usec
+      end
+
+      def post(body)
+        uri     = URI.parse(URI.join("#{RailsRunner.config.collector_url}").to_s)
+        http    = Net::HTTP.new(uri.host, uri.port)
+        gzipped = Base64.encode64(gzip(body))
+
+        request                     = Net::HTTP::Post.new(uri.request_uri)
+        request.body                = gzipped
+        request['Authorization']    = "#{RailsRunner.config.client_id}"
+
+        http.request(request)
+      end
+
+      def gzip(bytes)
+        gz = Zlib::GzipWriter.new(buffer = StringIO.new)
+        gz.write(bytes)
+        gz.close
+        buffer.string
+      end
+    end
+  end
+end

data/lib/rails_runner/version.rb

@@ -0,0 +1,3 @@
+module RailsRunner
+  VERSION = "0.0.1"
+end

data/lib/rails_runner/worker.rb

@@ -0,0 +1,59 @@
+module RailsRunner
+  class Worker
+    MUTEX = Mutex.new
+
+    attr_accessor :requests, :batch
+
+    class << self
+      def start!
+        return if @instance
+        MUTEX.synchronize do
+          return @instance if @instance
+          @instance = new.start
+        end
+      end
+
+      def instance
+        @instance
+      end
+    end
+
+    def initialize
+      @queue    = Queue.new
+      @requests = 0
+      @batch    = Batch.new
+    end
+
+    def start
+      Thread.new do
+        while (request = @queue.pop)
+          begin
+            case request
+              when Request
+                batch.current_minute.add_request(request)
+                @requests += 1
+              when :flush
+                send_to_collector
+            end
+          rescue Exception => e
+            puts e.message
+          end
+        end
+      end
+      self
+    end
+
+    def push(request)
+      @queue << request
+    end
+
+    def send_to_collector
+      @batch.encode(buffer = '')
+
+      Util.post(buffer)
+
+      @requests = 0
+      @batch    = Batch.new
+    end
+  end
+end

data/lib/rails_runner.rb

@@ -0,0 +1,34 @@
+require 'beefcake'
+
+module RailsRunner
+  require 'rails_runner/util'
+  require 'rails_runner/messages/action'
+  require 'rails_runner/messages/endpoint'
+  require 'rails_runner/messages/request'
+  require 'rails_runner/messages/minute'
+  require 'rails_runner/messages/batch'
+
+  require 'rails_runner/notifications/default'
+  require 'rails_runner/notifications'
+  require 'rails_runner/notifications/process_action'
+  require 'rails_runner/notifications/render_partial'
+  require 'rails_runner/notifications/render_template'
+  require 'rails_runner/notifications/sql'
+
+  require 'rails_runner/instrumenter'
+  require 'rails_runner/middleware'
+  require 'rails_runner/railtie'
+  require 'rails_runner/subscriber'
+  require 'rails_runner/worker'
+  require 'rails_runner/config'
+
+  def config=(config)
+    @config = config
+  end
+  module_function :config=
+
+  def config
+    @config || RailsRunner::Config.new(Rails.root.join('config/railsrunner.yml'))
+  end
+  module_function :config
+end

data/lib/tasks/rails_runner_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_runner do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: rails_runner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Benoist Claassen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: beefcake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Running rails
+email:
+- benoist.claassen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rails_runner/config.rb
+- lib/rails_runner/instrumenter.rb
+- lib/rails_runner/messages/action.rb
+- lib/rails_runner/messages/batch.rb
+- lib/rails_runner/messages/endpoint.rb
+- lib/rails_runner/messages/minute.rb
+- lib/rails_runner/messages/request.rb
+- lib/rails_runner/middleware.rb
+- lib/rails_runner/notifications/default.rb
+- lib/rails_runner/notifications/process_action.rb
+- lib/rails_runner/notifications/render_partial.rb
+- lib/rails_runner/notifications/render_template.rb
+- lib/rails_runner/notifications/sql.rb
+- lib/rails_runner/notifications.rb
+- lib/rails_runner/railtie.rb
+- lib/rails_runner/subscriber.rb
+- lib/rails_runner/util.rb
+- lib/rails_runner/version.rb
+- lib/rails_runner/worker.rb
+- lib/rails_runner.rb
+- lib/tasks/rails_runner_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: http://railsrunner.com
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Running rails
+test_files: []