Rework logger init to work with enabled_logs config

Author: solnic

sentry-ruby/lib/sentry-ruby.rb

@@ -95,27 +95,6 @@ def exception_locals_tp
     #   @return [Metrics::Aggregator, nil]
     attr_reader :metrics_aggregator
 
-    # @!attribute [r] logger
-    #   Returns the structured logger instance that implements Sentry's SDK telemetry logs protocol.
-    #   This logger is only available when logs are enabled in the configuration.
-    #
-    #   @example Enable logs in configuration
-    #     Sentry.init do |config|
-    #       config.dsn = "YOUR_DSN"
-    #       config.enable_logs = true
-    #     end
-    #
-    #   @example Basic usage
-    #     Sentry.logger.info("User logged in successfully", user_id: 123)
-    #     Sentry.logger.error("Failed to process payment",
-    #       transaction_id: "tx_123",
-    #       error_code: "PAYMENT_FAILED"
-    #     )
-    #
-    #   @see https://develop.sentry.dev/sdk/telemetry/logs/ Sentry SDK Telemetry Logs Protocol
-    #   @return [StructuredLogger, nil] The structured logger instance or nil if logs are disabled
-    attr_reader :logger
-
     ##### Patch Registration #####
 
     # @!visibility private
@@ -261,11 +240,6 @@ def init(&block)
       config = Configuration.new
       yield(config) if block_given?
 
-      # Initialize the public-facing Structured Logger if logs are enabled
-      # This creates a StructuredLogger instance that implements Sentry's SDK telemetry logs protocol
-      # @see https://develop.sentry.dev/sdk/telemetry/logs/
-      @logger = StructuredLogger.new(config) if config.enable_logs
-
       config.detect_release
       apply_patches(config)
       config.validate
@@ -640,18 +614,45 @@ def continue_trace(env, **options)
       get_current_hub.continue_trace(env, **options)
     end
 
-    ##### Helpers #####
-
-    # @!visibility private
+    # Returns the structured logger instance that implements Sentry's SDK telemetry logs protocol.
+    #
+    # This logger is only available when logs are enabled in the configuration.
+    #
+    # @example Enable logs in configuration
+    #   Sentry.init do |config|
+    #     config.dsn = "YOUR_DSN"
+    #     config.enable_logs = true
+    #   end
+    #
+    # @example Basic usage
+    #   Sentry.logger.info("User logged in successfully", user_id: 123)
+    #   Sentry.logger.error("Failed to process payment",
+    #     transaction_id: "tx_123",
+    #     error_code: "PAYMENT_FAILED"
+    #   )
+    #
+    # @see https://develop.sentry.dev/sdk/telemetry/logs/ Sentry SDK Telemetry Logs Protocol
+    #
+    # @return [StructuredLogger, nil] The structured logger instance or nil if logs are disabled
     def logger
-      warn <<~STR
-        [sentry] `Sentry.logger` will no longer be used as internal SDK logger when `enable_logs` feature is turned on.
-                 Use Sentry.configuration.sdk_logger for SDK-specific logging needs."
-      STR
-
-      configuration.sdk_logger
+      @logger ||=
+        if configuration.enable_logs
+          # Initialize the public-facing Structured Logger if logs are enabled
+          # This creates a StructuredLogger instance that implements Sentry's SDK telemetry logs protocol
+          # @see https://develop.sentry.dev/sdk/telemetry/logs/
+          StructuredLogger.new(configuration)
+        else
+          warn <<~STR
+            [sentry] `Sentry.logger` will no longer be used as internal SDK logger when `enable_logs` feature is turned on.
+                    Use Sentry.configuration.sdk_logger for SDK-specific logging needs."
+          STR
+
+          configuration.sdk_logger
+        end
     end
 
+    ##### Helpers #####
+
     # @!visibility private
     def sys_command(command)
       result = `#{command} 2>&1` rescue nil

sentry-ruby/lib/sentry/configuration.rb

@@ -468,7 +468,7 @@ def initialize
       self.rack_env_whitelist = RACK_ENV_WHITELIST_DEFAULT
       self.traces_sampler = nil
       self.enable_tracing = nil
-      self.enable_logs = true
+      self.enable_logs = false
 
       self.profiler_class = Sentry::Profiler
 

sentry-ruby/spec/sentry/structured_logger_spec.rb

@@ -3,13 +3,15 @@
 require "spec_helper"
 
 RSpec.describe Sentry::StructuredLogger do
-  context "when log events are not enabled" do
+  context "when enable_logs is set to false" do
     before do
-      perform_basic_setup
+      perform_basic_setup do |config|
+        config.enable_logs = false
+      end
     end
 
-    it "logger is not set up" do
-      expect(Sentry.logger).to be_nil
+    it "configures default SDK logger" do
+      expect(Sentry.logger).to be(Sentry.configuration.sdk_logger)
     end
   end