sentry-sidekiq 4.1.1 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2381c7e962b8461b17f09da04d9a729960f62d6be46e12149fd732dc8e41d23
-  data.tar.gz: acf0beaefce9d7a176a7446b25b6010eac1c6d55af2a69a9040b4ab40a00240c
+  metadata.gz: 58a2fdb9ebaf4e197fba06d2cae41179a91de332d5a6e4e65d27fa9173aa7a62
+  data.tar.gz: f13820fdaa0c2bc33e03a9301de7dd3f183ea199746842e626bbf9de4d948718
 SHA512:
-  metadata.gz: b5c0b869fda22432123e2317943085a2636c8b911a140f98b3b2cb1435f09271861d63320b6426ba8bc36f8d9cd5e5d68beb63a76d2ee1f8719f72f7517aa96c
-  data.tar.gz: f142b51cb00cfc48c36d0d0612caba41bb7e0f02720e491843b0bfecc46f1438afdd5121c461b3bd681956913a7887e17116b8a0797c48e34c712e7070375e5f
+  metadata.gz: 502d5c38a8652c16e099022d19eaaa6bd312e742996bd6039a34c30953b1b498938b9927a15d42a07f11478595566dd39f96b09bf06fc39c68bfa8271caade28
+  data.tar.gz: f72b90e8bb33e1edb00a805e1628057012756da73697c6148331e5668b16772b6000d45f35057ade6b4fcd9f759c10f619278da8f06c9463eee7ebe30911a0ee

data/.rspec

@@ -1,3 +1,2 @@
 --format documentation
 --color
---require spec_helper

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## 4.3.0
+
+### Features
+
+- Support performance monitoring on Sidekiq workers [#1311](https://github.com/getsentry/sentry-ruby/pull/1311)
+
+## 4.2.1
+
+- Use ::Rails::Railtie for checking Rails definition [#1284](https://github.com/getsentry/sentry-ruby/pull/1284)
+  - Fixes [#1276](https://github.com/getsentry/sentry-ruby/issues/1276)
+
+## 4.2.0
+
+### Features
+
+- Tag queue name and jid on sidekiq events [#1258](https://github.com/getsentry/sentry-ruby/pull/1258)
+<img width="1234" alt="sidekiq event tagged with queue name and jid" src="https://user-images.githubusercontent.com/5079556/106389900-d0381700-6420-11eb-90b9-a95b0881b696.png">
+
+### Refactorings
+
+- Add sidekiq adapter to sentry-rails' ignored adapters list [#1257](https://github.com/getsentry/sentry-ruby/pull/1257)
+
+## 4.1.3
+
+- Use sentry-ruby-core as the main SDK dependency [#1245](https://github.com/getsentry/sentry-ruby/pull/1245)
+
+## 4.1.2
+
+- Fix sidekiq middleware [#1175](https://github.com/getsentry/sentry-ruby/pull/1175)
+  - Fixes [#1173](https://github.com/getsentry/sentry-ruby/issues/1173)
+- Adopt Integrable module [#1177](https://github.com/getsentry/sentry-ruby/pull/1177)
+
 ## 4.1.1
 
 - Use stricter dependency declaration [#1159](https://github.com/getsentry/sentry-ruby/pull/1159)

data/Gemfile

@@ -3,13 +3,17 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in sentry-ruby.gemspec
 gemspec
 
+# TODO: Remove this if https://github.com/jruby/jruby/issues/6547 is addressed
+gem "i18n", "<= 1.8.7"
+
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
-gem "codecov"
+gem "codecov", "0.2.12"
 
 gem "sidekiq"
-gem "activejob"
+gem "rails"
 
 gem "sentry-ruby", path: "../sentry-ruby"
+gem "sentry-rails", path: "../sentry-rails"
 
 gem "pry"

data/Makefile

@@ -0,0 +1,7 @@
+build:
+	bundle install
+	gem build sentry-sidekiq.gemspec
+
+test:
+	bundle exec rspec
+	WITH_SENTRY_RAILS=1 bundle exec rspec spec/sentry/rails_spec.rb

data/lib/sentry-sidekiq.rb

@@ -1,24 +1,32 @@
 require "sidekiq"
 require "sentry-ruby"
+require "sentry/integrable"
 require "sentry/sidekiq/version"
 require "sentry/sidekiq/error_handler"
-require "sentry/sidekiq/cleanup_middleware"
-# require "sentry/sidekiq/configuration"
+require "sentry/sidekiq/sentry_context_middleware"
 
 module Sentry
   module Sidekiq
-    META = { "name" => "sentry.ruby.sidekiq", "version" => Sentry::Sidekiq::VERSION }.freeze
-  end
+    extend Sentry::Integrable
+
+    register_integration name: "sidekiq", version: Sentry::Sidekiq::VERSION
+
+    if defined?(::Rails::Railtie)
+      class Railtie < ::Rails::Railtie
+        config.after_initialize do
+          next unless Sentry.initialized?
 
-  def self.sdk_meta
-    Sentry::Sidekiq::META
+          Sentry.configuration.rails.skippable_job_adapters << "ActiveJob::QueueAdapters::SidekiqAdapter"
+        end
+      end
+    end
   end
 end
 
 Sidekiq.configure_server do |config|
   config.error_handlers << Sentry::Sidekiq::ErrorHandler.new
   config.server_middleware do |chain|
-    chain.add Sentry::Sidekiq::CleanupMiddleware
+    chain.add Sentry::Sidekiq::SentryContextMiddleware
   end
 end
 

data/lib/sentry/sidekiq/context_filter.rb

@@ -2,8 +2,12 @@ module Sentry
   module Sidekiq
     class ContextFilter
       ACTIVEJOB_RESERVED_PREFIX_REGEX = /^_aj_/.freeze
+      SIDEKIQ_NAME = "Sidekiq".freeze
 
-      def initialize
+      attr_reader :context
+
+      def initialize(context)
+        @context = context
         @has_global_id = defined?(GlobalID)
       end
 
@@ -13,23 +17,41 @@ module Sentry
       # The problem is, if this job in turn gets queued back into ActiveJob with
       # these magic reserved keys, ActiveJob will throw up and error. We want to
       # capture these and mutate the keys so we can sanely report it.
-      def filter_context(context)
-        case context
+      def filtered
+        filter_context(context)
+      end
+
+      def transaction_name
+        class_name = (context["wrapped"] || context["class"] ||
+                      (context[:job] && (context[:job]["wrapped"] || context[:job]["class"]))
+                    )
+
+        if class_name
+          "#{SIDEKIQ_NAME}/#{class_name}"
+        elsif context[:event]
+          "#{SIDEKIQ_NAME}/#{context[:event]}"
+        else
+          SIDEKIQ_NAME
+        end
+      end
+
+      private
+
+      def filter_context(hash)
+        case hash
         when Array
-          context.map { |arg| filter_context(arg) }
+          hash.map { |arg| filter_context(arg) }
         when Hash
-          Hash[context.map { |key, value| filter_context_hash(key, value) }]
+          Hash[hash.map { |key, value| filter_context_hash(key, value) }]
         else
-          if has_global_id? && context.is_a?(GlobalID)
-            context.to_s
+          if has_global_id? && hash.is_a?(GlobalID)
+            hash.to_s
           else
-            context
+            hash
           end
         end
       end
 
-      private
-
       def filter_context_hash(key, value)
         key = key.to_s.sub(ACTIVEJOB_RESERVED_PREFIX_REGEX, "") if key.match(ACTIVEJOB_RESERVED_PREFIX_REGEX)
         [key, filter_context(value)]

data/lib/sentry/sidekiq/error_handler.rb

@@ -3,37 +3,19 @@ require 'sentry/sidekiq/context_filter'
 module Sentry
   module Sidekiq
     class ErrorHandler
-      SIDEKIQ_NAME = "Sidekiq".freeze
-
       def call(ex, context)
         return unless Sentry.initialized?
-        context = Sentry::Sidekiq::ContextFilter.new.filter_context(context)
 
-        Sentry.with_scope do |scope|
-          scope.set_transaction_name transaction_from_context(context)
-          Sentry.capture_exception(
-            ex,
-            extra: { sidekiq: context },
-            hint: { background: false }
-          )
-        end
-      end
+        context_filter = Sentry::Sidekiq::ContextFilter.new(context)
 
-      private
+        scope = Sentry.get_current_scope
+        scope.set_transaction_name(context_filter.transaction_name) unless scope.transaction_name
 
-      # this will change in the future:
-      # https://github.com/mperham/sidekiq/pull/3161
-      def transaction_from_context(context)
-        classname = (context["wrapped"] || context["class"] ||
-                      (context[:job] && (context[:job]["wrapped"] || context[:job]["class"]))
-                    )
-        if classname
-          "#{SIDEKIQ_NAME}/#{classname}"
-        elsif context[:event]
-          "#{SIDEKIQ_NAME}/#{context[:event]}"
-        else
-          SIDEKIQ_NAME
-        end
+        Sentry::Sidekiq.capture_exception(
+          ex,
+          extra: { sidekiq: context_filter.filtered },
+          hint: { background: false }
+        )
       end
     end
   end

data/lib/sentry/sidekiq/sentry_context_middleware.rb

@@ -0,0 +1,40 @@
+require 'sentry/sidekiq/context_filter'
+
+module Sentry
+  module Sidekiq
+    class SentryContextMiddleware
+      def call(_worker, job, queue)
+        return yield unless Sentry.initialized?
+
+        context_filter = Sentry::Sidekiq::ContextFilter.new(job)
+
+        Sentry.clone_hub_to_current_thread
+        scope = Sentry.get_current_scope
+        scope.set_tags(queue: queue, jid: job["jid"])
+        scope.set_extras(sidekiq: job.merge("queue" => queue))
+        scope.set_transaction_name(context_filter.transaction_name)
+        transaction = Sentry.start_transaction(name: scope.transaction_name, op: "sidekiq")
+        scope.set_span(transaction) if transaction
+
+        begin
+          yield
+        rescue => e
+          finish_transaction(transaction, 500)
+          raise
+        end
+
+        finish_transaction(transaction, 200)
+        # don't need to use ensure here
+        # if the job failed, we need to keep the scope for error handler. and the scope will be cleared there
+        scope.clear
+      end
+
+      def finish_transaction(transaction, status)
+        return unless transaction
+
+        transaction.set_http_status(status)
+        transaction.finish
+      end
+    end
+  end
+end

data/lib/sentry/sidekiq/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Sidekiq
-    VERSION = "4.1.1"
+    VERSION = "4.3.0"
   end
 end

data/sentry-sidekiq.gemspec

@@ -16,11 +16,11 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/sentry-sidekiq/CHANGELOG.md"
 
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "sentry-ruby", "~> 4.1.0"
+  spec.add_dependency "sentry-ruby-core", "~> 4.3.0"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sentry-sidekiq
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.3.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-21 00:00:00.000000000 Z
+date: 2021-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sentry-ruby
+  name: sentry-ruby-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.3.0
 description: A gem that provides Sidekiq integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -35,11 +35,11 @@ files:
 - ".craft.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
 - bin/console
@@ -49,9 +49,9 @@ files:
 - example/config/sidekiq.yml
 - example/error_worker.rb
 - lib/sentry-sidekiq.rb
-- lib/sentry/sidekiq/cleanup_middleware.rb
 - lib/sentry/sidekiq/context_filter.rb
 - lib/sentry/sidekiq/error_handler.rb
+- lib/sentry/sidekiq/sentry_context_middleware.rb
 - lib/sentry/sidekiq/version.rb
 - sentry-sidekiq.gemspec
 homepage: https://github.com/getsentry/sentry-ruby
@@ -60,7 +60,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/getsentry/sentry-ruby
   source_code_uri: https://github.com/getsentry/sentry-ruby
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/master/sentry-sidekiq/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.5
-before_install: gem install bundler -v 2.1.1

data/lib/sentry/sidekiq/cleanup_middleware.rb

@@ -1,21 +0,0 @@
-module Sentry
-  module Sidekiq
-    class CleanupMiddleware
-      def call(_worker, job, queue)
-        return yield unless Sentry.initialized?
-
-        Sentry.clone_hub_to_current_thread
-        Sentry.with_scope do |scope|
-          scope.set_extras(sidekiq: job.merge("queue" => queue))
-          scope.set_transaction_name("Sidekiq/#{job["class"]}")
-
-          begin
-            yield
-          rescue => ex
-            Sentry.capture_exception(ex, hint: { background: false })
-          end
-        end
-      end
-    end
-  end
-end