semantic_logger 4.2.0 → 4.2.1

data/lib/semantic_logger/appender/elasticsearch_http.rb

@@ -10,65 +10,69 @@ require 'date'
 #     appender: :elasticsearch_http,
 #     url:      'http://localhost:9200'
 #   )
-class SemanticLogger::Appender::ElasticsearchHttp < SemanticLogger::Appender::Http
-  attr_accessor :index, :type
+module SemanticLogger
+  module Appender
+    class ElasticsearchHttp < SemanticLogger::Appender::Http
+      attr_accessor :index, :type
 
-  # Create Elasticsearch appender over persistent HTTP(S)
-  #
-  # Parameters:
-  #   index: [String]
-  #     Prefix of the index to store the logs in Elasticsearch.
-  #     The final index appends the date so that indexes are used per day.
-  #       I.e. The final index will look like 'semantic_logger-YYYY.MM.DD'
-  #     Default: 'semantic_logger'
-  #
-  #   type: [String]
-  #     Document type to associate with logs when they are written.
-  #     Default: 'log'
-  #
-  #   level: [:trace | :debug | :info | :warn | :error | :fatal]
-  #     Override the log level for this appender.
-  #     Default: SemanticLogger.default_level
-  #
-  #   formatter: [Object|Proc|Symbol|Hash]
-  #     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.
-  #
-  #   host: [String]
-  #     Name of this host to appear in log messages.
-  #     Default: SemanticLogger.host
-  #
-  #   application: [String]
-  #     Name of this application to appear in log messages.
-  #     Default: SemanticLogger.application
-  def initialize(index: 'semantic_logger', type: 'log',
-                 url: 'http://localhost:9200', compress: false, 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 Elasticsearch appender over persistent HTTP(S)
+      #
+      # Parameters:
+      #   index: [String]
+      #     Prefix of the index to store the logs in Elasticsearch.
+      #     The final index appends the date so that indexes are used per day.
+      #       I.e. The final index will look like 'semantic_logger-YYYY.MM.DD'
+      #     Default: 'semantic_logger'
+      #
+      #   type: [String]
+      #     Document type to associate with logs when they are written.
+      #     Default: 'log'
+      #
+      #   level: [:trace | :debug | :info | :warn | :error | :fatal]
+      #     Override the log level for this appender.
+      #     Default: SemanticLogger.default_level
+      #
+      #   formatter: [Object|Proc|Symbol|Hash]
+      #     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.
+      #
+      #   host: [String]
+      #     Name of this host to appear in log messages.
+      #     Default: SemanticLogger.host
+      #
+      #   application: [String]
+      #     Name of this application to appear in log messages.
+      #     Default: SemanticLogger.application
+      def initialize(index: 'semantic_logger',
+                     type: 'log',
+                     url: 'http://localhost:9200',
+                     **http_args,
+                     &block)
 
-    @index = index
-    @type  = type
-    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)
+        @index = index
+        @type  = type
+        super(url: url, **http_args, &block)
 
-    @request_path = "#{@path.end_with?('/') ? @path : "#{@path}/"}#{@index}-%Y.%m.%d"
-    @logging_path = "#{@request_path}/#{type}"
-  end
+        @request_path = "#{@path.end_with?('/') ? @path : "#{@path}/"}#{@index}-%Y.%m.%d"
+        @logging_path = "#{@request_path}/#{type}"
+      end
 
-  # Log to the index for today.
-  def log(log)
-    post(formatter.call(log, self), log.time.strftime(@logging_path))
-  end
+      # Log to the index for today.
+      def log(log)
+        post(formatter.call(log, self), log.time.strftime(@logging_path))
+      end
 
-  # Deletes all log data captured for a day.
-  def delete_all(date = Date.today)
-    delete(date.strftime(@request_path))
+      # Deletes all log data captured for a day.
+      def delete_all(date = Date.today)
+        delete(date.strftime(@request_path))
+      end
+    end
   end
-
 end

data/lib/semantic_logger/appender/file.rb

@@ -5,7 +5,6 @@
 module SemanticLogger
   module Appender
     class File < SemanticLogger::Subscriber
-
       # Create a File Logger appender instance.
       #
       # Parameters
@@ -81,7 +80,7 @@ module SemanticLogger
       def reopen
         return unless @file_name
 
-        @log = open(@file_name, (::File::WRONLY | ::File::APPEND | ::File::CREAT))
+        @log = ::File.open(@file_name, ::File::WRONLY | ::File::APPEND | ::File::CREAT)
         # Force all log entries to write immediately without buffering
         # Allows multiple processes to write to the same log file simultaneously
         @log.sync = true
@@ -105,7 +104,6 @@ module SemanticLogger
       def flush
         @log.flush if @log.respond_to?(:flush)
       end
-
     end
   end
 end

data/lib/semantic_logger/appender/graylog.rb

@@ -18,116 +18,120 @@ end
 #
 # In the Graylog Web UI search screen, it is recommended to include the following fields:
 #  `duration`, `level`, `message`, `metric`, `name`, `tags
-class SemanticLogger::Appender::Graylog < SemanticLogger::Subscriber
-  # Map Semantic Logger levels to Graylog levels
-  class LevelMap
-    attr_accessor :trace, :debug, :info, :warn, :error, :fatal
-
-    def initialize(trace: GELF::DEBUG, debug: GELF::DEBUG, info: GELF::INFO, warn: GELF::WARN, error: GELF::ERROR, fatal: GELF::FATAL)
-      @trace = trace
-      @debug = debug
-      @info  = info
-      @warn  = warn
-      @error = error
-      @fatal = fatal
+module SemanticLogger
+  module Appender
+    class Graylog < SemanticLogger::Subscriber
+      # Map Semantic Logger levels to Graylog levels
+      class LevelMap
+        attr_accessor :trace, :debug, :info, :warn, :error, :fatal
+
+        def initialize(trace: GELF::DEBUG, debug: GELF::DEBUG, info: GELF::INFO, warn: GELF::WARN, error: GELF::ERROR, fatal: GELF::FATAL)
+          @trace = trace
+          @debug = debug
+          @info  = info
+          @warn  = warn
+          @error = error
+          @fatal = fatal
+        end
+
+        def [](level)
+          public_send(level)
+        end
+      end
+
+      attr_accessor :url, :max_size, :gelf_options, :level_map
+      attr_reader :notifier, :server, :port, :protocol
+
+      # Create Graylog log appender.
+      #
+      # Options:
+      #   url: [String]
+      #     Valid URL to post to.
+      #     Log to UDP Example:
+      #       'udp://localhost:12201'
+      #     Log to TCP Example:
+      #       'tcp://localhost:12201'
+      #     Default: 'udp://localhost:12201'
+      #
+      #   max_size: [String]
+      #     Max udp packet size. Ignored when protocol is :tcp
+      #     Default: "WAN"
+      #
+      #   gelf_options: [Hash]
+      #     Custom gelf options. See Graylog documentation.
+      #
+      #   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.
+      #
+      #   host: [String]
+      #     Name of this host to appear in log messages.
+      #     Default: SemanticLogger.host
+      #
+      #   application: [String]
+      #     Name of this application to appear in log messages.
+      #     Default: SemanticLogger.application
+      def initialize(url: 'udp://localhost:12201', max_size: 'WAN', gelf_options: {}, level_map: LevelMap.new,
+                     level: nil, formatter: nil, filter: nil, application: nil, host: nil, &block)
+
+        @url          = url
+        @max_size     = max_size
+        @gelf_options = gelf_options
+        @level_map    = level_map.is_a?(LevelMap) ? level_map : LevelMap.new(level_map)
+
+        super(level: level, formatter: formatter, filter: filter, application: application, host: host, &block)
+        reopen
+      end
+
+      # Re-open after process fork
+      def reopen
+        uri       = URI.parse(@url)
+        @server   = uri.host
+        @port     = uri.port
+        @protocol = uri.scheme.to_sym
+
+        raise(ArgumentError, "Invalid protocol value: #{@protocol}. Must be :udp or :tcp") unless %i[udp tcp].include?(@protocol)
+
+        gelf_options[:protocol] ||= (@protocol == :tcp ? GELF::Protocol::TCP : GELF::Protocol::UDP)
+        gelf_options[:facility] ||= application
+
+        @notifier                       = GELF::Notifier.new(server, port, max_size, gelf_options)
+        @notifier.collect_file_and_line = false
+      end
+
+      # Returns [Hash] of parameters to send
+      def call(log, logger)
+        h = default_formatter.call(log, logger)
+
+        h[:short_message] = h.delete(:message) || log.exception.message
+        h[:level]         = logger.level_map[log.level]
+        h[:level_str]     = log.level.to_s
+        h[:duration_str]  = h.delete(:duration)
+        h
+      end
+
+      # Forward log messages
+      def log(log)
+        notifier.notify!(formatter.call(log, self))
+        true
+      end
+
+      private
+
+      def default_formatter
+        SemanticLogger::Formatters::Raw.new(time_format: :seconds, time_key: :timestamp)
+      end
     end
-
-    def [](level)
-      public_send(level)
-    end
-  end
-
-  attr_accessor :url, :max_size, :gelf_options, :level_map
-  attr_reader :notifier, :server, :port, :protocol
-
-  # Create Graylog log appender.
-  #
-  # Options:
-  #   url: [String]
-  #     Valid URL to post to.
-  #     Log to UDP Example:
-  #       'udp://localhost:12201'
-  #     Log to TCP Example:
-  #       'tcp://localhost:12201'
-  #     Default: 'udp://localhost:12201'
-  #
-  #   max_size: [String]
-  #     Max udp packet size. Ignored when protocol is :tcp
-  #     Default: "WAN"
-  #
-  #   gelf_options: [Hash]
-  #     Custom gelf options. See Graylog documentation.
-  #
-  #   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.
-  #
-  #   host: [String]
-  #     Name of this host to appear in log messages.
-  #     Default: SemanticLogger.host
-  #
-  #   application: [String]
-  #     Name of this application to appear in log messages.
-  #     Default: SemanticLogger.application
-  def initialize(url: 'udp://localhost:12201', max_size: 'WAN', gelf_options: {}, level_map: LevelMap.new,
-                 level: nil, formatter: nil, filter: nil, application: nil, host: nil, &block)
-
-    @url          = url
-    @max_size     = max_size
-    @gelf_options = gelf_options
-    @level_map    = level_map.is_a?(LevelMap) ? level_map : LevelMap.new(level_map)
-
-    super(level: level, formatter: formatter, filter: filter, application: application, host: host, &block)
-    reopen
-  end
-
-  # Re-open after process fork
-  def reopen
-    uri       = URI.parse(@url)
-    @server   = uri.host
-    @port     = uri.port
-    @protocol = uri.scheme.to_sym
-
-    raise(ArgumentError, "Invalid protocol value: #{@protocol}. Must be :udp or :tcp") unless [:udp, :tcp].include?(@protocol)
-
-    gelf_options[:protocol] ||= (@protocol == :tcp ? GELF::Protocol::TCP : GELF::Protocol::UDP)
-    gelf_options[:facility] ||= application
-
-    @notifier                       = GELF::Notifier.new(server, port, max_size, gelf_options)
-    @notifier.collect_file_and_line = false
-  end
-
-  # Returns [Hash] of parameters to send
-  def call(log, logger)
-    h = default_formatter.call(log, logger)
-
-    h[:short_message] = h.delete(:message) || log.exception.message
-    h[:level]         = logger.level_map[log.level]
-    h[:level_str]     = log.level.to_s
-    h[:duration_str]  = h.delete(:duration)
-    h
-  end
-
-  # Forward log messages
-  def log(log)
-    notifier.notify!(formatter.call(log, self))
-    true
-  end
-
-  private
-
-  def default_formatter
-    SemanticLogger::Formatters::Raw.new(time_format: :seconds, time_key: :timestamp)
   end
 end

data/lib/semantic_logger/appender/honeybadger.rb

@@ -9,59 +9,62 @@ end
 # Example:
 #   SemanticLogger.add_appender(appender: :honeybadger)
 #
-class SemanticLogger::Appender::Honeybadger < SemanticLogger::Subscriber
-  # Honeybadger Appender
-  #
-  # Parameters
-  #   level: [:trace | :debug | :info | :warn | :error | :fatal]
-  #     Override the log level for this appender.
-  #     Default: :error
-  #
-  #   formatter: [Object|Proc|Symbol|Hash]
-  #     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.
-  #
-  #   host: [String]
-  #     Name of this host to appear in log messages.
-  #     Default: SemanticLogger.host
-  #
-  #   application: [String]
-  #     Name of this application to appear in log messages.
-  #     Default: SemanticLogger.application
-  def initialize(level: :error, formatter: nil, filter: nil, application: nil, host: nil, &block)
-    super(level: level, formatter: formatter, filter: filter, application: application, host: host, &block)
-  end
+module SemanticLogger
+  module Appender
+    class Honeybadger < SemanticLogger::Subscriber
+      # Honeybadger Appender
+      #
+      # Parameters
+      #   level: [:trace | :debug | :info | :warn | :error | :fatal]
+      #     Override the log level for this appender.
+      #     Default: :error
+      #
+      #   formatter: [Object|Proc|Symbol|Hash]
+      #     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.
+      #
+      #   host: [String]
+      #     Name of this host to appear in log messages.
+      #     Default: SemanticLogger.host
+      #
+      #   application: [String]
+      #     Name of this application to appear in log messages.
+      #     Default: SemanticLogger.application
+      def initialize(level: :error, formatter: nil, filter: nil, application: nil, host: nil, &block)
+        super(level: level, formatter: formatter, filter: filter, application: application, host: host, &block)
+      end
 
-  # Send an error notification to honeybadger
-  def log(log)
-    context = formatter.call(log, self)
-    if log.exception
-      context.delete(:exception)
-      Honeybadger.notify(log.exception, context)
-    else
-      message             = {
-        error_class:   context.delete(:name),
-        error_message: context.delete(:message),
-        context:       context
-      }
-      message[:backtrace] = log.backtrace if log.backtrace
-      Honeybadger.notify(message)
-    end
-    true
-  end
+      # Send an error notification to honeybadger
+      def log(log)
+        context = formatter.call(log, self)
+        if log.exception
+          context.delete(:exception)
+          ::Honeybadger.notify(log.exception, context)
+        else
+          message             = {
+            error_class:   context.delete(:name),
+            error_message: context.delete(:message),
+            context:       context
+          }
+          message[:backtrace] = log.backtrace if log.backtrace
+          ::Honeybadger.notify(message)
+        end
+        true
+      end
 
-  private
+      private
 
-  # Use Raw Formatter by default
-  def default_formatter
-    SemanticLogger::Formatters::Raw.new
+      # Use Raw Formatter by default
+      def default_formatter
+        SemanticLogger::Formatters::Raw.new
+      end
+    end
   end
-
 end