rollbar 0.9.13 → 0.9.14

data/CHANGELOG.md

@@ -1,9 +1,13 @@
 # Change Log
 
+**0.9.14**
+- Added `custom_data_method` config option. If set, it should be a lambda that returns a hash.
+- Changed initializer template to disable reporting from the 'test' environment.
+
 **0.9.13**
 - Add test for PUT params
 - Parse json params when content-type is application/json
-- Remove extraneous
+- Fix concurrency issue
 - Remove redundant `GET` and `POST` keys from request payload (they're already included in `params`)
 
 **0.9.12**

data/README.md

@@ -99,6 +99,21 @@ If the methods to extract the `id`, `username`, and `email` from the object retu
 ```
 
 
+## Including additional runtime data
+
+You can provide a lambda that will be called for each exception or message report.  `custom_data_method` should be a lambda that takes no arguments and returns a hash. 
+
+Add the following in `config/initializers/rollbar.rb`:
+
+```ruby
+  config.custom_data_method = lambda {
+    { :some_key => :some_value, :complex_key => {:a => 1, :b => [2, 3, 4]} }
+  }
+```
+
+This data will appear in the Occurrences tab and on the Occurrence Detail pages in the Rollbar interface.
+
+
 ## Exception level filters
 
 By default, all exceptions reported through `Rollbar.report_exception()` are reported at the "error" level, except for the following, which are reported at "warning" level:

data/lib/generators/rollbar/templates/initializer.rb

@@ -2,11 +2,12 @@ require 'rollbar/rails'
 Rollbar.configure do |config|
   config.access_token = <%= access_token_expr %>
 
-  # Rollbar is enabled by default in all environments. To disable in specific 
-  # environments (e.g. 'test'):
-  # if Rails.env.test?
-  #   config.enabled = false
-  # end
+  # Without configuration, Rollbar is enabled by in all environments. 
+  # To disable in specific environments, set config.enabled=false.
+  # Here we'll disable in 'test':
+  if Rails.env.test?
+    config.enabled = false
+  end
 
   # By default, Rollbar will try to call the `current_user` controller method
   # to fetch the logged-in user object, and then call that object's `id`,
@@ -16,6 +17,10 @@ Rollbar.configure do |config|
   # config.person_username_method = "my_username"
   # config.person_email_method = "my_email"
 
+  # If you want to attach custom data to all exception and message reports,
+  # provide a lambda like the following. It should return a hash.
+  # config.custom_data_method = lambda { {:some_key => "some_value" } }
+
   # Add exception class names to the exception_level_filters hash to
   # change the level that exception is reported at. Note that if an exception
   # has already been reported and logged the level will need to be changed

data/lib/rollbar.rb

@@ -337,6 +337,10 @@ module Rollbar
         data[:uuid] = SecureRandom.uuid
       end
 
+      unless config.custom_data_method.nil?
+        data[:custom] = config.custom_data_method.call
+      end
+
       data
     end
 

data/lib/rollbar/configuration.rb

@@ -6,6 +6,7 @@ module Rollbar
     attr_accessor :access_token
     attr_accessor :async_handler
     attr_accessor :branch
+    attr_accessor :custom_data_method
     attr_accessor :default_logger
     attr_accessor :enabled
     attr_accessor :endpoint
@@ -32,6 +33,7 @@ module Rollbar
 
     def initialize
       @async_handler = nil
+      @custom_data_method = nil
       @default_logger = lambda { Logger.new(STDERR) }
       @enabled = nil  # set to true when configure is called
       @endpoint = DEFAULT_ENDPOINT

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = "0.9.13"
+  VERSION = "0.9.14"
 end

data/spec/rollbar_spec.rb

@@ -303,6 +303,7 @@ describe Rollbar do
       data = Rollbar.send(:message_data, @message_body, @level, {})
       data[:body][:message][:body].should == @message_body
       data[:level].should == @level
+      data[:custom].should be_nil
     end
 
     it 'should accept extra_data' do
@@ -312,11 +313,30 @@ describe Rollbar do
       data = Rollbar.send(:message_data, @message_body, 'info',
                             :user_id => user_id, :name => name)
 
+      data[:level].should == 'info'
       message = data[:body][:message]
       message[:body].should == @message_body
       message[:user_id].should == user_id
       message[:name].should == name
     end
+
+    it 'should build a message with custom data when configured' do
+      Rollbar.configure do |config|
+        config.custom_data_method = lambda { {:foo => "bar", :hello => [1, 2, 3]} }
+      end
+
+      data = Rollbar.send(:message_data, @message_body, @level, {})
+
+      data[:level].should == @level
+      data[:body][:message][:body].should == @message_body
+      data[:custom].should_not be_nil
+      data[:custom][:foo].should == "bar"
+      data[:custom][:hello][2].should == 3
+
+      Rollbar.configure do |config|
+        config.custom_data_method = nil
+      end
+    end
   end
 
   context 'exception_data' do
@@ -339,6 +359,7 @@ describe Rollbar do
       data = Rollbar.send(:exception_data, @exception)
 
       data[:level].should_not be_nil
+      data[:custom].should be_nil
 
       trace = data[:body][:trace]
 
@@ -357,6 +378,22 @@ describe Rollbar do
       trace[:exception][:class].should match(/^(NameError|NoMethodError)$/)
       trace[:exception][:message].should match(/^(undefined local variable or method `bar'|undefined method `bar' on an instance of)/)
     end
+    
+    it 'should include custom data when configured' do
+      Rollbar.configure do |config|
+        config.custom_data_method = lambda { {:foo => "baz", :hello => [4, 5, 6]} }
+      end
+
+      data = Rollbar.send(:exception_data, @exception)
+      data[:body][:trace].should_not be_nil
+      data[:custom][:foo].should == "baz"
+      data[:custom][:hello][2].should == 6
+
+      Rollbar.configure do |config|
+        config.custom_data_method = nil
+      end
+    end
+
   end
 
   context 'logger' do
@@ -421,11 +458,27 @@ describe Rollbar do
     
     it 'should have an overridden environment' do
       Rollbar.configure do |config|
-        config.environment = 'development'
+        config.environment = 'overridden'
       end
       
       data = Rollbar.send(:base_data)
-      data[:environment].should == 'development'
+      data[:environment].should == 'overridden'
+    end
+
+    it 'should not have custom data under default configuration' do
+      data = Rollbar.send(:base_data)
+      data[:custom].should be_nil
+    end
+
+    it 'should have custom data when custom_data_method is configured' do
+      Rollbar.configure do |config|
+        config.custom_data_method = lambda { {:a => 1, :b => [2, 3, 4]} }
+      end
+
+      data = Rollbar.send(:base_data)
+      data[:custom].should_not be_nil
+      data[:custom][:a].should == 1
+      data[:custom][:b][2].should == 4
     end
   end
 
@@ -446,7 +499,7 @@ describe Rollbar do
       data[:branch].should == 'master'
     end
   end
-    
+
   context "project_gems" do
     it "should include gem paths for specified project gems in the payload" do
       gems = ['rack', 'rspec-rails']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rollbar
 version: !ruby/object:Gem::Version
-  version: 0.9.13
+  version: 0.9.14
   prerelease: 
 platform: ruby
 authors: