raygun-apm-sidekiq 1.0.11 → 1.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ada58e6aa2ff6b48c268217c38693cac278aa306f682eb2dc69f73edb53b3b2e
-  data.tar.gz: 379565ec5a6a69f2f1f895bdbe60c7506a6eccd7cc913a773591021bb8a44003
+  metadata.gz: e8b45cd686413df0cefdc5546fbf08a31e36060b7393e828bd83c19239ad43c0
+  data.tar.gz: 1b3662d09b9d64a04539c9f5fceba35d73c34ec1847c492688170ee66de3ff85
 SHA512:
-  metadata.gz: bba188aa02c29dea66a6e8936da18a744328fa583e848aebb7fa37a524a0d79ba726b675106663c707252bf4b2179a288e7ec3f3149ee2426aeee0b65f8b0906
-  data.tar.gz: e9302fe170f3eb1b848303908399b5e9b507dcd6234cda89157eb0ccd0594ec95fdc7551385cbbb676050c0c32247d50595c781a39f31a7f514a9d0e9bb2877d
+  metadata.gz: dce241ad3576c65f8943d666b22db69b715fb1baa898a44f68ea16a03cb8e2ab35615cba1c47b61f5e05072a5a06f9458c871c3cede06683b88c383f51f49677
+  data.tar.gz: 2263c613a2deefeab136f326cf5a7cc2500975a587a4be6f9754fdc21688730312fcdece83c66c242cb827c90085539c1e28d502eee4f7cbe35664b73f668b1a

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/CHANGELOG.rdoc

@@ -1,5 +1,27 @@
 = Changelog
 
+== 1.0.16 (June 8, 2020)
+
+* Integrate exception correlation with rayrun4ruby
+* Move raygun4ruby whitelisting and blacklisting out to profiler core
+
+== 1.0.15 (May 17, 2020)
+
+* Remove the Tracer#process_started callback (set on begin transaction command now)
+
+== 1.0.14 (May 15, 2020)
+
+* Introduce support for Redis as client adapter
+* Prefer hooking Sidekiq::Processor as Middleware does not wrap enough to intercept the raygun4ruby error handler as an HTTP OUT event
+
+== 1.0.13 (April 2, 2020)
+
+* Prefer hooking Sidekiq::Processor as Middleware does not wrap enough to intercept the raygun4ruby error handler as an HTTP OUT event
+
+== 1.0.12 (March 25, 2020)
+
+* Do not cache PID on HTTP OUT and SQL events
+
 == 1.0.11 (March 15, 2020)
 
 * Emit the happy path and error state HTTP IN events for Sidekiq jobs WITHIN the entrypoint function for the agent to pick it up

data/Gemfile.lock

@@ -1,24 +1,24 @@
 PATH
   remote: .
   specs:
-    raygun-apm-rails (0.1.0)
-      raygun-apm (~> 0.0.8)
+    raygun-apm-sidekiq (1.0.16)
+      raygun-apm (~> 1.0.15)
 
 GEM
   remote: https://rubygems.org/
   specs:
     minitest (5.13.0)
     rake (10.5.0)
-    raygun-apm (0.0.8-x86-linux)
+    raygun-apm (1.0.43-universal-darwin)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler
   minitest (~> 5.0)
   rake (~> 10.0)
-  raygun-apm-rails!
+  raygun-apm-sidekiq!
 
 BUNDLED WITH
    1.17.3

data/lib/raygun/apm/sidekiq.rb

@@ -7,9 +7,9 @@ module Raygun
 
         BLACKLIST = %w{
           Sidekiq
-          Redis
-          +Raygun::Apm::Sidekiq::Middleware::Ruby_APM_profiler_trace
+          +Raygun::Apm::Sidekiq::Hook::Ruby_APM_profiler_trace
         }
+
     end
   end
 end

data/lib/raygun/apm/sidekiq/hook.rb

@@ -0,0 +1,135 @@
+require "sidekiq"
+require 'sidekiq/processor'
+
+module Raygun
+  module Apm
+    module Sidekiq
+      module Hook
+        def self.finalize(tracer)
+          proc {tracer.process_ended}
+        end
+
+        def initialize(mgr)
+          super
+          @tracer = Raygun::Apm::Tracer.instance || init_tracer          
+        end
+
+        def process(work)
+          job_hash = ::Sidekiq.load_json(work.job)
+          queue = work.queue_name
+          # Can be nil if we had a fatal error
+          if @tracer
+             @worker_started = @tracer.now
+             @tracer.start_trace
+          end
+          exception = nil
+          Ruby_APM_profiler_trace do
+            begin
+              super
+              fake_http_in_handler(@tracer, @worker_started, job_hash, queue, nil) if @tracer
+            rescue => e
+              fake_http_in_handler(@tracer, @worker_started, job_hash, queue, e) if @tracer
+              exception = e
+            end
+          end
+          # Can be nil if we had a fatal error
+          @tracer.end_trace if @tracer
+          raise exception if exception
+        rescue Raygun::Apm::FatalError => e
+          raygun_shutdown_handler(e)
+        end
+
+        private
+
+        def init_tracer
+          tracer = Raygun::Apm::Tracer.new
+          tracer.udp_sink!
+          ObjectSpace.define_finalizer(self, Hook.finalize(tracer))
+
+          ActiveSupport::Notifications.unsubscribe(@sql_subscriber) if @sql_subscriber
+          @sql_subscriber = ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
+            sql_handler(tracer, args)
+          end
+
+          GC.stress = true if ENV['RAYGUN_STRESS_GC']
+          Raygun::Apm::Tracer.instance = tracer
+          # If any fatal errors on init, shutdown the tracer
+        rescue Raygun::Apm::FatalError => e
+          raygun_shutdown_handler(e)
+        end
+
+        def raygun_shutdown_handler(exception)
+          warn "[Raygun APM] shutting down due to error - #{exception.message} #{exception.backtrace.join("\n")}"
+          # Kill extended event subcriptions
+          ActiveSupport::Notifications.unsubscribe(@sql_subscriber)
+          warn "[Raygun APM] notification hooks unsubscribed"
+          # Let the GC clean up the sink thread through the finalizer below
+          @tracer = nil
+          Raygun::Apm::Tracer.instance = nil
+          raise(exception) unless (Raygun::Apm::FatalError === exception)
+        end
+
+        def fake_http_in_handler(tracer, started, msg, queue, exception)
+          ended = tracer.now
+          event = http_in_event
+          event[:pid] = Process.pid
+          event[:url] = "sidekiq://#{queue}/#{msg["class"]}?#{msg["jid"]}"
+          event[:status] = exception ? 500 : 200
+          event[:duration] = ended - started
+          event[:timestamp] = tracer.now
+          event[:tid] = tracer.get_thread_id(Thread.current)
+          tracer.emit(event)
+        rescue => e
+          warn "[Raygun APM] error reporting HTTP IN event #{e.class} #{e.backtrace.join("\n")}"
+          raygun_shutdown_handler(e)
+        end
+
+        def http_in_event
+          @http_in_event ||= begin
+            event = Raygun::Apm::Event::HttpIn.new
+            event[:verb] = "POST"
+            event
+          end
+        end
+
+        def sql_handler(tracer, args)
+          notification = ActiveSupport::Notifications::Event.new *args
+          connection = if notification.payload[:connection]
+            notification.payload[:connection]
+          else
+            ObjectSpace._id2ref(notification.payload[:connection_id])
+          end
+          event = sql_event
+          event[:pid] = Process.pid
+          event[:query] = notification.payload[:sql]
+  
+          # XXX this is hacky
+          if config = connection.instance_variable_get('@config')
+            event[:provider] = config[:adapter]
+            event[:host] = config[:host]
+            event[:database] = config[:database]
+          end
+  
+          # XXX constant milliseconds to microseconds
+          event[:duration] = notification.duration * 1000
+          event[:timestamp] = notification.time.to_f * 1000000
+          event[:tid] = tracer.get_thread_id(Thread.current)
+          tracer.emit(event)
+        rescue => e
+          warn "[Raygun APM] error reporting SQL event"
+          raygun_shutdown_handler(e)
+        end
+
+        def sql_event
+          @sql_event ||= Raygun::Apm::Event::Sql.new
+        end
+
+        def Ruby_APM_profiler_trace
+          yield
+        end
+      end
+    end
+  end
+end
+
+Sidekiq::Processor.prepend Raygun::Apm::Sidekiq::Hook

data/lib/raygun/apm/sidekiq/railtie.rb

@@ -4,18 +4,16 @@ module Raygun
       class Railtie < ::Rails::Railtie
         initializer "raygun.apm.sidekiq" do |app|
           require "raygun/apm"
-          require "raygun/apm/sidekiq/middleware"
-          require "sidekiq"
+          require "raygun/apm/sidekiq/hook"
           Raygun::Apm::Blacklist.extend_with Raygun::Apm::Sidekiq::BLACKLIST
-
-          ::Sidekiq.configure_server do |config|
-            config.server_middleware do |chain|
-              chain.prepend Raygun::Apm::Sidekiq::Middleware
-            end
-          end
-
           # Explictly enable instrumenting HTTP until a good control API is figured out
           require "raygun/apm/hooks/net_http"
+          require "raygun/apm/hooks/redis" if defined?(Redis::Client)
+          # Attempt to explicitly require the raygun4ruby sidekiq integration
+          begin
+            require "raygun/sidekiq"
+          rescue LoadError
+          end
         end
       end
     end

data/lib/raygun/apm/sidekiq/version.rb

@@ -1,7 +1,7 @@
 module Raygun
   module Apm
     module Sidekiq
-      VERSION = "1.0.11"
+      VERSION = "1.0.16"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raygun-apm-sidekiq
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.0.16
 platform: ruby
 authors:
 - Raygun
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-15 00:00:00.000000000 Z
+date: 2020-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: raygun-apm
@@ -75,6 +75,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - CHANGELOG.rdoc
 - Gemfile
 - Gemfile.lock
@@ -83,10 +84,9 @@ files:
 - bin/console
 - bin/setup
 - lib/raygun/apm/sidekiq.rb
-- lib/raygun/apm/sidekiq/middleware.rb
+- lib/raygun/apm/sidekiq/hook.rb
 - lib/raygun/apm/sidekiq/railtie.rb
 - lib/raygun/apm/sidekiq/version.rb
-- raygun-apm-sidekiq-1.0.0.gem
 - raygun-apm-sidekiq.gemspec
 homepage: https://raygun.com/platform/apm
 licenses: []

data/lib/raygun/apm/sidekiq/middleware.rb

@@ -1,127 +0,0 @@
-module Raygun
-    module Apm
-      module Sidekiq
-        class Middleware
-          def initialize
-            @tracer = Raygun::Apm::Tracer.instance || self.class.init_tracer
-          end
-
-          def call(worker_instance, msg, queue)
-            # Can be nil if we had a fatal error
-            if @tracer
-              started = @tracer.now
-              @tracer.start_trace
-            end
-            exception = nil
-            Ruby_APM_profiler_trace do
-              yield
-              self.class.fake_http_in_handler(@tracer, started, worker_instance, msg, queue, nil) if @tracer
-            rescue => e
-              self.class.fake_http_in_handler(@tracer, started, worker_instance, msg, queue, exception) if @tracer
-            end
-            # Can be nil if we had a fatal error
-            @tracer.end_trace if @tracer
-          rescue Raygun::Apm::FatalError => e
-            self.class.raygun_shutdown_handler(e)
-          end
-
-          private
-
-          def self.init_tracer
-            tracer = Raygun::Apm::Tracer.new
-            tracer.udp_sink!
-            tracer.process_started
-            ObjectSpace.define_finalizer(self, self.finalize(tracer))
-  
-            @sql_subscriber = ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
-              sql_handler(tracer, args)
-            end
-
-            GC.stress = true if ENV['RAYGUN_STRESS_GC']
-            Raygun::Apm::Tracer.instance = tracer
-            # If any fatal errors on init, shutdown the tracer
-          rescue Raygun::Apm::FatalError => e
-            raygun_shutdown_handler(e)
-          end
-
-          def self.raygun_shutdown_handler(exception)
-            warn "Raygun APM shutting down due to error - %s", exception.message
-            # Kill extended event subcriptions
-            ActiveSupport::Notifications.unsubscribe(@sql_subscriber)
-            warn "[Raygun APM] notification hooks unsubscribed"
-            # Let the GC clean up the sink thread through the finalizer below
-            @tracer = nil
-            Raygun::Apm::Tracer.instance = nil
-            raise(exception) unless (Raygun::Apm::FatalError === exception)
-          end
-  
-          def self.fake_http_in_handler(tracer, started, worker_instance, msg, queue, exception)
-            ended = tracer.now
-            event = http_in_event
-            event[:url] = "sidekiq://#{queue}/#{msg["class"]}?#{msg["jid"]}"
-            event[:status] = exception ? 500 : 200
-            event[:duration] = ended - started
-            event[:timestamp] = tracer.now
-            event[:tid] = tracer.get_thread_id(Thread.current)
-            tracer.emit(event)
-            raise(exception) if exception
-          rescue => e
-            warn "[Raygun APM] error reporting HTTP IN event"
-            raygun_shutdown_handler(e)
-          end
-
-          def self.http_in_event
-            @http_in_event ||= begin
-              event = Raygun::Apm::Event::HttpIn.new
-              event[:pid] = Process.pid
-              event[:verb] = "POST"
-              event
-            end
-          end
-
-          def self.sql_handler(tracer, args)
-            notification = ActiveSupport::Notifications::Event.new *args
-            connection = if notification.payload[:connection]
-              notification.payload[:connection]
-            else
-              ObjectSpace._id2ref(notification.payload[:connection_id])
-            end
-            event = sql_event
-            event[:query] = notification.payload[:sql]
-  
-            # XXX this is hacky
-            if config = connection.instance_variable_get('@config')
-              event[:provider] = config[:adapter]
-              event[:host] = config[:host]
-              event[:database] = config[:database]
-            end
-  
-            # XXX constant milliseconds to microseconds
-            event[:duration] = notification.duration * 1000
-            event[:timestamp] = notification.time.to_f * 1000000
-            event[:tid] = tracer.get_thread_id(Thread.current)
-            tracer.emit(event)
-          rescue => e
-            warn "[Raygun APM] error reporting SQL event"
-            raygun_shutdown_handler(e)
-          end
-
-          def self.sql_event
-            @sql_event ||= begin
-              event = Raygun::Apm::Event::Sql.new
-              event[:pid] = Process.pid
-              event
-            end
-          end
-
-          def Ruby_APM_profiler_trace
-            yield
-          end
-
-          def self.finalize(tracer)
-            proc {tracer.process_ended}
-          end
-        end
-      end
-    end
-  end