rails_riemann_middleware 0.6.0 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c54c3065cac2c767f26a82c65b1b2e2aba85dd0
+  data.tar.gz: 205f6789a8724cfd452fde70c767cee6f48aaa2f
+SHA512:
+  metadata.gz: 2f894756e9f09ee625ef4f2f77d950568b6ae2765153da66e3189f11e8d147e13eb55d867a005766020b0e2cfcb10bfb9fddcc7c231fa18eb41616d7800aa66b
+  data.tar.gz: 2f68c002683ccfe1d398575e3d01b80efc8a8fe139795341c08fca367ff187e6f2ca1f8f2d947e917ce4ae81c6fcd5ce82ebfd7a598aedfb3d6b53f80d4483fd

data/README.md

@@ -22,8 +22,36 @@ Or install it yourself as:
 
 Add the following to your specific rails enviroment.
 
+    config.riemann_options = (:riemann_host => "riemann_host_name")
+
     config.middleware.use(RailsRiemannMiddleware::Notifier, 
-                          :riemann_host => "riemann_host_name")
+                          config.riemann_options)
+
+If you would like to pull custom headers out of the env for reporting, 
+you can add 
+
+    :additional_headers => ['SOME_HEADER', 'SOME_OTHER_HEADER']
+
+Those will be reported for both exceptions and duration events. If the
+header is not defined, it will be reported as 'N/A'.
+
+## ExceptionNotification 3.x API
+
+If you, like us, are transitioning from the exception\_notification gem,
+we support the API from the 3.x version of that gem for explicit calls
+to the exception notifier. For example, if you are catching exceptions in
+your controllers (preventing them from bubbling up automatically), you can
+call:
+
+    RailsRiemannMiddleware::RailsExceptionNotifier.exception_notification(env, error)
+
+In your models or other background processes, you can call:
+
+    RailsRiemannMiddleware::RailsExceptionNotifier.background_exception_notification(error) 
+
+To use this extra functionality, you have to
+
+    require 'rails_riemann_middleware/rails_exception_notifier'
 
 ## Running Tests
 

data/lib/rails_riemann_middleware/duration.rb

@@ -3,10 +3,11 @@ require "rails_riemann_middleware/headers"
 module RailsRiemannMiddleware
 
   class Duration
-    attr_reader :event, :env, :start_time
+    attr_reader :event, :env, :start_time, :headers
     
-    def initialize(event, env, start_time)
+    def initialize(event, env, start_time, options={})
       @event, @env, @start_time = event, env, start_time
+      @headers = options.fetch(:headers, [])
     end
 
     def send
@@ -22,7 +23,7 @@ module RailsRiemannMiddleware
         :state       => 'info',
         :metric      => duration,
         :tags        => ["duration"],
-        :description => Headers.new(env).to_s
+        :description => Headers.new(env, headers).to_s
       }
       msg
     end

data/lib/rails_riemann_middleware/exception_notification.rb

@@ -3,10 +3,11 @@ require "rails_riemann_middleware/headers"
 module RailsRiemannMiddleware
 
   class ExceptionNotification
-    attr_reader :event, :env, :exception
+    attr_reader :event, :env, :exception, :headers
 
-    def initialize(event, env, exception)
+    def initialize(event, env, exception, options={})
       @event, @env, @exception = event, env, exception
+      @headers = options.fetch(:headers, [])
     end
 
     def send
@@ -34,7 +35,7 @@ module RailsRiemannMiddleware
     def backtrace
       e = ["#{exception.to_s}"]
       e << "----------------------------------------"
-      e += Headers.new(env).to_a
+      e += Headers.new(env, headers).to_a
       e << "----------------------------------------\n"
       e += exception.backtrace
       e.join("\n")[0..8000]

data/lib/rails_riemann_middleware/headers.rb

@@ -2,14 +2,15 @@ module RailsRiemannMiddleware
 
   class Headers
 
-    attr_reader :env
+    attr_reader :env, :custom_headers
     
-    def initialize(env)
+    def initialize(env, custom_headers=[])
       @env = env
+      @custom_headers = custom_headers
     end
 
     def keys
-      %w{REQUEST_METHOD REQUEST_URI PATH_INFO HTTP_X_REAL_IP HTTP_USER_AGENT HTTP_REFERER}
+      %w{REQUEST_METHOD REQUEST_URI PATH_INFO HTTP_X_REAL_IP HTTP_USER_AGENT HTTP_REFERER} + custom_headers
     end
     
     def to_a

data/lib/rails_riemann_middleware/rails_exception_notifier.rb

@@ -0,0 +1,25 @@
+module RailsRiemannMiddleware
+  class RailsExceptionNotifier
+    def self.exception_notification(env, exception, options={})
+      app = options.fetch(:app) {Rails.application}
+      options = app.config.riemann_options.merge(options)
+      headers = options.delete(:additional_headers)
+
+      event = Event.new(options)
+
+      ExceptionNotification.new(event, env, exception,
+                                headers: headers)
+    end
+
+    def self.background_exception_notification(exception, options={})
+      app = options.fetch(:app) {Rails.application}
+      options = app.config.riemann_options.merge(options)
+      headers = options.delete(:additional_headers)
+
+      event = Event.new(options)
+      env = {}
+
+      ExceptionNotification.new(event, env, exception)
+    end
+  end
+end

data/lib/rails_riemann_middleware/version.rb

@@ -1,3 +1,3 @@
 module RailsRiemannMiddleware
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/lib/rails_riemann_middleware.rb

@@ -6,7 +6,7 @@ require "rails_riemann_middleware/exception_notification"
 module RailsRiemannMiddleware
 
   class Notifier
-    attr_reader :event, :send_durations, :send_exceptions
+    attr_reader :event, :send_durations, :send_exceptions, :options
 
     def initialize(app, options = {})
       @app, @options = app, options
@@ -19,22 +19,10 @@ module RailsRiemannMiddleware
       start_time = Time.now
       @app.call(env)
     rescue Exception => exception
-      ExceptionNotification.new(event, env, exception).send if send_exceptions
+      ExceptionNotification.new(event, env, exception, options).send if send_exceptions
       raise exception
     ensure
-      Duration.new(event, env, start_time).send if send_durations
-    end
-
-    def self.exception_notification(env, exception)
-      event = Event.new
-      ExceptionNotification.new(event, env, exception)
-    end
-
-    def self.background_exception_notification(exception)
-      event = Event.new
-      env = {}
-      ExceptionNotification.new(event, env, exception)
+      Duration.new(event, env, start_time, options).send if send_durations
     end
   end
-
 end

data/specs/{notifier_spec.rb → rails_exception_notifier_spec.rb}

@@ -1,8 +1,27 @@
 require_relative 'spec_helper'
 require 'rails_riemann_middleware'
+require 'rails_riemann_middleware/rails_exception_notifier'
+
+class DummyAppConfig
+  def riemann_options
+    {}
+  end
+end
+
+class DummyApplication
+  def config
+    DummyAppConfig.new
+  end
+end
+
+module Rails
+  def self.application
+    DummyApplication.new
+  end
+end
 
 module RailsRiemannMiddleware
-  describe Notifier do
+  describe RailsExceptionNotifier do
     let(:exception_notification_new) { MiniTest::Mock.new }
     let(:error) { Object.new }
 
@@ -15,7 +34,7 @@ module RailsRiemannMiddleware
         end
 
         ExceptionNotification.stub(:new, exception_notification_new) do
-          Notifier.exception_notification(env, error)
+          RailsExceptionNotifier.exception_notification(env, error)
         end
         exception_notification_new.verify
       end
@@ -28,7 +47,7 @@ module RailsRiemannMiddleware
         end
 
         ExceptionNotification.stub(:new, exception_notification_new) do
-          Notifier.background_exception_notification(error)
+          RailsExceptionNotifier.background_exception_notification(error)
         end
         exception_notification_new.verify
       end

metadata

@@ -1,27 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rails_riemann_middleware
 version: !ruby/object:Gem::Version
-  version: 0.6.0
-  prerelease: 
+  version: 0.7.0
 platform: ruby
 authors:
 - Richard Outten
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-29 00:00:00.000000000 Z
+date: 2014-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riemann-client
-  requirement: &70117650213820 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70117650213820
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 description: Rack middleware for sending data to riemann
 email:
 - outtenr@gmail.com
@@ -39,36 +41,36 @@ files:
 - lib/rails_riemann_middleware/event.rb
 - lib/rails_riemann_middleware/exception_notification.rb
 - lib/rails_riemann_middleware/headers.rb
+- lib/rails_riemann_middleware/rails_exception_notifier.rb
 - lib/rails_riemann_middleware/version.rb
 - rails_riemann_middleware.gemspec
 - specs/duration_spec.rb
 - specs/exception_notification_spec.rb
-- specs/notifier_spec.rb
+- specs/rails_exception_notifier_spec.rb
 - specs/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Rack middleware for sending data to riemann
 test_files: []
 has_rdoc: