Rename logger => sdk_logger

Author: solnic

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/sentry/rails_spec.rb

@@ -44,22 +44,22 @@
     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
 
@@ -70,15 +70,15 @@
           config.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
 

sentry-ruby/lib/sentry-ruby.rb

@@ -94,6 +94,11 @@ def exception_locals_tp
     #   @return [Metrics::Aggregator, nil]
     attr_reader :metrics_aggregator
 
+    # @!attribute [r] logger
+    #   @return [Logger]
+    # @!visibility private
+    attr_reader :sdk_logger
+
     ##### Patch Registration #####
 
     # @!visibility private
@@ -138,7 +143,7 @@ def integrations
     # @param version [String] version of the integration
     def register_integration(name, version)
       if initialized?
-        logger.warn(LOGGER_PROGNAME) do
+        sdk_logger.warn(LOGGER_PROGNAME) do
           <<~MSG
             Integration '#{name}' is loaded after the SDK is initialized, which can cause unexpected behavior.  Please make sure all integrations are loaded before SDK initialization.
           MSG
@@ -238,6 +243,10 @@ def add_attachment(**opts)
     def init(&block)
       config = Configuration.new
       yield(config) if block_given?
+
+      # Internal SDK logger
+      @sdk_logger = config.sdk_logger
+
       config.detect_release
       apply_patches(config)
       config.validate
@@ -615,11 +624,6 @@ def sys_command(command)
       result.strip
     end
 
-    # @!visibility private
-    def logger
-      configuration.logger
-    end
-
     # @!visibility private
     def sdk_meta
       META

sentry-ruby/lib/sentry/background_worker.rb

@@ -9,7 +9,7 @@ class BackgroundWorker
     include LoggingHelper
 
     attr_reader :max_queue, :number_of_threads
-    # @deprecated Use Sentry.logger to retrieve the current logger instead.
+    # @deprecated Use Sentry.sdk_logger to retrieve the current logger instead.
     attr_reader :logger
     attr_accessor :shutdown_timeout
 
@@ -19,7 +19,7 @@ def initialize(configuration)
       @shutdown_timeout = 1
       @number_of_threads = configuration.background_worker_threads
       @max_queue = configuration.background_worker_max_queue
-      @logger = configuration.logger
+      @logger = configuration.sdk_logger
       @debug = configuration.debug
       @shutdown_callback = nil
 

sentry-ruby/lib/sentry/backpressure_monitor.rb

@@ -6,7 +6,7 @@ class BackpressureMonitor < ThreadedPeriodicWorker
     MAX_DOWNSAMPLE_FACTOR = 10
 
     def initialize(configuration, client, interval: DEFAULT_INTERVAL)
-      super(configuration.logger, interval)
+      super(configuration.sdk_logger, interval)
       @client = client
 
       @healthy = true

sentry-ruby/lib/sentry/breadcrumb.rb

@@ -63,7 +63,7 @@ def serialized_data
       begin
         ::JSON.parse(::JSON.generate(@data, max_nesting: MAX_NESTING))
       rescue Exception => e
-        Sentry.logger.debug(LOGGER_PROGNAME) do
+        Sentry.sdk_logger.debug(LOGGER_PROGNAME) do
           <<~MSG
 can't serialize breadcrumb data because of error: #{e}
 data: #{@data}

sentry-ruby/lib/sentry/client.rb

@@ -19,13 +19,12 @@ class Client
     # @!macro configuration
     attr_reader :configuration
 
-    # @deprecated Use Sentry.logger to retrieve the current logger instead.
-    attr_reader :logger
+    attr_reader :log_event_buffer
 
     # @param configuration [Configuration]
     def initialize(configuration)
       @configuration = configuration
-      @logger = configuration.logger
+      @logger = configuration.sdk_logger
 
       if transport_class = configuration.transport.transport_class
         @transport = transport_class.new(configuration)

sentry-ruby/lib/sentry/configuration.rb

@@ -184,7 +184,9 @@ def capture_exception_frame_locals=(value)
     # Logger used by Sentry. In Rails, this is the Rails logger, otherwise
     # Sentry provides its own Sentry::Logger.
     # @return [Logger]
-    attr_accessor :logger
+    attr_accessor :sdk_logger
+    alias_method :logger, :sdk_logger
+    alias_method :logger=, :sdk_logger=
 
     # Project directory root for in_app detection. Could be Rails root, etc.
     # Set automatically for Rails.
@@ -312,6 +314,10 @@ def capture_exception_frame_locals=(value)
     # @return [Integer]
     attr_accessor :max_log_events
 
+    # Experimental features configuration
+    # @return [Hash]
+    attr_accessor :_experiments
+
     # these are not config options
     # @!visibility private
     attr_reader :errors, :gem_specs
@@ -424,7 +430,7 @@ def initialize
       self.excluded_exceptions = IGNORE_DEFAULT + PUMA_IGNORE_DEFAULT
       self.inspect_exception_causes_for_exclusion = true
       self.linecache = ::Sentry::LineCache.new
-      self.logger = ::Sentry::Logger.new(STDOUT)
+      self.sdk_logger = ::Sentry::Logger.new(STDOUT)
       self.project_root = Dir.pwd
       self.propagate_traces = true
 
@@ -458,6 +464,7 @@ def initialize
       @cron = Cron::Configuration.new
       @metrics = Metrics::Configuration.new
       @gem_specs = Hash[Gem::Specification.map { |spec| [spec.name, spec.version.to_s] }] if Gem::Specification.respond_to?(:map)
+      @_experiments = { enable_logs: false }
 
       run_post_initialization_callbacks
 

sentry-ruby/lib/sentry/interfaces/request.rb

@@ -99,7 +99,7 @@ def filter_and_format_headers(env, send_default_pii)
           # Rails adds objects to the Rack env that can sometimes raise exceptions
           # when `to_s` is called.
           # See: https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/middleware/remote_ip.rb#L134
-          Sentry.logger.warn(LOGGER_PROGNAME) { "Error raised while formatting headers: #{e.message}" }
+          Sentry.sdk_logger.warn(LOGGER_PROGNAME) { "Error raised while formatting headers: #{e.message}" }
           next
         end
       end