semantic_logger 4.17.0 → 4.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a10d5e24ca0c3542ec98c53268bd56f96c3432fd7b8de39c55d0f7938f5b6d44
-  data.tar.gz: 95bdc9df3003bf78c4146847303e8d345600a587fb6fd817343f8822fc62f42b
+  metadata.gz: 98c3a3e01f125e81eb58559ca0f7931c55bb787102d89d0c10dd9c9a7ea2e221
+  data.tar.gz: 8d82c20b77fe2c98773b72ab2483bdfb2d1267c65f9b8102cb2ffba00c141ee9
 SHA512:
-  metadata.gz: 1167fd1b55ffa9805721f598c5ee3e53f9759562ec86088c1237d6c21fc2359c58edf4e6dd81ac91016a36f470636f70ac120939b255e62c0a075a3e6a2190d4
-  data.tar.gz: 815b6f851d8f7c9ccee2f3e8185c66176bd9263becdab417b8afef70b9aa3e005e78864b135f5c06d6f3a201da3070fe1fe046aee68922c15f9be0170ae9af07
+  metadata.gz: c014af737549553d82d1d65ac1f46fbb09cefae9cb5aca3d5c39a4bbc180587fea4a65fa6756cad87eb031af52806693ddf11b9c2a4564bb140b1b1261b216c7
+  data.tar.gz: f0c050cb59d1a3022fbf2b5ca180b644493c8630103e09498e7a9097bbda97df3cb3a28b84f125331196819123cad128f85a142c7952918d9df376acfd1dff69

data/Rakefile

@@ -9,8 +9,8 @@ task :gem do
 end
 
 task publish: :gem do
-  system "git tag -a v#{SemanticLogger::VERSION} -m 'Tagging #{SemanticLogger::VERSION}'"
-  system "git push --tags"
+  # system "git tag -a v#{SemanticLogger::VERSION} -m 'Tagging #{SemanticLogger::VERSION}'"
+  # system "git push --tags"
   system "gem push semantic_logger-#{SemanticLogger::VERSION}.gem"
   system "rm semantic_logger-#{SemanticLogger::VERSION}.gem"
 end

data/lib/semantic_logger/appender/honeybadger_insights.rb

@@ -43,7 +43,7 @@ module SemanticLogger
 
       # Send log to honeybadger events API
       def log(log)
-        event = formatter.call(log, self)
+        event = formatter.call(log, self).merge(event_type: "log")
 
         ::Honeybadger.event(event)
 

data/lib/semantic_logger/appender/new_relic_logs.rb

@@ -23,6 +23,11 @@ require "semantic_logger/formatters/new_relic_logs"
 module SemanticLogger
   module Appender
     class NewRelicLogs < SemanticLogger::Subscriber
+      CAPTURE_CONTEXT = lambda do |log|
+        meta = ::NewRelic::Agent.linking_metadata
+        log.set_context(:new_relic_metadata, meta) unless meta.empty?
+      end
+
       # Create Appender
       #
       # Parameters
@@ -42,6 +47,11 @@ module SemanticLogger
       #           The Proc must return true or false.
       def initialize(formatter: SemanticLogger::Formatters::NewRelicLogs.new, **args, &block)
         super
+
+        # Record NewRelic's "trace.id"/"entity.name"/"hostname"/etc, so we can include them later in the formatted output.
+        # These are thread-local, so need to be captured as soon as the log-message is created.
+        # https://rubydoc.info/gems/newrelic_rpm/NewRelic/Agent#linking_metadata-instance_method
+        SemanticLogger.on_log(CAPTURE_CONTEXT)
       end
 
       # Send an error notification to New Relic

data/lib/semantic_logger/appender/open_telemetry.rb

@@ -12,7 +12,7 @@ end
 module SemanticLogger
   module Appender
     class OpenTelemetry < SemanticLogger::Subscriber
-      attr_reader :name, :version, :logger
+      attr_reader :name, :version, :provider, :logger
 
       CAPTURE_CONTEXT = ->(log) { log.set_context(:open_telemetry, ::OpenTelemetry::Context.current) }
 
@@ -30,9 +30,10 @@ module SemanticLogger
                      metrics: true,
                      **args,
                      &block)
-        @name    = name
-        @version = version
-        @logger  = ::OpenTelemetry.logger_provider.logger(name: @name, version: @version)
+        @name      = name
+        @version   = version
+        @provider  = ::OpenTelemetry.logger_provider
+        @logger    = @provider.logger(name: @name, version: @version)
 
         # Capture the current Open Telemetry context when a log entry is captured.
         # Prevents duplicate subscribers as long as it is from a constant.
@@ -63,12 +64,23 @@ module SemanticLogger
 
       # Flush all pending logs.
       def flush
-        @logger.logger_provider.force_flush
+        return unless @provider
+
+        @provider.force_flush if @provider.respond_to?(:force_flush)
+      rescue StandardError => e
+        # Swallow to avoid noisy shutdown exceptions.
+        SemanticLogger.logger.warn("Flush failed: #{e.class}: #{e.message}")
       end
 
-      # Flush pending logs and close the appender
+      # Close the appender and release resources.
       def close
-        @logger.logger_provider.shutdown
+        return unless @provider
+
+        @provider.shutdown if @provider.respond_to?(:shutdown)
+      rescue StandardError => e
+        SemanticLogger.logger.warn("Shutdown failed: #{e.class}: #{e.message}")
+      ensure
+        @provider = nil
       end
 
       # For logging metrics only log events.

data/lib/semantic_logger/appender/sentry_ruby.rb

@@ -40,7 +40,12 @@ module SemanticLogger
       def initialize(level: :error, **args, &block)
         # Replace the Sentry Ruby logger so that we can identify its log
         # messages and not forward them to Sentry
-        ::Sentry.init { |config| config.logger = SemanticLogger[::Sentry] } unless ::Sentry.initialized?
+        unless ::Sentry.initialized?
+          ::Sentry.init do |config|
+            logger = SemanticLogger[::Sentry]
+            config.respond_to?(:sdk_logger=) ? config.sdk_logger = logger : config.logger = logger
+          end
+        end
         super
       end
 

data/lib/semantic_logger/base.rb

@@ -34,6 +34,19 @@ module SemanticLogger
       @level || SemanticLogger.default_level
     end
 
+    # Set the logging level for this logger during the execution of the given block
+    #
+    # Refer to the documentation for `#level=` for more information about the possible log levels.
+    def with_level(new_level)
+      old_level = level
+
+      self.level = new_level
+
+      yield
+    ensure
+      self.level = old_level
+    end
+
     # Implement the log level calls
     #   logger.debug(message, hash|exception=nil, &block)
     #

data/lib/semantic_logger/formatters/new_relic_logs.rb

@@ -47,7 +47,7 @@ module SemanticLogger
         hash = super
 
         result = {
-          **newrelic_metadata,
+          **linking_metadata(log),
           message:       hash[:message].to_s,
           tags:          hash[:tags],
           metric:        hash[:metric],
@@ -115,11 +115,9 @@ module SemanticLogger
 
       private
 
-      # NOTE: This function will already include trace.id and span.id if they
-      # are available so I believe the previous implementation of this is redundant
-      # https://rubydoc.info/gems/newrelic_rpm/NewRelic/Agent#linking_metadata-instance_method
-      def newrelic_metadata
-        NewRelic::Agent.linking_metadata.transform_keys(&:to_sym)
+      # returns "entity.name", "trace.id" etc from NewRelic::Agent.linking_metadata
+      def linking_metadata(log)
+        (log.context && log.context[:new_relic_metadata]) || {}
       end
     end
   end

data/lib/semantic_logger/formatters/open_telemetry.rb

@@ -2,6 +2,9 @@ require "json"
 module SemanticLogger
   module Formatters
     class OpenTelemetry < Raw
+      # primitives allowed by OTLP logs in Ruby: String, Integer, Float, TrueClass, FalseClass
+      PRIMS = [String, Integer, Float, TrueClass, FalseClass].freeze
+
       # Log level
       def level
         hash[:level]       = log.level.to_s
@@ -12,11 +15,36 @@ module SemanticLogger
       def payload
         return unless log.payload.respond_to?(:empty?) && !log.payload.empty?
 
-        hash[:payload] = log.payload.transform_keys!(&:to_s)
+        hash[:payload] = coerce_map(log.payload)
       end
 
       private
 
+      def coerce_value(v)
+        case v
+        when *PRIMS then v
+        when Array  then v.map { |e| coerce_value(e) }.compact   # arrays of scalars only.
+        when NilClass then nil                                   # drop nils by caller.
+        else v.to_s                                              # stringify objects / hashes.
+        end
+      end
+
+      def coerce_map(h)
+        h.each_with_object({}) do |(k, v), out|
+          next if v.nil?
+
+          out[k.to_s] =
+            if v.is_a?(Hash)
+              # Stringify whole hash.
+              v.transform_values { |vv| coerce_value(vv) }.
+                transform_keys!(&:to_s).
+                to_json
+            else
+              coerce_value(v)
+            end
+        end
+      end
+
       def severity_number(severity)
         case severity
         when :trace

data/lib/semantic_logger/log.rb

@@ -93,6 +93,11 @@ module SemanticLogger
       self.dimensions    = dimensions
 
       if exception
+        unless exception.is_a?(Exception)
+          exception = ArgumentError.new("Invalid value for logger exception: #{exception.inspect}")
+          exception.set_backtrace(Utils.extract_backtrace(caller))
+        end
+
         case log_exception
         when :full
           self.exception = exception

data/lib/semantic_logger/processor.rb

@@ -23,7 +23,7 @@ module SemanticLogger
 
     attr_reader :appenders
 
-    def initialize(max_queue_size: -1)
+    def initialize(max_queue_size: 10_000)
       @appenders = Appenders.new(self.class.logger.dup)
       super(appender: @appenders, max_queue_size: max_queue_size)
     end

data/lib/semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module SemanticLogger
-  VERSION = "4.17.0".freeze
+  VERSION = "4.18.0".freeze
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: semantic_logger
 version: !ruby/object:Gem::Version
-  version: 4.17.0
+  version: 4.18.0
 platform: ruby
 authors:
 - Reid Morrison
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -104,7 +104,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/reidmorrison/semantic_logger/issues
   documentation_uri: https://logger.rocketjob.io
-  source_code_uri: https://github.com/reidmorrison/semantic_logger/tree/v4.17.0
+  source_code_uri: https://github.com/reidmorrison/semantic_logger/tree/v4.18.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Feature rich logging framework, and replacement for existing Ruby & Rails
   loggers.