sentry-rails 4.6.5 → 4.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5717087ed6c8fd8d83680fc7950992b553bb3bdfdc9bf60622b334d3c757b7c
-  data.tar.gz: 687f5baaa514011efcadc412e246fcb12b13a9f467c5f518dc45498b6e1e2d7d
+  metadata.gz: cec5336b01a20ec1922a32d103bd4dcf1587e8bf53288bd58520ba76aaa181a3
+  data.tar.gz: e38495a0f02aa5d1293167cb8894671948d0eaf1d4c1eac987e7bb74a28f3b0d
 SHA512:
-  metadata.gz: c7b506fd42ec78b1e0a9dee799de829afc2fae6280753fe5e69d193905b6b12d43bdbfe7a5f2a69c185225e1a082093aaf5b80cd765674b6184e8cca164507c1
-  data.tar.gz: 6d77e33885b0779a6e9c0bfd5ca0a2973adb5e64146ff1fa8b1a3a4b123febeff98d000583bb8f49567dbf9ddd816a5cea31d157f9613ac20040b2dd73215b3d
+  metadata.gz: a2a44a181625827c72a1393c96c3f783a9b0eb8317d626baa44ebd1a91f099e0fc135fba8270f45dab649b3bf8e87a65b0f79aa865fb400e52c0e1ecba961f62
+  data.tar.gz: f6e5fd836f4b7e9cdaabd776b0f2b2918fcc422f0e170b75dce77b32f36f230e1046d02cd437aa59fb1017239a829032cb78daf0f1af20668786897555467ecc

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 st0012
+Copyright (c) 2020 Sentry
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/app/jobs/sentry/send_event_job.rb

@@ -22,11 +22,6 @@ if defined?(ActiveJob)
       end
 
       def perform(event, hint = {})
-        # users don't need the tracing result of this job
-        if transaction = Sentry.get_current_scope.span
-          transaction.instance_variable_set(:@sampled, false)
-        end
-
         Sentry.send_event(event, hint)
       end
     end

data/lib/sentry/rails/active_job.rb

@@ -21,7 +21,12 @@ module Sentry
 
       def capture_and_reraise_with_sentry(job, scope, block)
         scope.set_transaction_name(job.class.name)
-        transaction = Sentry.start_transaction(name: scope.transaction_name, op: "active_job")
+        transaction =
+          if job.is_a?(::Sentry::SendEventJob)
+            nil
+          else
+            Sentry.start_transaction(name: scope.transaction_name, op: "active_job")
+          end
 
         scope.set_span(transaction) if transaction
 

data/lib/sentry/rails/breadcrumb/monotonic_active_support_logger.rb

@@ -0,0 +1,44 @@
+require "sentry/rails/instrument_payload_cleanup_helper"
+
+module Sentry
+  module Rails
+    module Breadcrumb
+      module MonotonicActiveSupportLogger
+        class << self
+          include InstrumentPayloadCleanupHelper
+
+          def add(name, started, _finished, _unique_id, data)
+            # skip Rails' internal events
+            return if name.start_with?("!")
+
+            if data.is_a?(Hash)
+              # we should only mutate the copy of the data
+              data = data.dup
+              cleanup_data(data)
+            end
+
+            crumb = Sentry::Breadcrumb.new(
+              data: data,
+              category: name,
+              timestamp: started.to_i
+            )
+            Sentry.add_breadcrumb(crumb)
+          end
+
+          def inject
+            @subscriber = ::ActiveSupport::Notifications.monotonic_subscribe(/.*/) do |name, started, finished, unique_id, data|
+              # we only record events that has a float as started timestamp
+              if started.is_a?(Float)
+                add(name, started, finished, unique_id, data)
+              end
+            end
+          end
+
+          def detach
+            ::ActiveSupport::Notifications.unsubscribe(@subscriber)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sentry/rails/instrument_payload_cleanup_helper.rb

@@ -1,7 +1,7 @@
 module Sentry
   module Rails
     module InstrumentPayloadCleanupHelper
-      IGNORED_DATA_TYPES = [:request, :response, :headers, :exception, :exception_object]
+      IGNORED_DATA_TYPES = [:request, :response, :headers, :exception, :exception_object, Tracing::START_TIMESTAMP_NAME]
 
       def cleanup_data(data)
         IGNORED_DATA_TYPES.each do |key|

data/lib/sentry/rails/railtie.rb

@@ -8,8 +8,8 @@ module Sentry
     initializer "sentry.use_rack_middleware" do |app|
       # placed after all the file-sending middlewares so we can avoid unnecessary transactions
       app.config.middleware.insert_after ActionDispatch::Executor, Sentry::Rails::CaptureExceptions
-      # need to be placed at last to smuggle app exceptions via env
-      app.config.middleware.use(Sentry::Rails::RescuedExceptionInterceptor)
+      # need to place as close to DebugExceptions as possible to intercept most of the exceptions, including those raised by middlewares
+      app.config.middleware.insert_after ActionDispatch::DebugExceptions, Sentry::Rails::RescuedExceptionInterceptor
     end
 
     # because the extension works by registering the around_perform callcack, it should always be ran
@@ -69,6 +69,13 @@ module Sentry
         require 'sentry/rails/breadcrumb/active_support_logger'
         Sentry::Rails::Breadcrumb::ActiveSupportLogger.inject
       end
+
+      if Sentry.configuration.breadcrumbs_logger.include?(:monotonic_active_support_logger)
+        return warn "Usage of `monotonic_active_support_logger` require a version of Rails >= 6.1, please upgrade your Rails version or use another logger" if ::Rails.version.to_f < 6.1
+
+        require 'sentry/rails/breadcrumb/monotonic_active_support_logger'
+        Sentry::Rails::Breadcrumb::MonotonicActiveSupportLogger.inject
+      end
     end
 
     def setup_backtrace_cleanup_callback

data/lib/sentry/rails/tracing/action_controller_subscriber.rb

@@ -16,7 +16,7 @@ module Sentry
 
             record_on_current_span(
               op: event_name,
-              start_timestamp: payload[:start_timestamp],
+              start_timestamp: payload[START_TIMESTAMP_NAME],
               description: "#{controller}##{action}",
               duration: duration
             ) do |span|

data/lib/sentry/rails/tracing/action_view_subscriber.rb

@@ -8,7 +8,7 @@ module Sentry
 
         def self.subscribe!
           subscribe_to_event(EVENT_NAME) do |event_name, duration, payload|
-            record_on_current_span(op: event_name, start_timestamp: payload[:start_timestamp], description: payload[:identifier], duration: duration)
+            record_on_current_span(op: event_name, start_timestamp: payload[START_TIMESTAMP_NAME], description: payload[:identifier], duration: duration)
           end
         end
       end

data/lib/sentry/rails/tracing/active_record_subscriber.rb

@@ -11,7 +11,7 @@ module Sentry
           subscribe_to_event(EVENT_NAME) do |event_name, duration, payload|
             next if EXCLUDED_EVENTS.include? payload[:name]
 
-            record_on_current_span(op: event_name, start_timestamp: payload[:start_timestamp], description: payload[:sql], duration: duration) do |span|
+            record_on_current_span(op: event_name, start_timestamp: payload[START_TIMESTAMP_NAME], description: payload[:sql], duration: duration) do |span|
               span.set_data(:connection_id, payload[:connection_id])
             end
           end

data/lib/sentry/rails/tracing.rb

@@ -1,6 +1,8 @@
 module Sentry
   module Rails
     module Tracing
+      START_TIMESTAMP_NAME = :sentry_start_timestamp
+
       def self.register_subscribers(subscribers)
         @subscribers = subscribers
       end
@@ -9,11 +11,18 @@ module Sentry
         @subscribers
       end
 
+      def self.subscribed_tracing_events
+        @subscribed_tracing_events ||= []
+      end
+
       def self.subscribe_tracing_events
         # need to avoid duplicated subscription
         return if @subscribed
 
-        subscribers.each(&:subscribe!)
+        subscribers.each do |subscriber|
+          subscriber.subscribe!
+          subscribed_tracing_events << subscriber::EVENT_NAME
+        end
 
         @subscribed = true
       end
@@ -22,6 +31,7 @@ module Sentry
         return unless @subscribed
 
         subscribers.each(&:unsubscribe!)
+        subscribed_tracing_events.clear
 
         @subscribed = false
       end
@@ -35,9 +45,10 @@ module Sentry
 
         SentryNotificationExtension.module_eval do
           def instrument(name, payload = {}, &block)
-            is_public_event = name[0] != "!"
-
-            payload[:start_timestamp] = Time.now.utc.to_f if is_public_event
+            # only inject timestamp to the events the SDK subscribes to
+            if Tracing.subscribed_tracing_events.include?(name)
+              payload[START_TIMESTAMP_NAME] = Time.now.utc.to_f if name[0] != "!" && payload.is_a?(Hash)
+            end
 
             super(name, payload, &block)
           end

data/lib/sentry/rails/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Rails
-    VERSION = "4.6.5"
+    VERSION = "4.7.3"
   end
 end

data/lib/sentry/rails.rb

@@ -1,10 +1,10 @@
 require "rails"
 require "sentry-ruby"
 require "sentry/integrable"
+require "sentry/rails/tracing"
 require "sentry/rails/configuration"
 require "sentry/rails/engine"
 require "sentry/rails/railtie"
-require "sentry/rails/tracing"
 
 module Sentry
   module Rails

data/sentry-rails.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["Sentry Team"]
   spec.description = spec.summary = "A gem that provides Rails integration for the Sentry error logger"
   spec.email = "accounts@sentry.io"
-  spec.license = 'Apache-2.0'
+  spec.license = 'MIT'
   spec.homepage = "https://github.com/getsentry/sentry-ruby"
 
   spec.platform = Gem::Platform::RUBY
@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "railties", ">= 5.0"
-  spec.add_dependency "sentry-ruby-core", "~> 4.6.0"
+  spec.add_dependency "sentry-ruby-core", "~> 4.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 4.6.5
+  version: 4.7.3
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-12 00:00:00.000000000 Z
+date: 2021-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.6.0
+        version: 4.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.6.0
+        version: 4.7.0
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -64,6 +64,7 @@ files:
 - lib/sentry/rails/background_worker.rb
 - lib/sentry/rails/backtrace_cleaner.rb
 - lib/sentry/rails/breadcrumb/active_support_logger.rb
+- lib/sentry/rails/breadcrumb/monotonic_active_support_logger.rb
 - lib/sentry/rails/capture_exceptions.rb
 - lib/sentry/rails/configuration.rb
 - lib/sentry/rails/controller_methods.rb
@@ -82,7 +83,7 @@ files:
 - sentry-rails.gemspec
 homepage: https://github.com/getsentry/sentry-ruby
 licenses:
-- Apache-2.0
+- MIT
 metadata:
   homepage_uri: https://github.com/getsentry/sentry-ruby
   source_code_uri: https://github.com/getsentry/sentry-ruby