notable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c151df90eb28af125393e544de6e488a7a44d0b
+  data.tar.gz: ce0488e566db76802d5647e56663d08e25adad45
+SHA512:
+  metadata.gz: 998e60bed494684299530eb3282b8a8981c825c5402f8ce19cca9f7accd5e60769eaae9ec4a2ee1c7f82e9227f8225dc2bab06fc879d005d79e2242919fe3733
+  data.tar.gz: 706cefe72681ea3a33937a4d21ca69a6ab431aff1c617c4f71bbea09c2800d5d7e89e64ce6cbb17da3ac26418eb278cc391c4297d01300a077b923c3de2434b3

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Kane
+
+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,122 @@
+# Notable
+
+Track notable requests and background jobs
+
+See users affected by:
+
+- errors
+- slow requests, jobs, and timeouts
+- 404s
+- validation failures
+- CSRF failures
+- unpermitted parameters
+- blocked and throttled requests
+
+:tangerine: Battle-tested at [Instacart](https://www.instacart.com)
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'notable'
+```
+
+And run:
+
+```sh
+rails generate notable:requests
+rails generate notable:jobs # optional
+rake db:migrate
+```
+
+For a web interface, check out [Notable Web](https://github.com/ankane/notable_web).
+
+## Requests
+
+A `Notable::Request` is created for:
+
+- errors
+- slow requests and timeouts
+- 404s
+- validation failures
+- CSRF failures
+- unpermitted parameters
+- blocked and throttled requests
+
+## Jobs
+
+A `Notable::Job` is created for:
+
+- errors
+- slow jobs
+
+Currently works with Delayed Job and Sidekiq.
+
+## Manual Tracking
+
+```ruby
+Notable.track(note_type, note)
+```
+
+## Customize
+
+Disable tracking in certain environments
+
+```ruby
+Notable.enabled = Rails.env.production?
+```
+
+### Requests
+
+Set slow threshold
+
+```ruby
+Notable.slow_request_threshold = 5 # seconds (default)
+```
+
+Custom user method
+
+```ruby
+Notable.user_method = proc do |env|
+  env["warden"].try(:user) || env["action_controller.instance"].try(:current_visit)
+end
+```
+
+Custom track method
+
+```ruby
+Notable.track_request_method = proc do |data, env|
+  Notable::Request.create!(data)
+end
+```
+
+### Jobs
+
+Set slow threshold
+
+```ruby
+Notable.slow_job_threshold = 60 # seconds (default)
+```
+
+Custom track method
+
+```ruby
+Notable.track_job_method = proc do |data|
+  Notable::Job.create!(data)
+end
+```
+
+## TODO
+
+- ability to disable features
+- add indexes
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/notable/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/notable/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

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

data/app/models/notable/job.rb

@@ -0,0 +1,5 @@
+module Notable
+  class Job < ActiveRecord::Base
+    self.table_name = "notable_jobs"
+  end
+end

data/app/models/notable/request.rb

@@ -0,0 +1,8 @@
+module Notable
+  class Request < ActiveRecord::Base
+    self.table_name = "notable_requests"
+
+    belongs_to :user, polymorphic: true
+    serialize :params, JSON
+  end
+end

data/lib/generators/notable/jobs_generator.rb

@@ -0,0 +1,30 @@
+# taken from https://github.com/collectiveidea/audited/blob/master/lib/generators/audited/install_generator.rb
+require "rails/generators"
+require "rails/generators/migration"
+require "active_record"
+require "rails/generators/active_record"
+
+module Notable
+  module Generators
+    class JobsGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname) #:nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+
+      def copy_migration
+        migration_template "create_jobs.rb", "db/migrate/create_notable_jobs.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/notable/requests_generator.rb

@@ -0,0 +1,30 @@
+# taken from https://github.com/collectiveidea/audited/blob/master/lib/generators/audited/install_generator.rb
+require "rails/generators"
+require "rails/generators/migration"
+require "active_record"
+require "rails/generators/active_record"
+
+module Notable
+  module Generators
+    class RequestsGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname) #:nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+
+      def copy_migration
+        migration_template "create_requests.rb", "db/migrate/create_notable_requests.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/notable/templates/create_jobs.rb

@@ -0,0 +1,14 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_table :notable_jobs do |t|
+      t.string :note_type
+      t.text :note
+      t.text :job
+      t.string :job_id
+      t.string :queue
+      t.decimal :runtime
+      t.decimal :queued_time
+      t.timestamp :created_at
+    end
+  end
+end

data/lib/generators/notable/templates/create_requests.rb

@@ -0,0 +1,22 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_table :notable_requests do |t|
+      t.string :note_type
+      t.text :note
+      t.integer :user_id
+      t.string :user_type
+      t.text :action
+      t.integer :status
+      t.text :url
+      t.string :request_id
+      t.string :ip
+      t.text :user_agent
+      t.text :referrer
+      t.text :params
+      t.decimal :request_time
+      t.timestamp :created_at
+    end
+
+    add_index :notable_requests, [:user_id, :user_type]
+  end
+end

data/lib/notable/debug_exceptions.rb

@@ -0,0 +1,15 @@
+module Notable
+  module DebugExceptions
+    extend ActiveSupport::Concern
+
+    included do
+      alias_method_chain :render_exception, :pass
+    end
+
+    def render_exception_with_pass(env, exception)
+      env["action_dispatch.exception"] = exception
+      render_exception_without_pass(env, exception)
+    end
+
+  end
+end

data/lib/notable/engine.rb

@@ -0,0 +1,9 @@
+module Notable
+  class Engine < ::Rails::Engine
+    isolate_namespace Notable
+
+    initializer "notable" do |app|
+      app.config.middleware.insert_after RequestStore::Middleware, Notable::Middleware
+    end
+  end
+end

data/lib/notable/job_backends/delayed_job.rb

@@ -0,0 +1,15 @@
+module Notable
+  module JobBackends
+    class DelayedJob < Delayed::Plugin
+      callbacks do |lifecycle|
+        lifecycle.around(:invoke_job) do |job, *args, &block|
+          Notable.track_job job.name, job.id, job.queue, job.created_at do
+            block.call(job, *args)
+          end
+        end
+      end
+    end
+  end
+end
+
+Delayed::Worker.plugins << Notable::JobBackends::DelayedJob

data/lib/notable/job_backends/sidekiq.rb

@@ -0,0 +1,26 @@
+module Notable
+  module JobBackends
+    class Sidekiq
+      WRAPPER_CLASSES = Set.new(["ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper"])
+
+      def call(worker, job, queue)
+        name =
+          if WRAPPER_CLASSES.include?(job["class"])
+            job["args"].first["job_class"]
+          else
+            job["class"]
+          end
+
+        Notable.track_job name, job["jid"], queue, Time.at(job["enqueued_at"]) do
+          yield
+        end
+      end
+    end
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Notable::JobBackends::Sidekiq
+  end
+end

data/lib/notable/middleware.rb

@@ -0,0 +1,77 @@
+module Notable
+  class Middleware
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if Notable.enabled
+        start_time = Time.now
+        status, headers, body = @app.call(env)
+        request_time = Time.now - start_time
+
+        safely do
+          if env["action_dispatch.exception"]
+            e = env["action_dispatch.exception"]
+            message =
+              case status.to_i
+              when 404
+                "Not Found"
+              when 503
+                "Timeout"
+              else
+                "Error"
+              end
+            Notable.track message, "#{e.class.name}: #{e.message}"
+          elsif (!status or status.to_i >= 400) and !Notable.notes.any?
+            Notable.track Rack::Utils::HTTP_STATUS_CODES[status.to_i]
+          end
+
+          if request_time > Notable.slow_request_threshold and status.to_i != 503
+            Notable.track "Slow Request"
+          end
+
+          notes = Notable.notes
+          if notes.any?
+            request = ActionDispatch::Request.new(env)
+
+            # hack since Rails modifies PATH_INFO
+            # and we don't want to modify env
+            url = request.base_url + request.script_name + env["REQUEST_PATH"]
+            url << "?#{request.query_string}" unless request.query_string.empty?
+
+            controller = env["action_controller.instance"]
+            action = controller && "#{controller.params["controller"]}##{controller.params["action"]}"
+            params = controller && controller.request.filtered_parameters.except("controller", "action")
+
+            user = Notable.user_method.call(env)
+
+            notes.each do |note|
+              data = {
+                note_type: note[:note_type],
+                note: note[:note],
+                user: user,
+                action: action,
+                status: status,
+                params: params,
+                request_id: request.uuid,
+                ip: request.remote_ip,
+                user_agent: request.user_agent,
+                url: url,
+                referrer: request.referer,
+                request_time: request_time
+              }
+              Notable.track_request_method.call(data, env)
+            end
+          end
+        end
+
+        [status, headers, body]
+      else
+        @app.call(env)
+      end
+    end
+
+  end
+end

data/lib/notable/throttle.rb

@@ -0,0 +1,5 @@
+ActiveSupport::Notifications.subscribe "rack.attack" do |name, start, finish, request_id, req|
+  if [:blacklist, :throttle].include?(req.env["rack.attack.match_type"])
+    Notable.track "Throttle", req.env["rack.attack.matched"]
+  end
+end

data/lib/notable/unpermitted_parameters.rb

@@ -0,0 +1,3 @@
+ActiveSupport::Notifications.subscribe "unpermitted_parameters.action_controller" do |name, start, finish, id, payload|
+  Notable.track "Unpermitted Parameters", payload[:keys].join(", ")
+end

data/lib/notable/unverified_request.rb

@@ -0,0 +1,19 @@
+module Notable
+  module UnverifiedRequest
+    extend ActiveSupport::Concern
+
+    included do
+      prepend_before_filter :track_unverified_request
+    end
+
+    def track_unverified_request
+      if !verified_request?
+        expected = form_authenticity_token
+        actual = form_authenticity_param || request.headers["X-CSRF-Token"]
+        Notable.track "Unverified Request", "#{actual || "nil"} != #{expected}"
+      end
+    end
+  end
+end
+
+ActionController::Base.send(:include, Notable::UnverifiedRequest)

data/lib/notable/validation_errors.rb

@@ -0,0 +1,17 @@
+module Notable
+  module ValidationErrors
+    extend ActiveSupport::Concern
+
+    included do
+      after_validation :track_validation_errors
+    end
+
+    def track_validation_errors
+      if errors.any?
+        Notable.track "Validation Errors", "#{self.class.name}: #{errors.full_messages.join(", ")}"
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, Notable::ValidationErrors)

data/lib/notable/version.rb

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

data/lib/notable.rb

@@ -0,0 +1,101 @@
+require "notable/version"
+
+require "request_store"
+require "robustly"
+require "action_dispatch/middleware/debug_exceptions"
+
+# middleware
+require "notable/middleware"
+require "notable/engine" if defined?(Rails)
+
+# requests
+require "notable/unpermitted_parameters"
+require "notable/unverified_request"
+require "notable/validation_errors"
+require "notable/debug_exceptions"
+require "notable/throttle"
+
+# jobs
+require "notable/job_backends/sidekiq" if defined?(Sidekiq)
+require "notable/job_backends/delayed_job" if defined?(Delayed::Job)
+
+module Notable
+  class << self
+    attr_accessor :enabled
+
+    # requests
+    attr_accessor :track_request_method
+    attr_accessor :user_method
+    attr_accessor :slow_request_threshold
+
+    # jobs
+    attr_accessor :track_job_method
+    attr_accessor :slow_job_threshold
+  end
+  self.enabled = true
+
+  # requests
+  self.track_request_method = proc{|data, env| Notable::Request.create!(data) }
+  self.user_method = proc{|env| env["warden"].user if env["warden"] }
+  self.slow_request_threshold = 5
+
+  # jobs
+  self.track_job_method = proc{|data| Notable::Job.create!(data) }
+  self.slow_job_threshold = 60
+
+  def self.note(note_type, note = nil)
+    (RequestStore.store[:notable_notes] ||= []) << {note_type: note_type, note: note}
+  end
+
+  def self.notes
+    RequestStore.store[:notable_notes].to_a
+  end
+
+  def self.clear_notes
+    RequestStore.store.delete(:notable_notes)
+  end
+
+  def self.track_job(job, job_id, queue, created_at, &block)
+    if Notable.enabled
+      exception = nil
+      notes = nil
+      start_time = Time.now
+      queued_time = start_time - created_at
+      begin
+        yield
+      rescue Exception => e
+        exception = e
+      ensure
+        notes = Notable.notes
+        Notable.clear_notes
+      end
+      runtime = Time.now - start_time
+
+      safely do
+        notes << {note_type: "Error", note: "#{exception.class.name}: #{exception.message}"} if exception
+        notes << {note_type: "Slow Job"} if runtime > Notable.slow_job_threshold
+
+        notes.each do |note|
+          data = {
+            note_type: note[:note_type],
+            note: note[:note],
+            job: job,
+            job_id: job_id,
+            queue: queue,
+            runtime: runtime,
+            queued_time: queued_time
+          }
+
+          Notable.track_job_method.call(data)
+        end
+      end
+
+      raise exception if exception
+    else
+      yield
+    end
+  end
+
+end
+
+ActionDispatch::DebugExceptions.send(:include, Notable::DebugExceptions)

data/notable.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'notable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "notable"
+  spec.version       = Notable::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+  spec.summary       = %q{Track notable requests and background jobs}
+  spec.description   = %q{Track notable requests and background jobs}
+  spec.homepage      = "https://github.com/ankane/notable"
+  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 "request_store"
+  spec.add_dependency "robustly"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: notable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: request_store
+  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: robustly
+  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: Track notable requests and background jobs
+email:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/models/notable/job.rb
+- app/models/notable/request.rb
+- lib/generators/notable/jobs_generator.rb
+- lib/generators/notable/requests_generator.rb
+- lib/generators/notable/templates/create_jobs.rb
+- lib/generators/notable/templates/create_requests.rb
+- lib/notable.rb
+- lib/notable/debug_exceptions.rb
+- lib/notable/engine.rb
+- lib/notable/job_backends/delayed_job.rb
+- lib/notable/job_backends/sidekiq.rb
+- lib/notable/middleware.rb
+- lib/notable/throttle.rb
+- lib/notable/unpermitted_parameters.rb
+- lib/notable/unverified_request.rb
+- lib/notable/validation_errors.rb
+- lib/notable/version.rb
+- notable.gemspec
+homepage: https://github.com/ankane/notable
+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: Track notable requests and background jobs
+test_files: []