raygun-apm-sidekiq 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 077f9679377d70bdf9e2eafe8a65d7c1b6bb09225ed69766f3858e21b0cb8fe7
+  data.tar.gz: 1e9aaa717e0a2889d776b53a0bea31e9eb3bed9901b73a8d07cdf1f8476fcc15
+SHA512:
+  metadata.gz: 306d5d3c458e67a32727d2f09b435519ff0d9a6437750eeae249ee8abe78df7c5d95d794ac81a5e7330532d60f7ded7524ad7ee954d890fc6760480241f9ce23
+  data.tar.gz: 16aaca40a45458cb87f627b1b827c54b1ce4498671b1fde588c387f0f969f029b3008f77e8365cf6129f66b354f840863e1721367b00e52d8cb43a17faf0c4cb

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

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

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/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require 'rdoc/task'
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_files.include("README.rdoc", "lib/raygun/apm/*.rb", "lib/raygun/apm/sidekiq/*.rb")
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

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
+          Redis
+          +Raygun::Apm::Sidekiq::Middleware::start_of_trace
+        }
+    end
+  end
+end
+
+if defined?(::Rails) && !ENV['RAYGUN_SKIP_MIDDLEWARE']
+  require "raygun/apm/sidekiq/railtie"
+end

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

@@ -0,0 +1,125 @@
+module Raygun
+    module Apm
+      module Sidekiq
+        class Middleware
+          def initialize
+            @tracer = Raygun::Apm::Tracer.new
+            @tracer.udp_sink!
+            @tracer.process_started
+            ObjectSpace.define_finalizer(self, self.class.finalize(@tracer))
+  
+            @sql_subscriber = ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
+              sql_handler(args)
+            end
+  
+            # If any fatal errors on init, shutdown the tracer
+          rescue Raygun::Apm::FatalError => e
+            raygun_shutdown_handler(e)
+          end
+  
+          def call(worker_instance, msg, queue)
+            # Can be nil if we had a fatal error
+            if @tracer
+              started = @tracer.now
+              Thread.current.thread_variable_set(:_raygun_apm_tracer, @tracer)
+              @tracer.start_trace
+            end
+            errored = false
+            start_of_trace do
+              yield
+            rescue
+              errored = true
+            end
+            # Can be nil if we had a fatal error
+            if @tracer
+              fake_http_in_handler(started, worker_instance, msg, queue, errored)
+              @tracer.end_trace
+            end
+          rescue Raygun::Apm::FatalError => e
+            raygun_shutdown_handler(e)
+          end
+  
+          def 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"
+            # Shutdown the tracepoint if enabled to reduce any overhead and stall emission
+            if @tracer.tracepoint.enabled?
+              @tracer.tracepoint.stop
+              warn "[Raygun APM] tracepoint stopped"
+            end
+            # Let the GC clean up the sink thread through the finalizer below
+            @tracer = nil
+            Thread.current.thread_variable_set(:_raygun_apm_tracer, nil)
+          end
+  
+          def fake_http_in_handler(started, worker_instance, msg, queue, errored)
+            ended = @tracer.now
+            event = http_in_event
+            event[:url] = "sidekiq://#{queue}/#{msg["class"]}?#{msg["jid"]}"
+            event[:status] = errored ? 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"
+            raygun_shutdown_handler(e)
+          end
+
+          def http_in_event
+            @http_in_event ||= begin
+              event = Raygun::Apm::Event::HttpIn.new
+              event[:pid] = Process.pid
+              event[:verb] = "POST"
+              event
+            end
+          end
+
+          def sql_handler(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 sql_event
+            @sql_event ||= begin
+              event = Raygun::Apm::Event::Sql.new
+              event[:pid] = Process.pid
+              event
+            end
+          end
+
+          def start_of_trace
+            yield
+          end
+
+          def self.finalize(tracer)
+            proc {tracer.process_ended}
+          end
+        end
+      end
+    end
+  end

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

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

data/raygun-apm-sidekiq.gemspec

@@ -0,0 +1,30 @@
+
+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          = "raygun-apm-sidekiq"
+  spec.version       = Raygun::Apm::Sidekiq::VERSION
+  spec.authors       = ["Erkki Eilonen"]
+  spec.email         = ["erkki@bearmetal.eu"]
+
+  spec.summary       = %q{Raygun application performance monitoring for Sidekiq}
+  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  #spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  #spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  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.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: raygun-apm-sidekiq
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Erkki Eilonen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-18 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !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:
+- erkki@bearmetal.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- bin/console
+- bin/setup
+- lib/raygun/apm/sidekiq.rb
+- lib/raygun/apm/sidekiq/middleware.rb
+- lib/raygun/apm/sidekiq/railtie.rb
+- lib/raygun/apm/sidekiq/version.rb
+- raygun-apm-sidekiq.gemspec
+homepage: 
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Raygun application performance monitoring for Sidekiq
+test_files: []