semantic_logger 3.2.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93bacb9e50c85d3c705135737294436245cf1260
-  data.tar.gz: 76f4ea34ce009dec4d498c738a149ca59a3d952f
+  metadata.gz: 1332704e0667fa360e4b9a632e861fa75966f3e0
+  data.tar.gz: ad079a8ed4ce5fb1802594e845f38a523c0a1a09
 SHA512:
-  metadata.gz: 0658a00169d903ef6605fa5e5a29bc50f84e3a8381a6c0e9143308885bc8764ca3ba41e3691526b690d220f4eb10f6b13f4f926bf74ea4d90cf6c97b69775cf4
-  data.tar.gz: 3d2554eefc189f28a9bc1411a4b360583bca3342e531ba9f7cfa0a7fcbcc7f37012f97e60ff82eb39dcdb495a518443b09fa246ea8387a60853be618b909d0e2
+  metadata.gz: 1c33e421728430664dba299821ceb31816dda9068c94f1cefbaecd3ce64b9b4cd9be16f6109bbd9ac52fbac38e935e46d4935f09088c7a1e508c4625704ad4da
+  data.tar.gz: c8199f834fdeee217a50ff07c682e3954c7b42bc2d48514af3f9fbbee698358eb59e5fd834d34b57f521437c8a6c785a575333abb4640a0814f043bdd386574b

data/README.md

@@ -38,7 +38,7 @@ instead of Semantic Logger directly since it will automatically replace the Rail
 ## Supports
 
 Semantic Logger is tested and supported on the following Ruby platforms:
-- Ruby 2.0 and above
+- Ruby 2.1 and above
 - JRuby 1.7 and above
 - JRuby 9.0 and above
 - Rubinius 2.5 and above

data/lib/semantic_logger.rb

@@ -10,9 +10,22 @@ module SemanticLogger
   autoload :Log,                'semantic_logger/log'
   autoload :Logger,             'semantic_logger/logger'
   autoload :Loggable,           'semantic_logger/loggable'
+  autoload :Subscriber,         'semantic_logger/subscriber'
 
   module Appender
-    autoload :Base,             'semantic_logger/appender/base'
+    # DEPRECATED, use SemanticLogger::AnsiColors
+    AnsiColors = SemanticLogger::AnsiColors
+
+    # DEPRECATED: use SemanticLogger::Formatters::Color.new
+    def self.colorized_formatter
+      SemanticLogger::Formatters::Color.new
+    end
+
+    # DEPRECATED: use SemanticLogger::Formatters::Json.new
+    def self.json_formatter
+      SemanticLogger::Formatters::Json.new
+    end
+
     autoload :Bugsnag,          'semantic_logger/appender/bugsnag'
     autoload :Elasticsearch,    'semantic_logger/appender/elasticsearch'
     autoload :File,             'semantic_logger/appender/file'
@@ -24,6 +37,8 @@ module SemanticLogger
     autoload :Splunk,           'semantic_logger/appender/splunk'
     autoload :SplunkHttp,       'semantic_logger/appender/splunk_http'
     autoload :Syslog,           'semantic_logger/appender/syslog'
+    autoload :Tcp,              'semantic_logger/appender/tcp'
+    autoload :Udp,              'semantic_logger/appender/udp'
     autoload :Wrapper,          'semantic_logger/appender/wrapper'
   end
 
@@ -32,14 +47,18 @@ module SemanticLogger
   end
 
   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 :Syslog,           'semantic_logger/formatters/syslog'
   end
 
   module Metrics
     autoload :NewRelic,         'semantic_logger/metrics/new_relic'
     autoload :Statsd,           'semantic_logger/metrics/statsd'
+    autoload :Udp,              'semantic_logger/metrics/udp'
   end
 
   if defined?(JRuby)
@@ -50,8 +69,9 @@ module SemanticLogger
 end
 # @formatter:on
 
-# Flush all appenders at exit, waiting for outstanding messages on the queue
+# Close and flush all appenders at exit, waiting for outstanding messages on the queue
 # to be written first
 at_exit do
+  # Cannot call #close since test frameworks use at_exit to run loaded tests
   SemanticLogger.flush
 end

data/lib/semantic_logger/appender/bugsnag.rb

@@ -9,7 +9,7 @@ end
 # Example:
 #   SemanticLogger.add_appender(appender: :bugsnag)
 #
-class SemanticLogger::Appender::Bugsnag < SemanticLogger::Appender::Base
+class SemanticLogger::Appender::Bugsnag < SemanticLogger::Subscriber
   # Create Bugsnag Error / Exception Appender
   #
   # Parameters
@@ -43,7 +43,7 @@ class SemanticLogger::Appender::Bugsnag < SemanticLogger::Appender::Base
 
   # Returns [Hash] of parameters to send to Bugsnag.
   def call(log, logger)
-    h            = log.to_h
+    h            = log.to_h(host, application)
     h[:severity] = log_level(log)
     h.delete(:time)
     h.delete(:exception)

data/lib/semantic_logger/appender/elasticsearch.rb

@@ -26,7 +26,7 @@ class SemanticLogger::Appender::Elasticsearch < SemanticLogger::Appender::Http
   #     Override the log level for this appender.
   #     Default: SemanticLogger.default_level
   #
-  #   formatter: [Object|Proc]
+  #   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)
@@ -36,6 +36,14 @@ class SemanticLogger::Appender::Elasticsearch < SemanticLogger::Appender::Http
   #     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(options, &block)
     options       = options.dup
     @index        = options.delete(:index) || 'semantic_logger'

data/lib/semantic_logger/appender/file.rb

@@ -4,7 +4,7 @@
 #
 module SemanticLogger
   module Appender
-    class File < SemanticLogger::Appender::Base
+    class File < SemanticLogger::Subscriber
 
       # Create a File Logger appender instance.
       #

data/lib/semantic_logger/appender/graylog.rb

@@ -18,7 +18,7 @@ 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::Appender::Base
+class SemanticLogger::Appender::Graylog < SemanticLogger::Subscriber
   # Map Semantic Logger levels to Graylog levels
   LEVEL_MAP = {
     fatal: GELF::FATAL,
@@ -42,14 +42,6 @@ class SemanticLogger::Appender::Graylog < SemanticLogger::Appender::Base
   #       'tcp://localhost:12201'
   #     Default: 'udp://localhost:12201'
   #
-  #   host: [String]
-  #     Name of this host to appear in log messages.
-  #     Default: Socket.gethostname
-  #
-  #   application: [String]
-  #     Name of this application to appear in log messages.
-  #     Default: SemanticLogger.application
-  #
   #   max_size: [String]
   #     Max udp packet size. Ignored when protocol is :tcp
   #     Default: "WAN"
@@ -68,10 +60,18 @@ class SemanticLogger::Appender::Graylog < SemanticLogger::Appender::Base
   #     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(options = {}, &block)
-    @gelf_options = options.dup
-    @url          = @gelf_options.delete(:url) || 'udp://localhost:12201'
-    @max_size     = @gelf_options.delete(:max_size) || 'WAN'
+    options   = options.dup
+    @url      = options.delete(:url) || 'udp://localhost:12201'
+    @max_size = options.delete(:max_size) || 'WAN'
 
     uri      = URI.parse(@url)
     @server  = uri.host
@@ -80,28 +80,25 @@ class SemanticLogger::Appender::Graylog < SemanticLogger::Appender::Base
 
     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] = @gelf_options.delete(:application) || SemanticLogger.application
+    options[:protocol] = protocol == :tcp ? GELF::Protocol::TCP : GELF::Protocol::UDP
 
-    options = {
-      level:     @gelf_options.delete(:level),
-      filter:    @gelf_options.delete(:filter),
-      formatter: @gelf_options.delete(:formatter)
-    }
-    reopen
+    @gelf_options = options
+    options       = extract_subscriber_options!(options)
 
     super(options, &block)
+    reopen
   end
 
   # Re-open after process fork
   def reopen
+    @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 = log.to_h
+    h = log.to_h(host, application)
     h.delete(:time)
     h[:timestamp]     = log.time.utc.to_f
     h[:level]         = logger.map_level(log)

data/lib/semantic_logger/appender/honeybadger.rb

@@ -9,7 +9,7 @@ end
 # Example:
 #   SemanticLogger.add_appender(appender: :honeybadger)
 #
-class SemanticLogger::Appender::Honeybadger < SemanticLogger::Appender::Base
+class SemanticLogger::Appender::Honeybadger < SemanticLogger::Subscriber
   # Create Appender
   #
   # Parameters
@@ -17,7 +17,7 @@ class SemanticLogger::Appender::Honeybadger < SemanticLogger::Appender::Base
   #     Override the log level for this appender.
   #     Default: :error
   #
-  #   formatter: [Object|Proc]
+  #   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)
@@ -27,30 +27,45 @@ class SemanticLogger::Appender::Honeybadger < SemanticLogger::Appender::Base
   #     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(options = {}, &block)
-    options  = {level: options} unless options.is_a?(Hash)
-    @options = options.dup
-    level    = @options.delete(:level) || :error
-
-    super(level, &block)
+    options         = options.is_a?(Hash) ? options.dup : {level: options}
+    options[:level] ||= :error
+    super(options, &block)
   end
 
   # Send an error notification to honeybadger
   def log(log)
     return false unless should_log?(log)
 
+    context = formatter.call(log, self)
     if log.exception
-      Honeybadger.notify(log.exception, log.to_h)
+      context.delete(:exception)
+      Honeybadger.notify(log.exception, context)
     else
       message = {
-        error_class:   log.name,
-        error_message: log.message,
-        backtrace:     log.backtrace,
-        context:       log.to_h,
+        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
+
+  # Use Raw Formatter by default
+  def default_formatter
+    SemanticLogger::Formatters::Raw.new
+  end
+
 end

data/lib/semantic_logger/appender/http.rb

@@ -15,7 +15,7 @@ require 'json'
 #     appender: :http,
 #     url:      'http://localhost:8088/path'
 #   )
-class SemanticLogger::Appender::Http < SemanticLogger::Appender::Base
+class SemanticLogger::Appender::Http < SemanticLogger::Subscriber
   attr_accessor :username, :application, :host, :compress, :header,
     :open_timeout, :read_timeout, :continue_timeout
   attr_reader :http, :url, :server, :port, :path, :ssl_options
@@ -83,22 +83,19 @@ class SemanticLogger::Appender::Http < SemanticLogger::Appender::Base
     @ssl_options      = options.delete(:ssl)
     @username         = options.delete(:username)
     @password         = options.delete(:password)
-    @application      = options.delete(:application) || 'Semantic Logger'
-    @host             = options.delete(:host) || SemanticLogger.host
     @compress         = options.delete(:compress) || false
     @open_timeout     = options.delete(:open_timeout) || 2.0
     @read_timeout     = options.delete(:read_timeout) || 1.0
     @continue_timeout = options.delete(:continue_timeout) || 1.0
 
-    unless options.has_key?(:formatter)
-      options[:formatter] = block || (respond_to?(:call) ? self : SemanticLogger::Formatters::Json.new)
-    end
-
     raise(ArgumentError, 'Missing mandatory parameter :url') unless @url
 
     @header                     = {
       'Accept'       => 'application/json',
-      'Content-Type' => 'application/json'
+      'Content-Type' => 'application/json',
+      # On Ruby v2.0 and greater, Net::HTTP.new already uses a persistent connection if the server allows it
+      'Connection'   => 'keep-alive',
+      'Keep-Alive'   => '300'
     }
     @header['Content-Encoding'] = 'gzip' if @compress
 
@@ -119,16 +116,21 @@ class SemanticLogger::Appender::Http < SemanticLogger::Appender::Base
     else
       @port ||= HTTP.http_default_port
     end
-
-    reopen
+    @http = nil
 
     # Pass on the level and custom formatter if supplied
     super(options)
+    reopen
   end
 
   # Re-open after process fork
   def reopen
-    # On Ruby v2.0 and greater, Net::HTTP.new uses a persistent connection if the server allows it
+    # Close open connection if any
+    begin
+      @http.finish if @http
+    rescue IOError
+    end
+
     @http = Net::HTTP.new(server, port)
 
     if @ssl_options
@@ -142,6 +144,7 @@ class SemanticLogger::Appender::Http < SemanticLogger::Appender::Base
     @http.open_timeout     = @open_timeout
     @http.read_timeout     = @read_timeout
     @http.continue_timeout = @continue_timeout
+    @http.start
   end
 
   # Forward log messages to HTTP Server
@@ -153,6 +156,11 @@ class SemanticLogger::Appender::Http < SemanticLogger::Appender::Base
 
   private
 
+  # Use JSON Formatter by default
+  def default_formatter
+    SemanticLogger::Formatters::Json.new
+  end
+
   def compress_data(data)
     str = StringIO.new
     gz  = Zlib::GzipWriter.new(str)

data/lib/semantic_logger/appender/mongodb.rb

@@ -48,9 +48,9 @@ module SemanticLogger
     #
     #   # Log some messages
     #   logger.info 'This message is written to mongo as a document'
-    class MongoDB < SemanticLogger::Appender::Base
+    class MongoDB < SemanticLogger::Subscriber
       attr_reader :db, :collection_name, :collection
-      attr_accessor :host, :write_concern, :application
+      attr_accessor :write_concern
 
       # Create a MongoDB Appender instance
       #
@@ -67,14 +67,6 @@ module SemanticLogger
       #     see: http://docs.mongodb.org/manual/reference/write-concern/
       #     Default: 0
       #
-      #   host: [String]
-      #     host name to include in the document logged to Mongo
-      #     Default: SemanticLogger.host_name
-      #
-      #   application: [String]
-      #     Name of the application to include in the document written to mongo
-      #     Default: nil (None)
-      #
       #   collection_size: [Integer]
       #     The size of the MongoDB capped collection to create in bytes
       #     Default: 1 GB
@@ -91,7 +83,7 @@ module SemanticLogger
       #     Override the log level for this appender.
       #     Default: SemanticLogger.default_level
       #
-      #   formatter: [Object|Proc]
+      #   formatter: [Object|Proc|Symbol]
       #     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)
@@ -101,25 +93,30 @@ module SemanticLogger
       #     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(options = {}, &block)
-        options             = options.dup
-        @db                 = options.delete(:db) || raise('Missing mandatory parameter :db')
-        @collection_name    = options.delete(:collection_name) || 'semantic_logger'
-        @host               = options.delete(:host) || options.delete(:host_name) || SemanticLogger.host
-        @write_concern      = options.delete(:write_concern) || 0
-        @application        = options.delete(:application) || SemanticLogger.application
+        options          = options.dup
+        @db              = options.delete(:db) || raise('Missing mandatory parameter :db')
+        @collection_name = options.delete(:collection_name) || 'semantic_logger'
+        @write_concern   = options.delete(:write_concern) || 0
 
         # Create a collection that will hold the lesser of 1GB space or 10K documents
-        @collection_size    = options.delete(:collection_size) || 1024**3
-        @collection_max     = options.delete(:collection_max)
-
-        reopen
+        @collection_size = options.delete(:collection_size) || 1024**3
+        @collection_max  = options.delete(:collection_max)
 
         # Create the collection and necessary indexes
         create_indexes
 
         # Set the log level and formatter
         super(options, &block)
+        reopen
       end
 
       # After forking an active process call #reopen to re-open
@@ -160,15 +157,6 @@ module SemanticLogger
         db.get_last_error
       end
 
-      # Default log formatter
-      #  Replace this formatter by supplying a Block to the initializer
-      def call(log, logger)
-        h               = log.to_h
-        h[:host]        = host
-        h[:application] = application
-        h
-      end
-
       # Log the message to MongoDB
       def log(log)
         return false unless should_log?(log)
@@ -178,6 +166,11 @@ module SemanticLogger
         true
       end
 
+      private
+
+      def default_formatter
+        SemanticLogger::Formatters::Raw.new
+      end
     end
   end
 end