Replace logger with sdk_logger (#2621)

* Rename logger => sdk_logger

* Update CHANGELOG

* Remove reader that we don't need here

* Remove another reader that we don't need here

* Rename logger->sdk_logger in LoggingHelper too

* Deprecate config.{logger,logger=}

* Re-add Sentry.logger but with a deprecation warning

* Update CHANGELOG

* Remove _experiments namespace from config

We won't use it after all

* Fix Configuration#logger

Author: solnic

CHANGELOG.md

@@ -29,6 +29,9 @@
 ### Internal
 
 - Remove `user_segment` from DSC ([#2586](https://github.com/getsentry/sentry-ruby/pull/2586))
+- New configuration option called `report_after_job_retries` for ActiveJob which makes reporting exceptions only happen when the last retry attempt failed ([#2500](https://github.com/getsentry/sentry-ruby/pull/2500))
+- Replace `logger` with `sdk_logger` ([#2621](https://github.com/getsentry/sentry-ruby/pull/2621))
+- `Sentry.logger` is now deprecated when `enable_logs` is turned off. It's original behavior was ported to `Sentry.configuration.sdk_logger`. Please notice that this logger *is internal* and should only be used for SDK-specific logging needs. ([#2621](https://github.com/getsentry/sentry-ruby/pull/2621))
 
 ## 5.23.0
 

sentry-delayed_job/spec/spec_helper.rb

@@ -87,7 +87,7 @@ def build_exception
 def perform_basic_setup
   Sentry.init do |config|
     config.dsn = DUMMY_DSN
-    config.logger = ::Logger.new(nil)
+    config.sdk_logger = ::Logger.new(nil)
     config.background_worker_threads = 0
     config.transport.transport_class = Sentry::DummyTransport
     yield(config) if block_given?

sentry-opentelemetry/spec/spec_helper.rb

@@ -44,7 +44,7 @@
 
 def perform_basic_setup
   Sentry.init do |config|
-    config.logger = Logger.new(nil)
+    config.sdk_logger = Logger.new(nil)
     config.dsn = Sentry::TestHelper::DUMMY_DSN
     config.transport.transport_class = Sentry::DummyTransport
     # so the events will be sent synchronously for testing

sentry-rails/lib/sentry/rails/configuration.rb

@@ -17,12 +17,12 @@ class Configuration
       if ::Rails.logger
         if defined?(::ActiveSupport::BroadcastLogger) && ::Rails.logger.is_a?(::ActiveSupport::BroadcastLogger)
           dupped_broadcasts = ::Rails.logger.broadcasts.map(&:dup)
-          @logger = ::ActiveSupport::BroadcastLogger.new(*dupped_broadcasts)
+          self.sdk_logger = ::ActiveSupport::BroadcastLogger.new(*dupped_broadcasts)
         else
-          @logger = ::Rails.logger.dup
+          self.sdk_logger = ::Rails.logger.dup
         end
       else
-        @logger.warn(Sentry::LOGGER_PROGNAME) do
+        sdk_logger.warn(Sentry::LOGGER_PROGNAME) do
           <<~MSG
           sentry-rails can't detect Rails.logger. it may be caused by misplacement of the SDK initialization code
           please make sure you place the Sentry.init block under the `config/initializers` folder, e.g. `config/initializers/sentry.rb`

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

@@ -14,7 +14,7 @@ class ActionControllerSubscriber < AbstractSubscriber
         SPAN_ORIGIN = "auto.view.rails"
 
         def self.subscribe!
-          Sentry.logger.warn <<~MSG
+          Sentry.sdk_logger.warn <<~MSG
             DEPRECATION WARNING: sentry-rails has changed its approach on controller span recording and #{self.name} is now depreacted.
             Please stop using or referencing #{self.name} as it will be removed in the next major release.
           MSG

sentry-rails/spec/dummy/test_rails_app/app.rb

@@ -55,7 +55,7 @@ def self.name
   app.config.action_controller.view_paths = "spec/dummy/test_rails_app"
   app.config.hosts = nil
   app.config.secret_key_base = "test"
-  app.config.logger = ActiveSupport::Logger.new(nil)
+  app.config.sdk_logger = ActiveSupport::Logger.new(nil)
   app.config.eager_load = false
   app.config.active_job.queue_adapter = :test
   app.config.cache_store = :memory_store

sentry-rails/spec/isolated/active_job_activation.rb

@@ -53,7 +53,7 @@ def perform
 app.config.eager_load = true
 app.initializer :sentry do
   Sentry.init do |config|
-    config.logger = Logger.new(nil)
+    config.sdk_logger = Logger.new(nil)
     config.dsn = 'https://[email protected]/5434472'
     config.background_worker_threads = 0
   end

sentry-rails/spec/sentry/rails/tracing/action_controller_subscriber_spec.rb

@@ -17,7 +17,7 @@
       make_basic_app do |config|
         config.traces_sample_rate = 1.0
         config.rails.tracing_subscribers = [described_class]
-        config.logger = logger
+        config.sdk_logger = logger
       end
     end
 

sentry-rails/spec/sentry/rails/tracing_spec.rb

@@ -182,7 +182,7 @@
         make_basic_app do |config, app|
           app.config.public_file_server.enabled = true
           config.traces_sample_rate = 1.0
-          config.logger = logger
+          config.sdk_logger = logger
         end
       end
 
@@ -202,7 +202,7 @@
         make_basic_app do |config, app|
           app.config.public_file_server.enabled = true
           config.traces_sample_rate = 1.0
-          config.logger = logger
+          config.sdk_logger = logger
           config.rails.assets_regexp = %r{/foo/}
         end
       end
@@ -232,7 +232,7 @@
       make_basic_app do |config, app|
         app.config.public_file_server.enabled = true
         config.traces_sample_rate = 1.0
-        config.logger = logger
+        config.sdk_logger = logger
       end
     end
 

sentry-rails/spec/sentry/rails_spec.rb

@@ -44,41 +44,41 @@
     describe "logger detection" do
       it "sets a duplicated Rails logger as the SDK's logger" do
         if Gem::Version.new(Rails.version) > Gem::Version.new("7.1.0.beta")
-          expect(Sentry.configuration.logger).to be_a(ActiveSupport::BroadcastLogger)
+          expect(Sentry.configuration.sdk_logger).to be_a(ActiveSupport::BroadcastLogger)
 
-          Sentry.configuration.logger.level = ::Logger::WARN
+          Sentry.configuration.sdk_logger.level = ::Logger::WARN
 
           # Configuring the SDK's logger should not affect the Rails logger
           expect(Rails.logger.broadcasts.first).to be_a(ActiveSupport::Logger)
           expect(Rails.logger.broadcasts.first.level).to eq(::Logger::DEBUG)
-          expect(Sentry.configuration.logger.level).to eq(::Logger::WARN)
+          expect(Sentry.configuration.sdk_logger.level).to eq(::Logger::WARN)
         else
-          expect(Sentry.configuration.logger).to be_a(ActiveSupport::Logger)
+          expect(Sentry.configuration.sdk_logger).to be_a(ActiveSupport::Logger)
 
-          Sentry.configuration.logger.level = ::Logger::WARN
+          Sentry.configuration.sdk_logger.level = ::Logger::WARN
 
           # Configuring the SDK's logger should not affect the Rails logger
           expect(Rails.logger.level).to eq(::Logger::DEBUG)
-          expect(Sentry.configuration.logger.level).to eq(::Logger::WARN)
+          expect(Sentry.configuration.sdk_logger.level).to eq(::Logger::WARN)
         end
       end
 
       it "respects the logger set by user" do
         logger = ::Logger.new(nil)
 
         make_basic_app do |config|
-          config.logger = logger
+          config.sdk_logger = logger
         end
 
-        expect(Sentry.configuration.logger).to eq(logger)
+        expect(Sentry.configuration.sdk_logger).to eq(logger)
       end
 
       it "doesn't cause error if Rails::Logger is not present during SDK initialization" do
         Rails.logger = nil
 
         Sentry.init
 
-        expect(Sentry.configuration.logger).to be_a(Sentry::Logger)
+        expect(Sentry.configuration.sdk_logger).to be_a(Sentry::Logger)
       end
     end