semantic_logger 4.2.0 → 4.2.1

data/lib/semantic_logger/appender/splunk_http.rb

@@ -12,89 +12,92 @@ require 'json'
 #     url:      'http://localhost:8080',
 #     token:    '70CA900C-3D7E-42A4-9C79-7975D1C422A8'
 #   )
-class SemanticLogger::Appender::SplunkHttp < SemanticLogger::Appender::Http
-  attr_accessor :source_type, :index
+module SemanticLogger
+  module Appender
+    class SplunkHttp < SemanticLogger::Appender::Http
+      attr_accessor :source_type, :index
 
-  # Create Splunk appender over persistent HTTP(S)
-  #
-  # Parameters:
-  #   token: [String]
-  #     Token created in Splunk for this HTTP Appender
-  #     Mandatory.
-  #
-  #   source_type: [String]
-  #     Optional: Source type to display in Splunk
-  #
-  #   index: [String]
-  #     Optional: Name of a valid index for this message in Splunk.
-  #
-  #   url: [String]
-  #     Valid URL to post to.
-  #       Example: http://example.com
-  #     To enable SSL include https in the URL.
-  #       Example: https://example.com
-  #       verify_mode will default: OpenSSL::SSL::VERIFY_PEER
-  #
-  #   application: [String]
-  #     Name of this application to appear in log messages.
-  #     Default: SemanticLogger.application
-  #
-  #   host: [String]
-  #     Name of this host to appear in log messages.
-  #     Default: SemanticLogger.host
-  #
-  #   compress: [true|false]
-  #     Splunk supports HTTP Compression, enable by default.
-  #     Default: true
-  #
-  #   ssl: [Hash]
-  #     Specific SSL options: For more details see NET::HTTP.start
-  #       ca_file, ca_path, cert, cert_store, ciphers, key, open_timeout, read_timeout, ssl_timeout,
-  #       ssl_version, use_ssl, verify_callback, verify_depth and verify_mode.
-  #
-  #   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: Use the built-in formatter (See: #call)
-  #
-  #   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(token: nil, source_type: nil, index: nil,
-                 url:, compress: true, ssl: {}, open_timeout: 2.0, read_timeout: 1.0, continue_timeout: 1.0,
-                 level: nil, formatter: nil, filter: nil, application: nil, host: nil, &block)
+      # Create Splunk appender over persistent HTTP(S)
+      #
+      # Parameters:
+      #   token: [String]
+      #     Token created in Splunk for this HTTP Appender
+      #     Mandatory.
+      #
+      #   source_type: [String]
+      #     Optional: Source type to display in Splunk
+      #
+      #   index: [String]
+      #     Optional: Name of a valid index for this message in Splunk.
+      #
+      #   url: [String]
+      #     Valid URL to post to.
+      #       Example: http://example.com
+      #     To enable SSL include https in the URL.
+      #       Example: https://example.com
+      #       verify_mode will default: OpenSSL::SSL::VERIFY_PEER
+      #
+      #   application: [String]
+      #     Name of this application to appear in log messages.
+      #     Default: SemanticLogger.application
+      #
+      #   host: [String]
+      #     Name of this host to appear in log messages.
+      #     Default: SemanticLogger.host
+      #
+      #   compress: [true|false]
+      #     Splunk supports HTTP Compression, enable by default.
+      #     Default: true
+      #
+      #   ssl: [Hash]
+      #     Specific SSL options: For more details see NET::HTTP.start
+      #       ca_file, ca_path, cert, cert_store, ciphers, key, open_timeout, read_timeout, ssl_timeout,
+      #       ssl_version, use_ssl, verify_callback, verify_depth and verify_mode.
+      #
+      #   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: Use the built-in formatter (See: #call)
+      #
+      #   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(token: nil, source_type: nil, index: nil,
+                     url:, compress: true, ssl: {}, open_timeout: 2.0, read_timeout: 1.0, continue_timeout: 1.0,
+                     level: nil, formatter: nil, filter: nil, application: nil, host: nil, &block)
 
-    @source_type = source_type
-    @index       = index
+        @source_type = source_type
+        @index       = index
 
-    super(url:   url, compress: compress, ssl: ssl, read_timeout: read_timeout, open_timeout: open_timeout, continue_timeout: continue_timeout,
-          level: level, formatter: formatter, filter: filter, application: application, host: host, &block)
+        super(url:   url, compress: compress, ssl: ssl, read_timeout: read_timeout, open_timeout: open_timeout, continue_timeout: continue_timeout,
+              level: level, formatter: formatter, filter: filter, application: application, host: host, &block)
 
-    # Put splunk auth token in the header of every HTTP post.
-    @header['Authorization'] = "Splunk #{token}"
-  end
+        # Put splunk auth token in the header of every HTTP post.
+        @header['Authorization'] = "Splunk #{token}"
+      end
 
-  # Returns [String] JSON to send to Splunk.
-  #
-  # For splunk format requirements see:
-  #   http://dev.splunk.com/view/event-collector/SP-CAAAE6P
-  def call(log, logger)
-    h                     = SemanticLogger::Formatters::Raw.new(time_format: :seconds).call(log, logger)
-    message               = {
-      source: logger.application,
-      host:   logger.host,
-      time:   h.delete(:time),
-      event:  h
-    }
-    message[:source_type] = source_type if source_type
-    message[:index]       = index if index
-    message.to_json
+      # Returns [String] JSON to send to Splunk.
+      #
+      # For splunk format requirements see:
+      #   http://dev.splunk.com/view/event-collector/SP-CAAAE6P
+      def call(log, logger)
+        h                     = SemanticLogger::Formatters::Raw.new(time_format: :seconds).call(log, logger)
+        message               = {
+          source: logger.application,
+          host:   logger.host,
+          time:   h.delete(:time),
+          event:  h
+        }
+        message[:source_type] = source_type if source_type
+        message[:index]       = index if index
+        message.to_json
+      end
+    end
   end
-
 end

data/lib/semantic_logger/appender/syslog.rb

@@ -120,7 +120,7 @@ module SemanticLogger
       #     # Change the warn level to LOG_NOTICE level instead of a the default of LOG_WARNING.
       #     SemanticLogger.add_appender(appender: :syslog, level_map: {warn: ::Syslog::LOG_NOTICE})
       def initialize(url: 'syslog://localhost',
-                     facility: ::Syslog::LOG_USER, level_map: SemanticLogger::Formatters::Syslog::LevelMap.new, options: ::Syslog::LOG_PID|::Syslog::LOG_CONS,
+                     facility: ::Syslog::LOG_USER, level_map: SemanticLogger::Formatters::Syslog::LevelMap.new, options: ::Syslog::LOG_PID| ::Syslog::LOG_CONS,
                      tcp_client: {},
                      level: nil, formatter: nil, filter: nil, application: nil, host: nil, &block)
 
@@ -135,10 +135,10 @@ module SemanticLogger
         @server             = 'localhost' if @protocol == :syslog
         @tcp_client_options = tcp_client
 
-        raise "Unknown protocol #{@protocol}!" unless [:syslog, :tcp, :udp].include?(@protocol)
+        raise "Unknown protocol #{@protocol}!" unless %i[syslog tcp udp].include?(@protocol)
 
         # The syslog_protocol gem is required when logging over TCP or UDP.
-        if [:tcp, :udp].include?(@protocol)
+        if %i[tcp udp].include?(@protocol)
           begin
             require 'syslog_protocol'
           rescue LoadError
@@ -196,7 +196,7 @@ module SemanticLogger
 
       # Flush is called by the semantic_logger during shutdown.
       def flush
-        @remote_syslog.flush if @remote_syslog && @remote_syslog.respond_to?(:flush)
+        @remote_syslog.flush if @remote_syslog&.respond_to?(:flush)
       end
 
       # Returns [SemanticLogger::Formatters::Base] default formatter for this Appender depending on the protocal selected
@@ -208,7 +208,6 @@ module SemanticLogger
           SemanticLogger::Formatters::Syslog.new(facility: facility, level_map: level_map)
         end
       end
-
     end
   end
 end

data/lib/semantic_logger/appender/tcp.rb

@@ -181,31 +181,11 @@ module SemanticLogger
       #     connect_retry_interval: 0.1,
       #     connect_retry_count:    5
       #   )
-      def initialize(server: nil, servers: nil, separator: "\n",
-                     policy: :ordered, buffered: true, #keepalive: true,
-                     connect_timeout: 10.0, read_timeout: 60.0, write_timeout: 60.0,
-                     connect_retry_count: 10, retry_count: 3, connect_retry_interval: 0.5, close_on_error: true,
-                     on_connect: nil, proxy_server: nil, ssl: nil,
-                     level: nil, formatter: nil, filter: nil, application: nil, host: nil, &block
-      )
-        @separator = separator
-        @options   = {
-          server:   server,
-          servers:  servers,
-          policy:   policy,
-          buffered: buffered,
-          #keepalive:              keepalive,
-          connect_timeout:        connect_timeout,
-          read_timeout:           read_timeout,
-          write_timeout:          write_timeout,
-          connect_retry_count:    connect_retry_count,
-          retry_count:            retry_count,
-          connect_retry_interval: connect_retry_interval,
-          close_on_error:         close_on_error,
-          on_connect:             on_connect,
-          proxy_server:           proxy_server,
-          ssl:                    ssl
-        }
+      def initialize(separator: "\n",
+                     level: nil, formatter: nil, filter: nil, application: nil, host: nil,
+                     **tcp_client_args, &block)
+        @separator       = separator
+        @tcp_client_args = tcp_client_args
 
         # Use the internal logger so that errors with remote logging are only written locally.
         Net::TCPClient.logger      = logger
@@ -218,7 +198,7 @@ module SemanticLogger
       # After forking an active process call #reopen to re-open the handles to resources.
       def reopen
         close
-        @tcp_client = Net::TCPClient.new(@options)
+        @tcp_client = Net::TCPClient.new(@tcp_client_args)
       end
 
       # Write the log using the specified protocol and server.
@@ -232,12 +212,12 @@ module SemanticLogger
 
       # Flush is called by the semantic_logger during shutdown.
       def flush
-        @tcp_client.flush if @tcp_client
+        @tcp_client&.flush
       end
 
       # Close is called during shutdown, or with reopen
       def close
-        @tcp_client.close if @tcp_client
+        @tcp_client&.close
       end
 
       private
@@ -246,7 +226,6 @@ module SemanticLogger
       def default_formatter
         SemanticLogger::Formatters::Json.new
       end
-
     end
   end
 end

data/lib/semantic_logger/appender/udp.rb

@@ -82,12 +82,12 @@ module SemanticLogger
 
       # Flush is called by the semantic_logger during shutdown.
       def flush
-        @socket.flush if @socket
+        @socket&.flush
       end
 
       # Close is called during shutdown, or with reopen
       def close
-        @socket.close if @socket
+        @socket&.close
       end
 
       private
@@ -96,7 +96,6 @@ module SemanticLogger
       def default_formatter
         SemanticLogger::Formatters::Json.new
       end
-
     end
   end
 end

data/lib/semantic_logger/appender/wrapper.rb

@@ -43,7 +43,8 @@ module SemanticLogger
         @logger = logger
 
         # Check if the custom appender responds to all the log levels. For example Ruby ::Logger
-        if does_not_implement = LEVELS[1..-1].find { |i| !@logger.respond_to?(i) }
+        does_not_implement = LEVELS[1..-1].find { |i| !@logger.respond_to?(i) }
+        if does_not_implement
           raise(ArgumentError, "Supplied logger does not implement:#{does_not_implement}. It must implement all of #{LEVELS[1..-1].inspect}")
         end
 
@@ -63,7 +64,6 @@ module SemanticLogger
       def flush
         @logger.flush if @logger.respond_to?(:flush)
       end
-
     end
   end
 end

data/lib/semantic_logger/base.rb

@@ -23,7 +23,7 @@ module SemanticLogger
         @level_index = nil
         @level       = nil
       else
-        @level_index = SemanticLogger.level_to_index(level)
+        @level_index = SemanticLogger.send(:level_to_index, level)
         @level       = SemanticLogger.send(:index_to_level, @level_index)
       end
     end
@@ -78,7 +78,7 @@ module SemanticLogger
     #    logger.info("Parsing received XML", exc)
     #
     SemanticLogger::LEVELS.each_with_index do |level, index|
-      class_eval <<-EOT, __FILE__, __LINE__ + 1
+      class_eval <<~METHODS, __FILE__, __LINE__ + 1
         def #{level}(message=nil, payload=nil, exception=nil, &block)
           if level_index <= #{index}
             log_internal(:#{level}, #{index}, message, payload, exception, &block)
@@ -107,7 +107,7 @@ module SemanticLogger
             block.call(params) if block
           end
         end
-      EOT
+      METHODS
     end
 
     # Dynamically supply the log level with every measurement call
@@ -115,13 +115,13 @@ module SemanticLogger
       index = SemanticLogger.level_to_index(level)
       if level_index <= index
         measure_internal(level, index, message, params, &block)
-      else
-        block.call(params) if block
+      elsif block
+        yield(params)
       end
     end
 
     # Backward compatibility
-    alias_method :benchmark, :measure
+    alias benchmark measure
 
     # Log a thread backtrace
     def backtrace(thread: Thread.current,
@@ -150,7 +150,11 @@ module SemanticLogger
         message << backtrace.join("\n")
       end
 
-      if log.assign(message: message, backtrace: backtrace, payload: payload, metric: metric, metric_amount: metric_amount) && !filtered?(log)
+      if log.assign(message:       message,
+                    backtrace:     backtrace,
+                    payload:       payload,
+                    metric:        metric,
+                    metric_amount: metric_amount) && !filtered?(log)
         self.log(log)
       else
         false
@@ -196,7 +200,7 @@ module SemanticLogger
     end
 
     # :nodoc:
-    alias_method :with_tags, :tagged
+    alias with_tags tagged
 
     # :nodoc:
     def tags
@@ -243,8 +247,8 @@ module SemanticLogger
     end
 
     # Write log data to underlying data storage
-    def log(log_)
-      raise NotImplementedError.new('Logging Appender must implement #log(log)')
+    def log(_log_)
+      raise NotImplementedError, 'Logging Appender must implement #log(log)'
     end
 
     # Whether this log entry meets the criteria to be logged by this appender.
@@ -298,7 +302,7 @@ module SemanticLogger
       return false if @filter.nil?
 
       if @filter.is_a?(Regexp)
-        (@filter =~ log.name) == nil
+        (@filter =~ log.name).nil?
       elsif @filter.is_a?(Proc)
         @filter.call(log) != true
       else
@@ -317,7 +321,7 @@ module SemanticLogger
       should_log =
         if payload.nil? && exception.nil? && message.is_a?(Hash)
           # Check if someone just logged a hash payload instead of meaning to call semantic logger
-          if message.has_key?(:message) || message.has_key?(:payload) || message.has_key?(:exception) || message.has_key?(:metric)
+          if message.key?(:message) || message.key?(:payload) || message.key?(:exception) || message.key?(:metric)
             log.assign(message)
           else
             log.assign_positional(nil, message, nil, &block)
@@ -343,7 +347,7 @@ module SemanticLogger
       begin
         if block_given?
           result =
-            if silence_level = params[:silence]
+            if (silence_level = params[:silence])
               # In case someone accidentally sets `silence: true` instead of `silence: :error`
               silence_level = :error if silence_level == true
               silence(silence_level) { yield(params) }
@@ -395,8 +399,7 @@ module SemanticLogger
                        min_duration:,
                        metric:,
                        log_exception:,
-                       on_exception_level:,
-                       &block)
+                       on_exception_level:)
 
       # Ignores filter, silence, payload
       exception = nil
@@ -423,6 +426,5 @@ module SemanticLogger
         raise exception if exception
       end
     end
-
   end
 end

data/lib/semantic_logger/concerns/compatibility.rb

@@ -47,7 +47,6 @@ module SemanticLogger
           false
         end
       end
-
     end
   end
 end

data/lib/semantic_logger/core_ext/thread.rb

@@ -1,4 +1,3 @@
-require 'thread'
 class Thread
   undef :name if method_defined? :name
   undef :name= if method_defined? :name=