semantic_logger 4.12.0 → 4.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b09c37737f1e42edbeee95b036ba0581d5164d756e13de37aca9b22b3093cd45
-  data.tar.gz: 9f66b72480df2371a7d305164e443f9667e1acd5521c1347d54c3841efbfa4c9
+  metadata.gz: 0c00e5f1ab5a36a350afa8a082d367ec78c59b62bcfc29027fa843be48b658d4
+  data.tar.gz: 5d77c0d14230c349b5dd58aa29b8f625ea867f7600665482a724b8f13db44f49
 SHA512:
-  metadata.gz: fb27aa1a6d5dc1f2e0e6505ba9348a7cec091a153763361e8c9c20c21177bf84ac11ac2f21fc37ec994988ba31763dcd5c3134ac40a169ac987ed617eceec46e
-  data.tar.gz: 5d084bc8cc57b1e836326eae912667ef6b7a284b0125c0b0acee678af78c01017b9667db9a43df7c0fb38af4998b0ab3128ac05d3e2bce266176e9c4d8fadccd
+  metadata.gz: e8c85cca0bf54d04235b12030c0602cdea04b597fcac1544819f25e1b3c40ae35a0874ed7d8b1286db370f5e4d122f812f2437f3e32c20ab45e443f3a735f641
+  data.tar.gz: 172a1ff0b357792afba013577a326e1e2a9ea1bf3b8e83d01f8e0424e2ae9332053322ccbbda328c3607930a7f9cdec0aa5d05daa5b871fdf75182fc806d731b

data/README.md

@@ -55,6 +55,7 @@ and are therefore not automatically included by this gem:
 - Bugsnag Appender: gem 'bugsnag'
 - MongoDB Appender: gem 'mongo' 1.9.2 or above
 - NewRelic Appender: gem 'newrelic_rpm'
+- NewRelicLogs Appender: gem 'newrelic_rpm'
 - Syslog Appender: gem 'syslog_protocol' 0.9.2 or above
 - Syslog Appender to a remote syslogng server over TCP or UDP: gem 'net_tcp_client'
 - Splunk Appender: gem 'splunk-sdk-ruby'

data/lib/semantic_logger/appender/async_batch.rb

@@ -1,5 +1,3 @@
-require "concurrent"
-
 module SemanticLogger
   module Appender
     # Log asynchronously in batches using a separate thread.

data/lib/semantic_logger/appender/http.rb

@@ -160,10 +160,10 @@ module SemanticLogger
         end
 
         @http = if @proxy_uri
-          Net::HTTP.new(server, port, @proxy_uri.host, @proxy_uri.port, @proxy_uri.user, @proxy_uri.password)
-        else
-          Net::HTTP.new(server, port, @proxy_url)
-        end
+                  Net::HTTP.new(server, port, @proxy_uri.host, @proxy_uri.port, @proxy_uri.user, @proxy_uri.password)
+                else
+                  Net::HTTP.new(server, port, @proxy_url)
+                end
 
         if @ssl_options
           @http.methods.grep(/\A(\w+)=\z/) do |meth|

data/lib/semantic_logger/appender/new_relic_logs.rb

@@ -0,0 +1,57 @@
+begin
+  require "newrelic_rpm"
+rescue LoadError
+  raise LoadError, 'Gem newrelic_rpm is required for logging to New Relic. Please add the gem "newrelic_rpm" to your Gemfile.'
+end
+
+require "semantic_logger/formatters/new_relic_logs"
+
+# Send log messages to NewRelic
+#
+# All log entries will appear under
+# "Logs" in New Relic
+#
+# == Caveats
+#
+# * The NewRelic agent only sends logs to NewRelic when log forwarding is enabled. There is however an open
+#   issue to get this fixed: https://github.com/newrelic/newrelic-ruby-agent/issues/1614. Please see the guide
+#   for a workaround.
+#
+# Example:
+#   SemanticLogger.add_appender(appender: :new_relic_logs)
+module SemanticLogger
+  module Appender
+    class NewRelicLogs < SemanticLogger::Subscriber
+      # Create Appender
+      #
+      # Parameters
+      #   level: [:trace | :debug | :info | :warn | :error | :fatal]
+      #     Override the log level for this appender.
+      #     Default: SemanticLogger.default_level
+      #
+      #   formatter: [Object|Proc]
+      #     An instance of a class that implements #call, or a Proc to be used to format
+      #     the output from this appender
+      #     Default: SemanticLogger::Formatters::NewRelicLogs
+      #
+      #   filter: [Regexp|Proc]
+      #     RegExp: Only include log messages where the class name matches the supplied.
+      #     regular expression. All other messages will be ignored.
+      #     Proc: Only include log messages where the supplied Proc returns true
+      #           The Proc must return true or false.
+      def initialize(formatter: SemanticLogger::Formatters::NewRelicLogs.new, **args, &block)
+        super(formatter: formatter, **args, &block)
+      end
+
+      # Send an error notification to New Relic
+      def log(log)
+        self.class.log_newrelic(formatter.call(log, self).to_json, log.level.to_s.upcase)
+        true
+      end
+
+      def self.log_newrelic(message, level)
+        ::NewRelic::Agent.agent.log_event_aggregator.record(message, level)
+      end
+    end
+  end
+end

data/lib/semantic_logger/appender.rb

@@ -15,6 +15,7 @@ module SemanticLogger
     autoload :Http,              "semantic_logger/appender/http"
     autoload :MongoDB,           "semantic_logger/appender/mongodb"
     autoload :NewRelic,          "semantic_logger/appender/new_relic"
+    autoload :NewRelicLogs,      "semantic_logger/appender/new_relic_logs"
     autoload :Rabbitmq,          "semantic_logger/appender/rabbitmq"
     autoload :Splunk,            "semantic_logger/appender/splunk"
     autoload :SplunkHttp,        "semantic_logger/appender/splunk_http"

data/lib/semantic_logger/base.rb

@@ -77,7 +77,7 @@ module SemanticLogger
     #    # Log an exception in a semantic way
     #    logger.info("Parsing received XML", exc)
     #
-    SemanticLogger::LEVELS.each_with_index do |level, index|
+    SemanticLogger::Levels::LEVELS.each_with_index do |level, index|
       class_eval <<~METHODS, __FILE__, __LINE__ + 1
         def #{level}(message=nil, payload=nil, exception=nil, &block)
           if level_index <= #{index}

data/lib/semantic_logger/formatters/base.rb

@@ -23,7 +23,6 @@ module SemanticLogger
       #     See Time#strftime for the format of this string.
       #     :iso_8601 Outputs an ISO8601 Formatted timestamp.
       #     :ms       Output in miliseconds since epoch.
-      #     nil:      Returns Empty string for time ( no time is output ).
       #     Default: '%Y-%m-%d %H:%M:%S.%<precision>N'
       #   log_host: [Boolean]
       #     Whether or not to include hostname in logs

data/lib/semantic_logger/formatters/new_relic_logs.rb

@@ -0,0 +1,109 @@
+require "json"
+
+begin
+  require "newrelic_rpm"
+rescue LoadError
+  raise LoadError, 'Gem newrelic_rpm is required for logging to New Relic. Please add the gem "newrelic_rpm" to your Gemfile.'
+end
+
+raise "NewRelic::Agent.linking_metadata is not defined. Please update newrelic_rpm gem version" unless NewRelic::Agent.respond_to?(:linking_metadata)
+
+raise "NewRelic::Agent::Tracer.current_span_id is not defined. Please update newrelic_rpm gem version" unless NewRelic::Agent::Tracer.respond_to?(:current_span_id)
+
+raise "NewRelic::Agent::Tracer.current_trace_id is not defined. Please update newrelic_rpm gem version" unless NewRelic::Agent::Tracer.respond_to?(:current_trace_id)
+
+module SemanticLogger
+  module Formatters
+    # Formatter for reporting to NewRelic's Logger
+    #
+    # New Relic's logs do not support custom attributes out of the box, and therefore these
+    # have to be put into a single JSON serialized string under the +message+ key.
+    #
+    # In particular the following fields of the log object are serialized under the +message+
+    # key that's sent to NewRelic:
+    #
+    # * message
+    # * tags
+    # * named_tags
+    # * payload
+    # * metric
+    # * metric_amount
+    # * environment
+    # * application
+    #
+    # == New Relic Attributes not Supported
+    # * thread.id
+    # * class.name
+    # * method.name
+    #
+    # == Reference
+    # * Logging specification
+    #   * https://github.com/newrelic/newrelic-exporter-specs/tree/master/logging
+    #
+    # * Metadata APIs
+    #   * https://www.rubydoc.info/gems/newrelic_rpm/NewRelic/Agent#linking_metadata-instance_method
+    #   * https://www.rubydoc.info/gems/newrelic_rpm/NewRelic/Agent/Tracer#current_trace_id-class_method
+    #   * https://www.rubydoc.info/gems/newrelic_rpm/NewRelic/Agent/Tracer#current_span_id-class_method
+    #
+    class NewRelicLogs < Raw
+      def initialize(**args)
+        args.delete(:time_key)
+        args.delete(:time_format)
+
+        super(time_key: :timestamp, time_format: :ms, **args)
+      end
+
+      def call(log, logger)
+        hash = super(log, logger)
+
+        message = {
+          message:    hash[:message].to_s,
+          tags:       hash[:tags] || [],
+          named_tags: hash[:named_tags] || {},
+
+          **hash.slice(:metric, :metric_amount, :environment, :application, :payload)
+        }
+
+        message.merge!(duration: hash[:duration_ms]) if hash.key?(:duration_ms)
+        message.merge!(duration_human: hash[:duration]) if hash.key?(:duration)
+
+        result = {
+          **new_relic_metadata,
+          message:       message.to_json,
+          timestamp:     hash[:timestamp].to_i,
+          "log.level":   log.level.to_s.upcase,
+          "logger.name": log.name,
+          "thread.name": log.thread_name.to_s
+        }
+
+        if hash[:exception]
+          result.merge!(
+            "error.message": hash[:exception][:message],
+            "error.class":   hash[:exception][:name],
+            "error.stack":   hash[:exception][:stack_trace].join("\n")
+          )
+        end
+
+        if hash[:file]
+          result.merge!(
+            "file.name":   hash[:file],
+            "line.number": hash[:line].to_s
+          )
+        end
+
+        result
+      end
+
+      private
+
+      def new_relic_metadata
+        {
+          "trace.id": NewRelic::Agent::Tracer.current_trace_id,
+          "span.id":  NewRelic::Agent::Tracer.current_span_id,
+          **NewRelic::Agent.linking_metadata
+        }.reject { |_k, v| v.nil? }.
+          map { |k, v| [k.to_sym, v] }.to_h
+      end
+    end
+  end
+end

data/lib/semantic_logger/formatters.rb

@@ -1,16 +1,17 @@
 module SemanticLogger
   module Formatters
-    autoload :Base,      "semantic_logger/formatters/base"
-    autoload :Color,     "semantic_logger/formatters/color"
-    autoload :Default,   "semantic_logger/formatters/default"
-    autoload :Json,      "semantic_logger/formatters/json"
-    autoload :Raw,       "semantic_logger/formatters/raw"
-    autoload :OneLine,   "semantic_logger/formatters/one_line"
-    autoload :Signalfx,  "semantic_logger/formatters/signalfx"
-    autoload :Syslog,    "semantic_logger/formatters/syslog"
-    autoload :Fluentd,   "semantic_logger/formatters/fluentd"
-    autoload :Logfmt,    "semantic_logger/formatters/logfmt"
-    autoload :SyslogCee, "semantic_logger/formatters/syslog_cee"
+    autoload :Base,         "semantic_logger/formatters/base"
+    autoload :Color,        "semantic_logger/formatters/color"
+    autoload :Default,      "semantic_logger/formatters/default"
+    autoload :Json,         "semantic_logger/formatters/json"
+    autoload :Raw,          "semantic_logger/formatters/raw"
+    autoload :OneLine,      "semantic_logger/formatters/one_line"
+    autoload :Signalfx,     "semantic_logger/formatters/signalfx"
+    autoload :Syslog,       "semantic_logger/formatters/syslog"
+    autoload :Fluentd,      "semantic_logger/formatters/fluentd"
+    autoload :Logfmt,       "semantic_logger/formatters/logfmt"
+    autoload :SyslogCee,    "semantic_logger/formatters/syslog_cee"
+    autoload :NewRelicLogs, "semantic_logger/formatters/new_relic_logs"
 
     # Return formatter that responds to call.
     #

data/lib/semantic_logger/levels.rb

@@ -1,35 +1,31 @@
+require "logger"
+
 module SemanticLogger
   module Levels
     # Logging levels in order of most detailed to most severe
     LEVELS = %i[trace debug info warn error fatal].freeze
 
+    # Map the built-in `Logger` levels to SemanticLogger levels.
+    MAPPED_LEVELS =
+      ::Logger::Severity.constants.each_with_object([]) do |constant, levels|
+        logger_value = ::Logger::Severity.const_get(constant)
+        levels[logger_value] = LEVELS.find_index(constant.downcase.to_sym) || LEVELS.find_index(:error)
+      end.freeze
+
     # Internal method to return the log level as an internal index
     # Also supports mapping the ::Logger levels to SemanticLogger levels
     def self.index(level)
       return if level.nil?
 
-      index =
-        if level.is_a?(Symbol)
-          LEVELS.index(level)
-        elsif level.is_a?(String)
-          level = level.downcase.to_sym
-          LEVELS.index(level)
-        elsif level.is_a?(Integer) && defined?(::Logger::Severity)
-          # Mapping of Rails and Ruby Logger levels to SemanticLogger levels
-          @map_levels ||=
-            begin
-              levels = []
-              ::Logger::Severity.constants.each do |constant|
-                levels[::Logger::Severity.const_get(constant)] =
-                  LEVELS.find_index(constant.downcase.to_sym) || LEVELS.find_index(:error)
-              end
-              levels
-            end
-          @map_levels[level]
-        end
-      raise "Invalid level:#{level.inspect} being requested. Must be one of #{LEVELS.inspect}" unless index
-
-      index
+      case level
+      when Symbol
+        LEVELS.index(level)
+      when String
+        LEVELS.index(level.downcase.to_sym)
+      when Integer
+        MAPPED_LEVELS[level]
+      end ||
+        raise(ArgumentError, "Invalid level:#{level.inspect} being requested. Must be one of #{LEVELS.inspect}")
     end
 
     # Returns the symbolic level for the supplied level index

data/lib/semantic_logger/logger.rb

@@ -1,4 +1,3 @@
-require "concurrent"
 module SemanticLogger
   # Logger stores the class name to be used for all log messages so that every
   # log message written by this instance will include the class name

data/lib/semantic_logger/semantic_logger.rb

@@ -1,4 +1,3 @@
-require "concurrent"
 require "socket"
 
 module SemanticLogger
@@ -517,4 +516,27 @@ module SemanticLogger
   @backtrace_level       = :error
   @backtrace_level_index = Levels.index(@backtrace_level)
   @sync                  = false
+
+  # @formatter:off
+  module Metric
+    autoload :NewRelic,          "semantic_logger/metric/new_relic"
+    autoload :Signalfx,          "semantic_logger/metric/signalfx"
+    autoload :Statsd,            "semantic_logger/metric/statsd"
+  end
+
+  module Reporters
+    autoload :Minitest,          "semantic_logger/reporters/minitest"
+  end
+
+  module Test
+    autoload :CaptureLogEvents,  "semantic_logger/test/capture_log_events"
+    autoload :Minitest,          "semantic_logger/test/minitest"
+  end
+
+  if defined?(JRuby)
+    module JRuby
+      autoload :GarbageCollectionLogger, "semantic_logger/jruby/garbage_collection_logger"
+    end
+  end
+  # @formatter:on
 end

data/lib/semantic_logger/test/capture_log_events.rb

@@ -24,10 +24,15 @@ module SemanticLogger
       # By default collect all log levels, and collect metric only log events.
       def initialize(level: :trace, metrics: true)
         super(level: level, metrics: true)
+        @events = []
       end
 
       def log(log)
-        (@events ||= []) << log
+        @events << log
+      end
+
+      def clear
+        @events.clear
       end
     end
   end

data/lib/semantic_logger/test/minitest.rb

@@ -0,0 +1,53 @@
+module SemanticLogger
+  module Test
+    module Minitest
+      # Returns [Array<SemanticLogger::Log>] the log events from Semantic Logger
+      # captured whilst executing the supplied block.
+      def semantic_logger_events(klass = nil, &block)
+        logger = SemanticLogger::Test::CaptureLogEvents.new
+        if klass
+          klass.stub(:logger, logger, &block)
+        else
+          SemanticLogger.silence(:trace) do
+            SemanticLogger::Logger.stub(:processor, logger, &block)
+          end
+        end
+        logger.events
+      end
+
+      # Verify a single log event has all the required attributes.
+      def assert_semantic_logger_event(event, level: nil, name: nil, message: nil, message_includes: nil,
+                                       payload: nil, payload_includes: nil,
+                                       thread_name: nil, tags: nil, named_tags: nil, context: nil,
+                                       metric: nil, metric_amount: nil, dimensions: nil)
+        msg = message || message_includes || "no message"
+        assert event, "Log event missing for message: '#{msg}'"
+        assert_equal message, event.message if message
+        assert_includes event.message, message_includes if message_includes
+        assert_equal name, event.name, -> { "Mismatched log name for message: '#{msg}'" } if name
+        assert_equal level, event.level, -> { "Mismatched log level for message: '#{msg}'" } if level
+
+        if payload_includes
+          payload_includes.each_pair do |key, expected_value|
+            value = event.payload[key]
+            if expected_value.nil?
+              assert_nil value, -> { "Mismatched key: #{key.inspect} in log payload: #{event.payload} for message: '#{msg}'" }
+            else
+              assert_equal expected_value, value, -> { "Mismatched key: #{key.inspect} in log payload: #{event.payload} for message: '#{msg}'" }
+            end
+          end
+        elsif payload
+          assert_equal payload, event.payload, -> { "Mismatched log payload: #{event.payload} for message: '#{msg}'" }
+        end
+
+        assert_equal thread_name, event.thread_name, -> { "Mismatched thread_name for message: '#{msg}'" } if thread_name
+        assert_equal tags, event.tags, -> { "Mismatched tags for message: '#{msg}'" } if tags
+        assert_equal named_tags, event.named_tags, -> { "Mismatched named_tags for message: '#{msg}'" } if named_tags
+        assert_equal context, event.context, -> { "Mismatched context for message: '#{msg}'" } if context
+        assert_equal metric, event.metric, -> { "Mismatched metric for message: '#{msg}'" } if metric
+        assert_equal metric_amount, event.metric_amount, -> { "Mismatched metric_amount for message: '#{msg}'" } if metric_amount
+        assert_equal dimensions, event.dimensions, -> { "Mismatched dimensions for message: '#{msg}'" } if dimensions
+      end
+    end
+  end
+end

data/lib/semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module SemanticLogger
-  VERSION = "4.12.0".freeze
+  VERSION = "4.13.0".freeze
 end

data/lib/semantic_logger.rb

@@ -1,49 +1,22 @@
+require "concurrent"
 require "semantic_logger/core_ext/thread"
 require "semantic_logger/version"
-
-# @formatter:off
-module SemanticLogger
-  autoload :AnsiColors,         "semantic_logger/ansi_colors"
-  autoload :Appender,           "semantic_logger/appender"
-  autoload :Appenders,          "semantic_logger/appenders"
-  autoload :Base,               "semantic_logger/base"
-  autoload :DebugAsTraceLogger, "semantic_logger/debug_as_trace_logger"
-  autoload :Formatters,         "semantic_logger/formatters"
-  autoload :Levels,             "semantic_logger/levels"
-  autoload :Log,                "semantic_logger/log"
-  autoload :Logger,             "semantic_logger/logger"
-  autoload :Loggable,           "semantic_logger/loggable"
-  autoload :Processor,          "semantic_logger/processor"
-  autoload :Subscriber,         "semantic_logger/subscriber"
-  autoload :SyncProcessor,      "semantic_logger/sync_processor"
-  autoload :Utils,              "semantic_logger/utils"
-
-  module Concerns
-    autoload :Compatibility, "semantic_logger/concerns/compatibility"
-  end
-
-  module Metric
-    autoload :NewRelic,          "semantic_logger/metric/new_relic"
-    autoload :Signalfx,          "semantic_logger/metric/signalfx"
-    autoload :Statsd,            "semantic_logger/metric/statsd"
-  end
-
-  module Reporters
-    autoload :Minitest,          "semantic_logger/reporters/minitest"
-  end
-
-  module Test
-    autoload :CaptureLogEvents,  "semantic_logger/test/capture_log_events"
-  end
-
-  if defined?(JRuby)
-    module JRuby
-      autoload :GarbageCollectionLogger, "semantic_logger/jruby/garbage_collection_logger"
-    end
-  end
-end
+require "semantic_logger/utils"
+require "semantic_logger/ansi_colors"
+require "semantic_logger/levels"
+require "semantic_logger/base"
+require "semantic_logger/formatters"
+require "semantic_logger/log"
+require "semantic_logger/subscriber"
+require "semantic_logger/loggable"
+require "semantic_logger/concerns/compatibility"
+require "semantic_logger/appender"
+require "semantic_logger/appenders"
+require "semantic_logger/processor"
+require "semantic_logger/sync_processor"
+require "semantic_logger/logger"
+require "semantic_logger/debug_as_trace_logger"
 require "semantic_logger/semantic_logger"
-# @formatter:on
 
 # Flush all appenders at exit, waiting for outstanding messages on the queue
 # to be written first.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semantic_logger
 version: !ruby/object:Gem::Version
-  version: 4.12.0
+  version: 4.13.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-30 00:00:00.000000000 Z
+date: 2023-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -49,6 +49,7 @@ files:
 - lib/semantic_logger/appender/kafka.rb
 - lib/semantic_logger/appender/mongodb.rb
 - lib/semantic_logger/appender/new_relic.rb
+- lib/semantic_logger/appender/new_relic_logs.rb
 - lib/semantic_logger/appender/rabbitmq.rb
 - lib/semantic_logger/appender/sentry.rb
 - lib/semantic_logger/appender/sentry_ruby.rb
@@ -70,6 +71,7 @@ files:
 - lib/semantic_logger/formatters/fluentd.rb
 - lib/semantic_logger/formatters/json.rb
 - lib/semantic_logger/formatters/logfmt.rb
+- lib/semantic_logger/formatters/new_relic_logs.rb
 - lib/semantic_logger/formatters/one_line.rb
 - lib/semantic_logger/formatters/raw.rb
 - lib/semantic_logger/formatters/signalfx.rb
@@ -90,6 +92,7 @@ files:
 - lib/semantic_logger/sync.rb
 - lib/semantic_logger/sync_processor.rb
 - lib/semantic_logger/test/capture_log_events.rb
+- lib/semantic_logger/test/minitest.rb
 - lib/semantic_logger/utils.rb
 - lib/semantic_logger/version.rb
 homepage: https://logger.rocketjob.io
@@ -111,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.9
 signing_key:
 specification_version: 4
 summary: Feature rich logging framework, and replacement for existing Ruby & Rails