sentry-sidekiq 4.1.2 → 4.4.0.pre.beta.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4370fdcec568ea785e549d24e250575ad8bb93b7a46bd27e777e9c6776407a57
-  data.tar.gz: 99a527bf321e1645843a159f9706ea8215976485833b8c20dcb243b56bce6016
+  metadata.gz: 348d53b89424320f50c7c210ef6aecfd855c44dbd2b1a484c21ae26a129b70fb
+  data.tar.gz: b74912cbe7930b8abbc3e97c317b1b6da3414e6f6360b9256e10dd3daec1aecb
 SHA512:
-  metadata.gz: 6fdd057e634833b1ee467af9800ba759d2bca7a88ae9a1a8f84d844c8afa99b6aeb5d241b3f267275b5e42176c56943286a2b89407f5b7cc135fac520d04e833
-  data.tar.gz: 53ca304f50dc403af8a7f5d7011c2d1d6850ce111859796bac193736b8c6a5778428822db519eae7c0e412290a56b709e09fd59031093613b089b96379f9d38c
+  metadata.gz: 16bbc9522af7aed6b6f1f78764a62923b4153623930a012efd5432708ab42e00e1bb0b3bd6a835ebcca00dcf428fca7c0f69b9dffc64c0d01a6f28640622f3a2
+  data.tar.gz: 6799170ef2967c6ed7a2d1c4ada6d438f9d7858cea8e96fe0ebf01ce5307a8970c0a213c83a909da229a01817be25c0ccade5876b07b9a8560d87f29df7ed038

data/.craft.yml

@@ -11,9 +11,10 @@ artifactProvider:
   name: github
 targets:
     - name: gem
-    - name: github
-      tagPrefix: sentry-sidekiq-v
     - name: registry
       type: sdk
       config:
           canonical: 'gem:sentry-sidekiq'
+    - name: github
+      tagPrefix: sentry-sidekiq-v
+      changelog: sentry-sidekiq/CHANGELOG.md

data/.rspec

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

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 # Changelog
 
+## 4.4.0-beta.0
+
+### Features
+
+- Make Sidekiq job context more readable [#1410](https://github.com/getsentry/sentry-ruby/pull/1410) 
+
+**Before**
+
+<img width="60%" alt="Sidekiq payload in extra" src="https://user-images.githubusercontent.com/5079556/115679342-0ed8d000-a385-11eb-8e1c-372cb1af572e.png">
+
+**After**
+
+<img width="60%" alt="Sidekiq payload in context" src="https://user-images.githubusercontent.com/5079556/115679353-126c5700-a385-11eb-867c-a9a25d1a7099.png">
+
+## 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)

data/Gemfile

@@ -3,13 +3,16 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in sentry-ruby.gemspec
 gemspec
 
+gem "i18n", "~> 1.8.9"
+
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
 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/example/error_worker.rb

@@ -10,6 +10,8 @@ end
 class ErrorWorker
   include Sidekiq::Worker
 
+  sidekiq_options retry: 0
+
   def perform
     1 / 0
   end

data/lib/sentry-sidekiq.rb

@@ -4,13 +4,22 @@ require "sentry/integrable"
 require "sentry/sidekiq/version"
 require "sentry/sidekiq/error_handler"
 require "sentry/sidekiq/sentry_context_middleware"
-# require "sentry/sidekiq/configuration"
 
 module Sentry
   module Sidekiq
     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?
+
+          Sentry.configuration.rails.skippable_job_adapters << "ActiveJob::QueueAdapters::SidekiqAdapter"
+        end
+      end
+    end
   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,49 @@ 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
+        filtered_context = filter_context(context)
+
+        if job_entry = filtered_context.delete(:job)
+          job_entry.each do |k, v|
+            filtered_context[k] = v
+          end
+        end
+
+        filtered_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,20 @@ 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)
+
+        context_filter = Sentry::Sidekiq::ContextFilter.new(context)
+
         scope = Sentry.get_current_scope
-        scope.set_transaction_name(transaction_from_context(context)) unless scope.transaction_name
+        scope.set_transaction_name(context_filter.transaction_name) unless scope.transaction_name
 
         Sentry::Sidekiq.capture_exception(
           ex,
-          extra: { sidekiq: context },
+          contexts: { sidekiq: context_filter.filtered },
           hint: { background: false }
         )
       end
-
-      private
-
-      # 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
-      end
     end
   end
 end

data/lib/sentry/sidekiq/sentry_context_middleware.rb

@@ -1,20 +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_extras(sidekiq: job.merge("queue" => queue))
-        scope.set_transaction_name("Sidekiq/#{job["class"]}")
+        scope.set_tags(queue: queue, jid: job["jid"])
+        scope.set_contexts(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
 
-        yield
+        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.2"
+    VERSION = "4.4.0-beta.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.2"
+  spec.add_dependency "sentry-ruby-core", "~> 4.4.0.pre.beta"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sentry-sidekiq
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.4.0.pre.beta.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2021-04-27 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.2
+        version: 4.4.0.pre.beta
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: 4.4.0.pre.beta
 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,7 +49,6 @@ 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
@@ -61,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:
@@ -73,11 +72,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: A gem that provides Sidekiq integration for the Sentry error logger

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::Sidekiq.capture_exception(ex, hint: { background: false })
-          end
-        end
-      end
-    end
-  end
-end