alexb-raygun-apm-sidekiq 1.0.21

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c4ae18213fc0abb4d5575d6191c0a266ce11088e68961b33fde10bfeb9a6c89
+  data.tar.gz: 0335266a8f195d5fb22682a255150a2a7493aca5a76b145fbee1ab1610e4194a
+SHA512:
+  metadata.gz: 2fd5a03970df814e925190eb25588cfe9a36a4c0db6f47b67594c0ece6dabb8160eb4cfed50f32d7f78b4ddc4896b5d3ac6c322f0ad6bb4383a8dfb88154a0fc
+  data.tar.gz: 31dc61ac4bb79c0d802b62e65a23876051a4bb03efc83d0e5179b11b1a9febcbdc672567531379c5f5497327981d4e6e00cc5ceb28c28888aad323c286ab144b

data/README.rdoc

@@ -0,0 +1,82 @@
+= Raygun Application Performance Monitoring
+
+{Sidekiq}[https://github.com/mperham/sidekiq] for {Raygun Application Performance Monitoring}[https://raygun.com/platform/apm].
+
+Distributed as a Rails and Sidekiq wrapper to inject the precompiled native profiler gem into Sidekiq jobs.
+
+== Supported platforms
+* x86-mingw32
+* x64-mingw32
+* x86-linux
+* x86_64-linux
+* universal-darwin
+
+{Contact us}[https://raygun.com/about/contact] to support other platforms.
+
+== Supported Ruby versions
+
+The profiler only supports CRuby, also known as Matz's Ruby Interpreter (MRI).
+
+* 2.5.x
+* 2.6.x
+* 2.7.x
+
+{Contact us}[https://raygun.com/about/contact] to support other Ruby versions.
+
+== Supported Rails versions
+
+Rails 4 and up.
+
+* Rails 4.x
+* Rails 5.x
+* Rails 6.x
+
+{Contact us}[https://raygun.com/about/contact] to support other Rails versions.
+
+== Agent Setup
+
+The Profiler needs to be able to access the Raygun Agent over UDP.
+
+The <code>RAYGUN_AGENT_TOKEN</code> needs to be supplied as an argument and is available under "Application Settings" at the {Raygun Application Performance Monitoring}[https://raygun.com/platform/apm] UI
+
+To launch Raygun Agent using docker
+    docker pull raygunowner/raygun-apm
+    docker run -v raygun-agent:/usr/share/Raygun -e "RAYGUN_AGENT_TOKEN=<token>" -p 2790:2790 -p 2788:2788 -p 2799:2799/udp -it raygunowner/raygun-apm:latest
+
+== Profiler Setup
+
+Include the gem in your Gemfile and enable it for all environments:
+
+    gem 'raygun-apm-sidekiq'
+
+Preferably this profiler should only be enabled for your production environment:
+
+    group :production do
+      gem 'raygun-apm-sidekiq'
+    end
+
+It is intended to work best alongside the {raygun-apm-rails}[https://rubygems.org/gems/raygun-apm-rails] gem to profile both inline Web and async job work.
+
+
+    group :production do
+      gem 'raygun-apm-rails'
+      gem 'raygun-apm-sidekiq'
+    end
+
+
+Run <code>bundle</code> to install the gem.
+
+Alternatively install using rubygems <code>gem install raygun-apm-sidekiq</code>.
+
+== Rails workloads supported
+
+Currently we only hook into the framework with Rack middleware and thus only
+instrument HTTP request / response workloads.
+
+The following extended events are captured:
+
+* HTTP inbound - the request URI, HTTP verb and other details of the current job
+* HTTP outbound - the URI, HTTP verb and time taken (typically external APIs)
+* Database queries - SQL statement, provider, database etc. 
+
+{Contact us}[https://raygun.com/about/contact] to support other specific background processing frameworks.

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "raygun/apm/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/raygun/apm/sidekiq.rb

@@ -0,0 +1,19 @@
+require "raygun/apm/sidekiq/version"
+
+module Raygun
+  module Apm
+    module Sidekiq
+      class Error < StandardError; end
+
+        BLACKLIST = %w{
+          Sidekiq
+          +Raygun::Apm::Sidekiq::Hook#Ruby_APM_profiler_trace
+        }
+
+    end
+  end
+end
+
+if defined?(::Rails) && !ENV['RAYGUN_SKIP_MIDDLEWARE']
+  require "raygun/apm/sidekiq/railtie"
+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

@@ -0,0 +1,21 @@
+module Raygun
+  module Apm
+    module Sidekiq
+      class Railtie < ::Rails::Railtie
+        initializer "raygun.apm.sidekiq" do |app|
+          require "raygun/apm"
+          require "raygun/apm/sidekiq/hook"
+          Raygun::Apm::Blacklist.extend_with Raygun::Apm::Sidekiq::BLACKLIST
+          # 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
+  end
+end

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

@@ -0,0 +1,7 @@
+module Raygun
+  module Apm
+    module Sidekiq
+      VERSION = "1.0.21"
+    end
+  end
+end

data/raygun-apm-sidekiq.gemspec

@@ -0,0 +1,25 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "raygun/apm/sidekiq/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "alexb-raygun-apm-sidekiq"
+  spec.version       = Raygun::Apm::Sidekiq::VERSION
+  spec.authors       = ["Raygun", "Erkki Eilonen"]
+  spec.email         = ["support@raygun.com", "info@bearmetal.eu"]
+
+  spec.summary       = %q{Raygun application performance monitoring for Sidekiq}
+  spec.homepage      = "https://raygun.com/platform/apm"
+  #spec.license       = "MIT"
+
+  spec.files         = Dir['README.rdoc', 'raygun-apm-sidekiq.gemspec', 'lib/**/*', 'bin/**/*']
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "raygun-apm", "~> 1.0.44"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: alexb-raygun-apm-sidekiq
+version: !ruby/object:Gem::Version
+  version: 1.0.21
+platform: ruby
+authors:
+- Raygun
+- Erkki Eilonen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: raygun-apm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.44
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.44
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- support@raygun.com
+- info@bearmetal.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.rdoc
+- bin/console
+- bin/setup
+- lib/raygun/apm/sidekiq.rb
+- lib/raygun/apm/sidekiq/hook.rb
+- lib/raygun/apm/sidekiq/railtie.rb
+- lib/raygun/apm/sidekiq/version.rb
+- raygun-apm-sidekiq.gemspec
+homepage: https://raygun.com/platform/apm
+licenses: []
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Raygun application performance monitoring for Sidekiq
+test_files: []