raygun4ruby 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b5dc6fa5ba97eb5e725e33957adb0938d497c04
-  data.tar.gz: d8251293800014da04f65d59a7de524310bf0575
+  metadata.gz: 12ad609c25703e38bf187602b1eeb27ed13f9fdb
+  data.tar.gz: 5af743e3db72f0339669b255328d8256be2c6314
 SHA512:
-  metadata.gz: a7e838b56806115af7f151908b8323c106677de99764b4fe0a30939cc15e9a529f34193643c3173d02ccd65c60b8492cd96b934f317f3b44f46827463d86a8b1
-  data.tar.gz: 362c3b34876de277572b93e7c4017adee6222839a3e1c711c7cf20181438501d302446d95735c4d8f61b719ae2dbfdc93428ef4ce61276158a6505e0d062854a
+  metadata.gz: 070d775307e84cd705e14c6c6a245d4508c8dfcb95991da06ef62e825255a12fde096808e27d65a11bc2c2e20e892270f3e005eb65a4c9280575075ed3a45bdc
+  data.tar.gz: 9b011bb6ca157c9fbcd0283721d40a48e90e857425c7055ad93f1445c98eb9c5103c3d7a6bbb2a6e18059bfbf2181d7b66e14c8a0a5ef65782ac84cf6dfcfbe9

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.6.0 (25/10/2017)
+
+Features
+  - Enhanced debug logging to assist in resolving issues from support requests ([#128](https://github.com/MindscapeHQ/raygun4ruby/pull/128))
+
 ## 2.5.0 (04/10/2017)
 
 Features
@@ -5,7 +10,7 @@ Features
 
 Bugfixes
   - Fix crash when recording breadcrumb with uninitialized store ([#126](https://github.com/MindscapeHQ/raygun4ruby/pull/126))
-  - Make raw data handling more robus and fix in unicorn ([#125](https://github.com/MindscapeHQ/raygun4ruby/pull/125))
+  - Make raw data handling more robust and fix in unicorn ([#125](https://github.com/MindscapeHQ/raygun4ruby/pull/125))
   - Backwards compatible affected_user_identifier_methods ([#120](https://github.com/MindscapeHQ/raygun4ruby/pull/120))
 
 ## 2.4.1 (29/08/2017)

data/lib/raygun/client.rb

@@ -90,6 +90,8 @@ module Raygun
       end
 
       def request_information(env)
+        Raygun.log('retrieving request information')
+
         return {} if env.nil? || env.empty?
         {
           hostName:    env["SERVER_NAME"],
@@ -118,6 +120,8 @@ module Raygun
       end
 
       def form_params(env)
+        Raygun.log('retrieving form params')
+
         params = action_dispatch_params(env) || rack_params(env) || {}
         filter_params_with_blacklist(params, env["action_dispatch.parameter_filter"])
       end
@@ -132,10 +136,12 @@ module Raygun
       end
 
       def raw_data(rack_env)
+        Raygun.log('retrieving raw data')
         request = Rack::Request.new(rack_env)
 
         return unless Raygun.configuration.record_raw_data
         return if request.get?
+        Raygun.log('passed raw_data checks')
 
         input = rack_env['rack.input']
 
@@ -158,6 +164,7 @@ module Raygun
 
       # see http://raygun.io/raygun-providers/rest-json-api?v=1
       def build_payload_hash(exception_instance, env = {}, user = nil)
+        Raygun.log('building payload hash')
         custom_data = filter_custom_data(env) || {}
         exception_custom_data = if exception_instance.respond_to?(:raygun_custom_data)
                                   exception_instance.raygun_custom_data
@@ -180,6 +187,8 @@ module Raygun
           configuration_tags = Raygun.configuration.tags
         end
 
+        Raygun.log('set tags')
+
         grouping_key = env.delete(:grouping_key)
 
         configuration_custom_data = Raygun.configuration.custom_data
@@ -189,6 +198,8 @@ module Raygun
                                   configuration_custom_data
                                  end
 
+        Raygun.log('set custom data')
+
         error_details = {
             machineName:    hostname,
             version:        version,
@@ -204,6 +215,8 @@ module Raygun
         store = ::Raygun::Breadcrumbs::Store
         error_details[:breadcrumbs] = store.stored.map(&:build_payload) if store.any?
 
+        Raygun.log('set details and breadcrumbs')
+
         error_details.merge!(groupingKey: grouping_key) if grouping_key
 
         user_details = if affected_user_present?(env)
@@ -213,7 +226,10 @@ module Raygun
                        end
         error_details.merge!(user: user_details) unless user_details == nil
 
+        Raygun.log('set user details')
+
         if Raygun.configuration.filter_payload_with_whitelist
+          Raygun.log('filtering payload with whitelist')
           error_details = filter_payload_with_whitelist(error_details)
         end
 
@@ -224,6 +240,8 @@ module Raygun
       end
 
       def create_entry(payload_hash)
+        Raygun.log('sending payload to api')
+
         self.class.post("/entries", verify_peer: true, verify: true, headers: @headers, body: JSON.generate(payload_hash))
       end
 

data/lib/raygun/version.rb

@@ -1,3 +1,3 @@
 module Raygun
-  VERSION = "2.5.0"
+  VERSION = "2.6.0"
 end

data/lib/raygun.rb

@@ -32,7 +32,6 @@ module Raygun
   CLIENT_NAME = "Raygun4Ruby Gem"
 
   class << self
-
     include Testable
 
     # Configuration Object (instance of Raygun::Configuration)
@@ -40,6 +39,8 @@ module Raygun
 
     def setup
       yield(configuration)
+
+      log("configuration settings: #{configuration.inspect}")
     end
 
     def configuration
@@ -55,6 +56,8 @@ module Raygun
     end
 
     def track_exception(exception_instance, env = {}, user = nil, retry_count = 1)
+      log('tracking exception')
+
       if configuration.send_in_background
         track_exception_async(exception_instance, env, user, retry_count)
       else
@@ -78,6 +81,8 @@ module Raygun
         method_name: nil,
         line_number: nil
     )
+      log('recording breadcrumb')
+
       Raygun::Breadcrumbs::Store.record(
         message: message,
         category: category,
@@ -91,7 +96,9 @@ module Raygun
     end
 
     def log(message)
-      configuration.logger.info(message) if configuration.logger
+      return unless configuration.debug
+
+      configuration.logger.info("[Raygun] #{message}") if configuration.logger
     end
 
     def failsafe_log(message)
@@ -112,17 +119,19 @@ module Raygun
       future = Concurrent::Future.execute { track_exception_sync(*args) }
       future.add_observer(lambda do |_, value, reason|
         if value == nil || value.response.code != "202"
-          log("[Raygun] unexpected response from Raygun, could indicate error: #{value.inspect}")
+          log("unexpected response from Raygun, could indicate error: #{value.inspect}")
         end
       end, :call)
     end
 
     def track_exception_sync(exception_instance, env, user, retry_count)
       if should_report?(exception_instance)
-        log("[Raygun] Tracking Exception...")
+        log('attempting to send exception')
         Client.new.track_exception(exception_instance, env, user)
       end
     rescue Exception => e
+      log('error sending exception to raygun, see failsafe logger for more information')
+
       if configuration.failsafe_logger
         failsafe_log("Problem reporting exception to Raygun: #{e.class}: #{e.message}\n\n#{e.backtrace.join("\n")}")
       end
@@ -147,17 +156,13 @@ module Raygun
 
     def should_report?(exception)
       if configuration.silence_reporting
-        if configuration.debug
-          log('[Raygun] skipping reporting because Configuration.silence_reporting is enabled')
-        end
+        log('skipping reporting because Configuration.silence_reporting is enabled')
 
         return false
       end
 
       if configuration.ignore.flatten.include?(exception.class.to_s)
-        if configuration.debug
-          log("[Raygun] skipping reporting of exception #{exception.class} because it is in the ignore list")
-        end
+        log("skipping reporting of exception #{exception.class} because it is in the ignore list")
 
         return false
       end

data/lib/raygun4ruby.rb

@@ -1 +1 @@
-require "raygun"
+require "raygun"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raygun4ruby
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Mindscape
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-03 00:00:00.000000000 Z
+date: 2017-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty