semantic_logger 4.10.0 → 4.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ff7d4bcb345581f6ba19f834bb1bf2f921e97904f4b6236142b87af75a4526d
-  data.tar.gz: b1069d5360296c61c9796f630b1ec065eb1a0a7dc549778c66c5e26c90d0eadb
+  metadata.gz: b09c37737f1e42edbeee95b036ba0581d5164d756e13de37aca9b22b3093cd45
+  data.tar.gz: 9f66b72480df2371a7d305164e443f9667e1acd5521c1347d54c3841efbfa4c9
 SHA512:
-  metadata.gz: c5cfbac7dd8795b11cf79ed3fa9a4a086128d5ee030f0e9db40b75f30f58997c1674a4284b4b287939216bc8de83372e2b7fe00d73e7856c3cc6830310740f0d
-  data.tar.gz: 2150a809562247d771103a5d387ae5852ff5b0649a4f4288a7dd07a94420bafcfb6b36f3e21077fcc053c2d8bcaffe80a110ab65b52178fb612b7368fd79d87d
+  metadata.gz: fb27aa1a6d5dc1f2e0e6505ba9348a7cec091a153763361e8c9c20c21177bf84ac11ac2f21fc37ec994988ba31763dcd5c3134ac40a169ac987ed617eceec46e
+  data.tar.gz: 5d084bc8cc57b1e836326eae912667ef6b7a284b0125c0b0acee678af78c01017b9667db9a43df7c0fb38af4998b0ab3128ac05d3e2bce266176e9c4d8fadccd

data/lib/semantic_logger/appender/async.rb

@@ -59,7 +59,7 @@ module SemanticLogger
 
         appender.reopen if appender.respond_to?(:reopen)
 
-        @thread.kill if @thread&.alive?
+        @thread&.kill if @thread&.alive?
         @thread = Thread.new { process }
       end
 

data/lib/semantic_logger/appender/http.rb

@@ -21,7 +21,7 @@ module SemanticLogger
     class Http < SemanticLogger::Subscriber
       attr_accessor :username, :compress, :header,
                     :open_timeout, :read_timeout, :continue_timeout
-      attr_reader :http, :url, :server, :port, :path, :ssl_options
+      attr_reader :http, :url, :server, :port, :path, :ssl_options, :proxy_url
 
       # Create HTTP(S) log appender
       #
@@ -57,6 +57,16 @@ module SemanticLogger
       #       ca_file, ca_path, cert, cert_store, ciphers, key, ssl_timeout,
       #       ssl_version, verify_callback, verify_depth and verify_mode.
       #
+      #   proxy_url: [String]
+      #     URL of proxy server to use for HTTP(s) connections.  Should
+      #       include username and password if required.
+      #       Example: http://user@pass:example.com/some_path
+      #     To enable SSL include https in the URL.
+      #       Example: https://example.com/some_path
+      #     If this is set to :ENV, Net::HTTP will use the environment http_proxy*
+      #       variables if they are set.  If set to nil then no proxy will be used,
+      #       even if the environment variables are set.
+      #
       #   level: [:trace | :debug | :info | :warn | :error | :fatal]
       #     Override the log level for this appender.
       #     Default: SemanticLogger.default_level
@@ -85,6 +95,7 @@ module SemanticLogger
                      ssl: {},
                      username: nil,
                      password: nil,
+                     proxy_url: :ENV,
                      open_timeout: 2.0,
                      read_timeout: 1.0,
                      continue_timeout: 1.0,
@@ -92,6 +103,7 @@ module SemanticLogger
                      &block)
 
         @url              = url
+        @proxy_url        = proxy_url
         @ssl_options      = ssl
         @username         = username
         @password         = password
@@ -129,6 +141,9 @@ module SemanticLogger
         else
           @port ||= HTTP.http_default_port
         end
+
+        @proxy_uri = URI.parse(@proxy_url) if @proxy_url && @proxy_url != :ENV
+
         @http = nil
 
         super(**args, &block)
@@ -144,7 +159,11 @@ module SemanticLogger
           nil
         end
 
-        @http = Net::HTTP.new(server, port)
+        @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
 
         if @ssl_options
           @http.methods.grep(/\A(\w+)=\z/) do |meth|

data/lib/semantic_logger/appender/kafka.rb

@@ -23,8 +23,8 @@ module SemanticLogger
   module Appender
     class Kafka < SemanticLogger::Subscriber
       attr_accessor :seed_brokers, :client_id, :connect_timeout, :socket_timeout,
-                    :ssl_ca_cert, :ssl_client_cert, :ssl_client_cert_key,
-                    :delivery_threshold, :delivery_interval,
+                    :ssl_ca_cert, :ssl_client_cert, :ssl_client_cert_key, :ssl_ca_certs_from_system,
+                    :delivery_threshold, :delivery_interval, :required_acks,
                     :topic, :partition, :partition_key, :key
 
       # Send log messages to Kafka in JSON format.
@@ -79,6 +79,9 @@ module SemanticLogger
       #     Must be used in combination with ssl_client_cert.
       #     Default: nil
       #
+      #   ssl_ca_certs_from_system: [boolean]
+      #     Delegate SSL CA cert to the system certs
+      #
       #    delivery_threshold: [Integer]
       #      Number of messages between triggering a delivery of messages to Apache Kafka.
       #      Default: 100
@@ -87,6 +90,10 @@ module SemanticLogger
       #      Number of seconds between triggering a delivery of messages to Apache Kafka.
       #      Default: 5
       #
+      #    required_acks: [Integer]
+      #      Number of replicas that must acknowledge receipt of each log message to the topic
+      #      Default: 1
+      #
       # Semantic Logger Parameters:
       #
       #   level: [:trace | :debug | :info | :warn | :error | :fatal]
@@ -116,24 +123,26 @@ module SemanticLogger
       #     Send metrics only events to kafka.
       #     Default: true
       def initialize(seed_brokers:, client_id: "semantic-logger", connect_timeout: nil, socket_timeout: nil,
-                     ssl_ca_cert: nil, ssl_client_cert: nil, ssl_client_cert_key: nil,
+                     ssl_ca_cert: nil, ssl_client_cert: nil, ssl_client_cert_key: nil, ssl_ca_certs_from_system: false,
                      topic: "log_messages", partition: nil, partition_key: nil, key: nil,
-                     delivery_threshold: 100, delivery_interval: 10,
+                     delivery_threshold: 100, delivery_interval: 10, required_acks: 1,
                      metrics: true, **args, &block)
 
-        @seed_brokers        = seed_brokers
-        @client_id           = client_id
-        @connect_timeout     = connect_timeout
-        @socket_timeout      = socket_timeout
-        @ssl_ca_cert         = ssl_ca_cert
-        @ssl_client_cert     = ssl_client_cert
-        @ssl_client_cert_key = ssl_client_cert_key
-        @topic               = topic
-        @partition           = partition
-        @partition_key       = partition_key
-        @key                 = key
-        @delivery_threshold  = delivery_threshold
-        @delivery_interval   = delivery_interval
+        @seed_brokers             = seed_brokers
+        @client_id                = client_id
+        @connect_timeout          = connect_timeout
+        @socket_timeout           = socket_timeout
+        @ssl_ca_cert              = ssl_ca_cert
+        @ssl_client_cert          = ssl_client_cert
+        @ssl_client_cert_key      = ssl_client_cert_key
+        @ssl_ca_certs_from_system = ssl_ca_certs_from_system
+        @topic                    = topic
+        @partition                = partition
+        @partition_key            = partition_key
+        @key                      = key
+        @delivery_threshold       = delivery_threshold
+        @delivery_interval        = delivery_interval
+        @required_acks            = required_acks
 
         super(metrics: metrics, **args, &block)
         reopen
@@ -141,19 +150,21 @@ module SemanticLogger
 
       def reopen
         @kafka = ::Kafka.new(
-          seed_brokers:        seed_brokers,
-          client_id:           client_id,
-          connect_timeout:     connect_timeout,
-          socket_timeout:      socket_timeout,
-          ssl_ca_cert:         ssl_ca_cert,
-          ssl_client_cert:     ssl_client_cert,
-          ssl_client_cert_key: ssl_client_cert_key,
-          logger:              logger
+          seed_brokers:             seed_brokers,
+          client_id:                client_id,
+          connect_timeout:          connect_timeout,
+          socket_timeout:           socket_timeout,
+          ssl_ca_cert:              ssl_ca_cert,
+          ssl_client_cert:          ssl_client_cert,
+          ssl_client_cert_key:      ssl_client_cert_key,
+          ssl_ca_certs_from_system: ssl_ca_certs_from_system,
+          logger:                   logger
         )
 
         @producer = @kafka.async_producer(
           delivery_threshold: delivery_threshold,
-          delivery_interval:  delivery_interval
+          delivery_interval:  delivery_interval,
+          required_acks:      required_acks
         )
       end
 

data/lib/semantic_logger/appender/sentry_ruby.rb

@@ -40,7 +40,7 @@ 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] }
+        ::Sentry.init { |config| config.logger = SemanticLogger[::Sentry] } unless ::Sentry.initialized?
         super(level: level, **args, &block)
       end
 

data/lib/semantic_logger/base.rb

@@ -186,7 +186,8 @@ module SemanticLogger
     #   to:
     #     `logger.tagged('first', 'more', 'other')`
     # - For better performance with clean tags, see `SemanticLogger.tagged`.
-    def tagged(*tags, &block)
+    def tagged(*tags)
+      block = -> { yield(self) }
       # Allow named tags to be passed into the logger
       # Rails::Rack::Logger passes logs as an array with a single argument
       if tags.size == 1 && !tags.first.is_a?(Array)
@@ -327,14 +328,14 @@ module SemanticLogger
 
       log = Log.new(name, level, index)
       should_log =
-        if payload.nil? && exception.nil? && message.is_a?(Hash)
-          # Everything as keyword arguments.
+        if exception.nil? && payload.nil? && message.is_a?(Hash)
+          # All arguments as a hash in the message.
           log.assign(**log.extract_arguments(message))
         elsif exception.nil? && message && payload && payload.is_a?(Hash)
-          # Message with keyword arguments as the rest.
-          log.assign(message: message, **log.extract_arguments(payload))
+          # Message supplied along with a hash with the remaining arguments.
+          log.assign(**log.extract_arguments(payload, message))
         else
-          # No keyword arguments.
+          # All fields supplied directly.
           log.assign(message: message, payload: payload, exception: exception)
         end
 

data/lib/semantic_logger/formatters/logfmt.rb

@@ -62,7 +62,12 @@ module SemanticLogger
 
       def flatten_log
         flattened = @parsed.map do |key, value|
-          "#{key}=#{value.to_json}"
+          case value
+          when Hash, Array
+            "#{key}=#{value.to_s.to_json}"
+          else
+            "#{key}=#{value.to_json}"
+          end
         end
 
         flattened.join(" ")

data/lib/semantic_logger/formatters/syslog_cee.rb

@@ -23,7 +23,7 @@ module SemanticLogger
       #
       # Example:
       #   # Log via udp to a remote syslog server on host: `server1` and port `8514`, using the CEE format.
-      #   SemanticLogger.add_appender(appender: :syslog, formatter: syslog_cee, url: 'udp://server1:8514')
+      #   SemanticLogger.add_appender(appender: :syslog, formatter: :syslog_cee, url: 'udp://server1:8514')
       def initialize(facility: ::Syslog::LOG_USER, level_map: SemanticLogger::Formatters::Syslog::LevelMap.new, max_size: Integer)
         @facility  = facility
         @level_map = level_map.is_a?(SemanticLogger::Formatters::Syslog::LevelMap) ? level_map : SemanticLogger::Formatters::Syslog::LevelMap.new(level_map)

data/lib/semantic_logger/formatters.rb

@@ -1,15 +1,16 @@
 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 :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"
 
     # Return formatter that responds to call.
     #

data/lib/semantic_logger/log.rb

@@ -140,14 +140,25 @@ module SemanticLogger
     end
 
     # Extract the arguments from a Hash Payload
-    def extract_arguments(payload)
+    def extract_arguments(payload, message = nil)
       raise(ArgumentError, "payload must be a Hash") unless payload.is_a?(Hash)
 
+      message = nil if message == ""
       return payload if payload.key?(:payload)
 
-      args = {}
-      payload.each_key { |key| args[key] = payload.delete(key) if NON_PAYLOAD_KEYS.include?(key) }
-      args[:payload] = payload unless payload.empty?
+      new_payload = {}
+      args        = {}
+      payload.each_pair do |key, value|
+        # Supplied message takes precedence
+        if (key == :message) && !message.nil?
+          new_payload[key] = value
+          next
+        end
+
+        NON_PAYLOAD_KEYS.include?(key) ? args[key] = value : new_payload[key] = value
+      end
+      args[:payload] = new_payload unless new_payload.empty?
+      args[:message] = message if message
       args
     end
 

data/lib/semantic_logger/semantic_logger.rb

@@ -253,9 +253,9 @@ module SemanticLogger
   #   When the log_level_signal is raised on this process, the global default log level
   #   rotates through the following log levels in the following order, starting
   #   from the current global default level:
-  #     :warn, :info, :debug, :trace
+  #     :fatal, :error, :warn, :info, :debug, :trace
   #
-  #   If the current level is :trace it wraps around back to :warn
+  #   If the current level is :trace it wraps around back to :fatal
   #
   # 2. Logging a Ruby thread dump
   #
@@ -279,10 +279,11 @@ module SemanticLogger
   def self.add_signal_handler(log_level_signal = "USR2", thread_dump_signal = "TTIN", gc_log_microseconds = 100_000)
     if log_level_signal
       Signal.trap(log_level_signal) do
-        index     = default_level == :trace ? LEVELS.find_index(:error) : LEVELS.find_index(default_level)
-        new_level = LEVELS[index - 1]
-        self["SemanticLogger"].warn "Changed global default log level to #{new_level.inspect}"
+        current_level_index = LEVELS.find_index(default_level)
+        new_level_index = current_level_index == 0 ? LEVELS.size - 1 : current_level_index - 1
+        new_level = LEVELS[new_level_index]
         self.default_level = new_level
+        self["SemanticLogger"].warn "Changed global default log level to #{new_level.inspect}"
       end
     end
 

data/lib/semantic_logger/sync_processor.rb

@@ -1,14 +1,28 @@
 module SemanticLogger
-  # Thread that submits and processes log requests
+  # The SyncProcessor performs logging in the current thread.
+  #
+  # Appenders are designed to only be used by one thread at a time, so all calls
+  # are mutex protected in case SyncProcessor is being used in a multi-threaded environment.
   class SyncProcessor
-    extend Forwardable
+    def add(*args, &block)
+      @mutex.synchronize { @appenders.add(*args, &block) }
+    end
+
+    def log(*args, &block)
+      @mutex.synchronize { @appenders.log(*args, &block) }
+    end
+
+    def flush
+      @mutex.synchronize { @appenders.flush }
+    end
+
+    def close
+      @mutex.synchronize { @appenders.close }
+    end
 
-    # Forward methods that can be called directly
-    def_delegator :@appenders, :add
-    def_delegator :@appenders, :log
-    def_delegator :@appenders, :flush
-    def_delegator :@appenders, :close
-    def_delegator :@appenders, :reopen
+    def reopen(*args)
+      @mutex.synchronize { @appenders.reopen(*args) }
+    end
 
     # Allow the internal logger to be overridden from its default of $stderr
     #   Can be replaced with another Ruby logger or Rails logger, but never to
@@ -33,6 +47,7 @@ module SemanticLogger
     attr_reader :appenders
 
     def initialize(appenders = nil)
+      @mutex     = Mutex.new
       @appenders = appenders || Appenders.new(self.class.logger.dup)
     end
 

data/lib/semantic_logger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semantic_logger
 version: !ruby/object:Gem::Version
-  version: 4.10.0
+  version: 4.12.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-05 00:00:00.000000000 Z
+date: 2022-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -111,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Feature rich logging framework, and replacement for existing Ruby & Rails