feat: allow disabling of install messages

sdk/lib/opentelemetry/sdk.rb

@@ -74,6 +74,7 @@ def configure
 end
 
 require 'opentelemetry/sdk/configurator'
+require 'opentelemetry/sdk/forwarding_logger'
 require 'opentelemetry/sdk/internal'
 require 'opentelemetry/sdk/instrumentation_library'
 require 'opentelemetry/sdk/resources'

sdk/lib/opentelemetry/sdk/configurator.rb

@@ -15,7 +15,7 @@ class Configurator # rubocop:disable Metrics/ClassLength
 
       private_constant :USE_MODE_UNSPECIFIED, :USE_MODE_ONE, :USE_MODE_ALL
 
-      attr_writer :logger, :propagators, :error_handler, :id_generator
+      attr_writer :propagators, :error_handler, :id_generator
 
       def initialize
         @instrumentation_names = []
@@ -31,6 +31,15 @@ def logger
         @logger ||= OpenTelemetry.logger
       end
 
+      # Accepts a logger and wraps it in the {ForwardingLogger} which allows
+      # for controlling the severity level emitted by the OpenTelemetry.logger
+      # independently of the supplied logger.
+      #
+      # @param [Logger] new_logger The logger for OpenTelemetry to use
+      def logger=(new_logger)
+        @logger = ForwardingLogger.new(new_logger, level: ENV['OTEL_LOG_LEVEL'] || Logger::INFO)
+      end
+
       def error_handler
         @error_handler ||= OpenTelemetry.error_handler
       end

sdk/lib/opentelemetry/sdk/forwarding_logger.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module OpenTelemetry
+  module SDK
+    # The ForwardingLogger provides a wrapper to control the OpenTelemetry
+    # log level, while respecting the configured level of the supplied logger.
+    # If the OTEL_LOG_LEVEL is set to debug, and the supplied logger is configured
+    # with an ERROR log level, only OpenTelemetry logs at the ERROR level or higher
+    # will be emitted.
+    class ForwardingLogger
+      def initialize(logger, level:) # rubocop:disable Metrics/CyclomaticComplexity
+        @logger = logger
+
+        if level.is_a?(Integer)
+          @level = level
+        else
+          case level.to_s.downcase
+          when 'debug'
+            @level = Logger::DEBUG
+          when 'info'
+            @level = Logger::INFO
+          when 'warn'
+            @level = Logger::WARN
+          when 'error'
+            @level = Logger::ERROR
+          when 'fatal'
+            @level = Logger::FATAL
+          when 'unknown'
+            @level = Logger::UNKNOWN
+          else
+            raise ArgumentError, "invalid log level: #{level}"
+          end
+        end
+      end
+
+      def add(severity, message = nil, progname = nil)
+        return true if severity < @level
+
+        @logger.add(severity, message, progname)
+      end
+
+      def debug(progname = nil, &block)
+        add(Logger::DEBUG, nil, progname, &block)
+      end
+
+      def info(progname = nil, &block)
+        add(Logger::INFO, nil, progname, &block)
+      end
+
+      def warn(progname = nil, &block)
+        add(Logger::WARN, nil, progname, &block)
+      end
+
+      def error(progname = nil, &block)
+        add(Logger::ERROR, nil, progname, &block)
+      end
+
+      def fatal(progname = nil, &block)
+        add(Logger::FATAL, nil, progname, &block)
+      end
+
+      def unknown(progname = nil, &block)
+        add(Logger::UNKNOWN, nil, progname, &block)
+      end
+    end
+  end
+end

sdk/test/opentelemetry/sdk/configurator_test.rb

@@ -24,14 +24,41 @@
   end
 
   describe '#logger' do
+    # Reset the logger
+    after { OpenTelemetry.logger = Logger.new(File::NULL) }
+
     it 'returns a logger instance' do
       _(configurator.logger).must_be_instance_of(Logger)
     end
+
     it 'assigns the logger to OpenTelemetry.logger' do
-      custom_logger = Logger.new(File::NULL, level: 'ERROR')
+      custom_logger = Logger.new(File::NULL, level: 'INFO')
       _(OpenTelemetry.logger).wont_equal custom_logger
+
+      OpenTelemetry::SDK.configure { |c| c.logger = custom_logger }
+      _(OpenTelemetry.logger.instance_variable_get(:@logger)).must_equal custom_logger
+      _(OpenTelemetry.logger).must_be_instance_of(OpenTelemetry::SDK::ForwardingLogger)
+    end
+
+    it 'respects the supplied loggers severity level' do
+      log_stream = StringIO.new
+      custom_logger = Logger.new(log_stream, level: 'ERROR')
       OpenTelemetry::SDK.configure { |c| c.logger = custom_logger }
-      _(OpenTelemetry.logger).must_equal custom_logger
+
+      OpenTelemetry.logger.debug('The forwarding logger should forward this message')
+      _(log_stream.string).must_be_empty
+    end
+
+    it 'allows control of the otel log level' do
+      log_stream = StringIO.new
+      custom_logger = Logger.new(log_stream, level: 'DEBUG')
+
+      with_env('OTEL_LOG_LEVEL' => 'ERROR') do
+        OpenTelemetry::SDK.configure { |c| c.logger = custom_logger }
+      end
+
+      OpenTelemetry.logger.warn('The forwarding logger should not forward this message')
+      _(log_stream.string).must_be_empty
     end
   end