sentry-sidekiq 0.1.3 → 4.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6071f98aa7f9cc6a30bd6d295010742fa3aaeb74408ca643876a64d8b782c61
-  data.tar.gz: c96a082c6907f10f17f0343a8bd178973f5e81dd62aff35dae1126c102a26c73
+  metadata.gz: 4370fdcec568ea785e549d24e250575ad8bb93b7a46bd27e777e9c6776407a57
+  data.tar.gz: 99a527bf321e1645843a159f9706ea8215976485833b8c20dcb243b56bce6016
 SHA512:
-  metadata.gz: 619aca07c663eea832604390ad0a1afb9492b297d6660dc9bb3fcd39e1c214a0dce3a4f7bda7021f3f59b79a48e882634db847461f079cb92ee33f5b17af4d99
-  data.tar.gz: 874e3856fc69ca947cd597066833cbf324afa58f1fe0c18127a3a3b8758bcb849149b1cf22a9aea655dcbc77f6c417ecd722a91e74d458aa94a12d7b4f4e596c
+  metadata.gz: 6fdd057e634833b1ee467af9800ba759d2bca7a88ae9a1a8f84d844c8afa99b6aeb5d241b3f267275b5e42176c56943286a2b89407f5b7cc135fac520d04e833
+  data.tar.gz: 53ca304f50dc403af8a7f5d7011c2d1d6850ce111859796bac193736b8c6a5778428822db519eae7c0e412290a56b709e09fd59031093613b089b96379f9d38c

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 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)
+
+## 4.1.0
+
+- Check SDK initialization before running integrations [#1151](https://github.com/getsentry/sentry-ruby/pull/1151)
+  - Fixes [#1145](https://github.com/getsentry/sentry-ruby/pull/1145)
+
+## 4.0.0
+
+- Only documents update for the official release and no API/feature changes.
+
+## 0.2.0
+
+- Major API changes: [1123](https://github.com/getsentry/sentry-ruby/pull/1123)
+
 ## 0.1.3
 
 - Small fixes

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
-gem "codecov"
+gem "codecov", "0.2.12"
 
 gem "sidekiq"
 gem "activejob"

data/README.md

@@ -17,7 +17,7 @@
 [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=sentry-sidekiq&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=sentry-sidekiq&package-manager=bundler&version-scheme=semver)
 
 
-[Documentation](https://docs.sentry.io/clients/ruby/) | [Bug Tracker](https://github.com/getsentry/sentry-ruby/issues) | [Forum](https://forum.sentry.io/) | IRC: irc.freenode.net, #sentry
+[Documentation](https://docs.sentry.io/platforms/ruby/guides/sidekiq/) | [Bug Tracker](https://github.com/getsentry/sentry-ruby/issues) | [Forum](https://forum.sentry.io/) | IRC: irc.freenode.net, #sentry
 
 The official Ruby-language client and integration layer for the [Sentry](https://github.com/getsentry/sentry) error reporting API.
 
@@ -27,6 +27,7 @@ The official Ruby-language client and integration layer for the [Sentry](https:/
 ### Install
 
 ```ruby
+gem "sentry-ruby"
 gem "sentry-sidekiq"
 ```
 

data/lib/sentry-sidekiq.rb

@@ -1,24 +1,23 @@
 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/sentry_context_middleware"
 # require "sentry/sidekiq/configuration"
 
 module Sentry
   module Sidekiq
-    META = { "name" => "sentry.ruby.sidekiq", "version" => Sentry::Sidekiq::VERSION }.freeze
-  end
+    extend Sentry::Integrable
 
-  def self.sdk_meta
-    Sentry::Sidekiq::META
+    register_integration name: "sidekiq", version: Sentry::Sidekiq::VERSION
   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/cleanup_middleware.rb

@@ -2,6 +2,8 @@ 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))
@@ -10,7 +12,7 @@ module Sentry
           begin
             yield
           rescue => ex
-            Sentry.capture_exception(ex)
+            Sentry::Sidekiq.capture_exception(ex, hint: { background: false })
           end
         end
       end

data/lib/sentry/sidekiq/error_handler.rb

@@ -6,15 +6,16 @@ module Sentry
       SIDEKIQ_NAME = "Sidekiq".freeze
 
       def call(ex, context)
+        return unless Sentry.initialized?
         context = Sentry::Sidekiq::ContextFilter.new.filter_context(context)
+        scope = Sentry.get_current_scope
+        scope.set_transaction_name(transaction_from_context(context)) unless scope.transaction_name
 
-        Sentry.with_scope do |scope|
-          scope.set_transaction_name transaction_from_context(context)
-          Sentry.capture_exception(
-            ex,
-            extra: { sidekiq: context }
-          )
-        end
+        Sentry::Sidekiq.capture_exception(
+          ex,
+          extra: { sidekiq: context },
+          hint: { background: false }
+        )
       end
 
       private

data/lib/sentry/sidekiq/sentry_context_middleware.rb

@@ -0,0 +1,20 @@
+module Sentry
+  module Sidekiq
+    class SentryContextMiddleware
+      def call(_worker, job, queue)
+        return yield unless Sentry.initialized?
+
+        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"]}")
+
+        yield
+
+        # 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
+    end
+  end
+end

data/lib/sentry/sidekiq/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Sidekiq
-    VERSION = "0.1.3"
+    VERSION = "4.1.2"
   end
 end

data/sentry-sidekiq.gemspec

@@ -22,5 +22,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "sentry-ruby", ">= 0.2.0"
+  spec.add_dependency "sentry-ruby", "~> 4.1.2"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sentry-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 4.1.2
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-30 00:00:00.000000000 Z
+date: 2020-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sentry-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 4.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 4.1.2
 description: A gem that provides Sidekiq integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -52,6 +52,7 @@ files:
 - 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