semantic_logger 2.15.0 → 2.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdbe70622c40bdf8a20fc8279e22c21085d8279a
-  data.tar.gz: f66fcd67a69b00d452e1fa3c978e59fb6d7bf591
+  metadata.gz: 6d4e0a0bfded65004b557ad08aa6729d70387841
+  data.tar.gz: 9c8f8584584afb4d29c71467f09ab0d87c61fd4e
 SHA512:
-  metadata.gz: 17f5b1e431295b2ca8c11df91be4b0c0e3b0a6e05a8b688d27ddf56a6b88c6484f15e2a03b692d1c49e15cb0ff2243a727d2ed66ead6fb4533029473c117bc40
-  data.tar.gz: 7fbe8f81f9122e6ffe4271314216b70aab44480bfb2a220d3c60a3534e9f55a55a9e2f80ec2f2645de2e4663332a4675d30e4cedff8543f95504fcbd613ab9a7
+  metadata.gz: 5dea37b7135aba5a357aa012ff879345d521a5cc25d45f26b14c1292ab2716c644ebfd29b6ed7eaca6aba109c1b945501c43698a9a7c20c9919c85eb8cfeaa12
+  data.tar.gz: a061d2c0989485fc5cba5dafc5d96d9d39376805c3d509046c05a46e0dc1c8be4d17d728be939d3cd94315971be1817b95da8baa0b2e223adc156d4de14bdbfc

data/README.md

@@ -1,15 +1,15 @@
-semantic_logger [![Build Status](https://secure.travis-ci.org/reidmorrison/semantic_logger.png?branch=master)](http://travis-ci.org/reidmorrison/semantic_logger) ![](http://ruby-gem-downloads-badge.herokuapp.com/semantic_logger?type=total)
-===============
+# semantic_logger
+![](https://img.shields.io/gem/v/semantic_logger.svg) ![](https://img.shields.io/travis/rocketjob/semantic_logger.svg) ![](https://img.shields.io/gem/dt/semantic_logger.svg) ![](https://img.shields.io/badge/status-production%20ready-blue.svg)
 
 Low latency, high throughput, enterprise-scale logging system for Ruby
 
-* http://github.com/reidmorrison/semantic_logger
+* http://github.com/rocketjob/semantic_logger
 
 ## Documentation
 
-[Semantic Logger Guide](http://reidmorrison.github.io/semantic_logger)
+[Semantic Logger Guide](http://rocketjob.github.io/semantic_logger)
 
-API Documentation: [![semantic_logger API Documentation](https://www.omniref.com/ruby/gems/semantic_logger.png)](https://www.omniref.com/ruby/gems/semantic_logger)
+[Reference Documentation](http://www.rubydoc.info/gems/semantic_logger/)
 
 ## Supports
 
@@ -30,12 +30,17 @@ the log information is being saved. Semantic Logger avoids this slowdown by push
 log events to an in-memory queue that is serviced by a separate thread that only
 handles saving log information to multiple destinations at the same time.
 
-## Dependencies
+## Rails
+
+When running Rails, use [rails_semantic_logger](http://github.com/rocketjob/rails_semantic_logger)
+instead of Semantic Logger directly since it will automatically replace the Rails default logger with Semantic Logger.
+
+## Supports
 
 Semantic Logger is tested and supported on the following Ruby platforms:
 - Ruby 2.0 and above
 - JRuby 1.7 and above
-- JRuby 9.0.0.0 and above
+- JRuby 9.0 and above
 - Rubinius 2.5 and above
 
 The following gems are only required when their corresponding appenders are being used,
@@ -51,48 +56,12 @@ and are therefore not automatically included by this gem:
 
     gem install semantic_logger
 
-## Upgrade Notes:
-
-### V2.10
-
-Ruby 1.8 is no longer supported, see [Ruby 1.8.7 EOL](https://www.ruby-lang.org/en/news/2014/07/01/eol-for-1-8-7-and-1-9-2/)
-
-### V2.0
-
-Rails logging is no longer automatically replaced when including SemanticLogger.
-Include the [rails_semantic_logger](http://github.com/reidmorrison/rails_semantic_logger)
-gem to replace the Rails default logger with SemanticLogger
-
-## Meta
-
-* Code: `git clone git://github.com/reidmorrison/semantic_logger.git`
-* Home: <https://github.com/reidmorrison/semantic_logger>
-* Bugs: <http://github.com/reidmorrison/semantic_logger/issues>
-* Gems: <http://rubygems.org/gems/semantic_logger>
-
-This project uses [Semantic Versioning](http://semver.org/).
-
 ## Author
 
-[Reid Morrison](https://github.com/reidmorrison) :: @reidmorrison
-
-## Contributors
+[Reid Morrison](https://github.com/reidmorrison)
 
-* [Marc Bellingrath](https://github.com/marc)
-* [Andrew Medeiros](https://github.com/amedeiros)
+[Contributors](https://github.com/rocketjob/semantic_logger/graphs/contributors)
 
-## License
+## Versioning
 
-Copyright 2012, 2013, 2014, 2015 Reid Morrison
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+This project uses [Semantic Versioning](http://semver.org/).

data/Rakefile

@@ -5,17 +5,17 @@ $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 require 'semantic_logger/version'
 
 task :gem do
-  system "gem build semantic_logger.gemspec"
+  system 'gem build semantic_logger.gemspec'
 end
 
-task :publish => :gem do
+task publish: :gem do
   system "git tag -a v#{SemanticLogger::VERSION} -m 'Tagging #{SemanticLogger::VERSION}'"
-  system "git push --tags"
+  system 'git push --tags'
   system "gem push semantic_logger-#{SemanticLogger::VERSION}.gem"
   system "rm semantic_logger-#{SemanticLogger::VERSION}.gem"
 end
 
-desc "Run Test Suite"
+desc 'Run Test Suite'
 task :test do
   Rake::TestTask.new(:functional) do |t|
     t.test_files = FileList['test/*_test.rb']
@@ -25,4 +25,4 @@ task :test do
   Rake::Task['functional'].invoke
 end
 
-task :default => :test
+task default: :test

data/lib/semantic_logger.rb

@@ -2,6 +2,7 @@ require 'semantic_logger/core_ext/thread'
 require 'semantic_logger/version'
 require 'semantic_logger/semantic_logger'
 
+# @formatter:off
 module SemanticLogger
   autoload :Base,               'semantic_logger/base'
   autoload :Logger,             'semantic_logger/logger'
@@ -18,6 +19,7 @@ module SemanticLogger
     autoload :Splunk,   'semantic_logger/appender/splunk'
     autoload :Bugsnag,   'semantic_logger/appender/bugsnag'
   end
+  # @formatter:on
 
   if defined?(JRuby)
     module JRuby

data/lib/semantic_logger/appender/base.rb

@@ -32,11 +32,11 @@ module SemanticLogger
       #    2011-07-19 14:36:15.660 D [1149:ScriptThreadProcess] Rails -- Hello World
       def default_formatter
         Proc.new do |log|
-          tags = log.tags.collect { |tag| "[#{tag}]" }.join(" ") + " " if log.tags && (log.tags.size > 0)
+          tags = log.tags.collect { |tag| "[#{tag}]" }.join(' ') + ' ' if log.tags && (log.tags.size > 0)
 
           message = log.message.to_s.dup
-          message << " -- " << log.payload.inspect if log.payload
-          message << " -- Exception: " << "#{log.exception.class}: #{log.exception.message}\n#{(log.exception.backtrace || []).join("\n")}" if log.exception
+          message << ' -- ' << log.payload.inspect unless log.payload.nil? || log.payload.empty?
+          message << ' -- Exception: ' << "#{log.exception.class}: #{log.exception.message}\n#{(log.exception.backtrace || []).join("\n")}" if log.exception
 
           duration_str = log.duration ? "(#{'%.1f' % log.duration}ms) " : ''
 
@@ -52,26 +52,31 @@ module SemanticLogger
       def self.colorized_formatter
         Proc.new do |log|
           colors = SemanticLogger::Appender::AnsiColors
-          tags = log.tags.collect { |tag| "[#{colors::CYAN}#{tag}#{colors::CLEAR}]" }.join(' ') + ' ' if log.tags && (log.tags.size > 0)
+          tags   = log.tags.collect { |tag| "[#{colors::CYAN}#{tag}#{colors::CLEAR}]" }.join(' ') + ' ' if log.tags && (log.tags.size > 0)
 
           message = log.message.to_s.dup
-          message << " -- " << log.payload.inspect if log.payload
-          message << " -- Exception: " << "#{colors::BOLD}#{log.exception.class}: #{log.exception.message}#{colors::CLEAR}\n#{(log.exception.backtrace || []).join("\n")}" if log.exception
+          unless log.payload.nil? || log.payload.empty?
+            payload = log.payload
+            payload = (defined?(AwesomePrint) && payload.respond_to?(:ai)) ? payload.ai(multiline: false) : payload.inspect
+            message << ' -- ' << payload
+          end
+          message << ' -- Exception: ' << "#{colors::BOLD}#{log.exception.class}: #{log.exception.message}#{colors::CLEAR}\n#{(log.exception.backtrace || []).join("\n")}" if log.exception
 
           duration_str = log.duration ? "(#{colors::BOLD}#{'%.1f' % log.duration}ms#{colors::CLEAR}) " : ''
 
-          level_color = case log.level
-          when :trace
-            colors::MAGENTA
-          when :debug
-            colors::GREEN
-          when :info
-            colors::CYAN
-          when :warn
-            colors::BOLD
-          when :error, :fatal
-            colors::RED
-          end
+          level_color =
+            case log.level
+            when :trace
+              colors::MAGENTA
+            when :debug
+              colors::GREEN
+            when :info
+              colors::CYAN
+            when :warn
+              colors::BOLD
+            when :error, :fatal
+              colors::RED
+            end
 
           "#{SemanticLogger::Appender::Base.formatted_time(log.time)} #{level_color}#{colors::BOLD}#{log.level.to_s[0..0].upcase}#{colors::CLEAR} [#{$$}:#{'%.30s' % log.thread_name}] #{tags}#{duration_str}#{level_color}#{log.name}#{colors::CLEAR} -- #{message}"
         end
@@ -135,4 +140,4 @@ module SemanticLogger
 
     end
   end
-end
+end

data/lib/semantic_logger/appender/bugsnag.rb

@@ -54,7 +54,7 @@ class SemanticLogger::Appender::Bugsnag < SemanticLogger::Appender::Base
   # Returns [Hash] of parameters to send to Bugsnag.
   def default_formatter
     proc do |log|
-      h = { severity: log_level(log), tags: log.tags }
+      h = {severity: log_level(log), tags: log.tags, class: log.name}
       h.merge!(log.payload) if log.payload
       h
     end

data/lib/semantic_logger/appender/file.rb

@@ -40,13 +40,14 @@ module SemanticLogger
       #    logger.info 'Hello World'
       #
       def initialize(filename, level=nil, filter=nil, &block)
-        raise "filename cannot be null when initializing the SemanticLogging::Appender::File" unless filename
-        @log = if filename.respond_to?(:write) and filename.respond_to?(:close)
-          filename
-        else
-          @filename = filename
-          reopen
-        end
+        raise 'filename cannot be null when initializing the SemanticLogging::Appender::File' unless filename
+        @log =
+          if filename.respond_to?(:write) and filename.respond_to?(:close)
+            filename
+          else
+            @filename = filename
+            reopen
+          end
 
         # Set the log level and formatter if supplied
         super(level, filter, &block)
@@ -60,7 +61,7 @@ module SemanticLogger
       def reopen
         return unless @filename
 
-        @log = open(@filename, (::File::WRONLY | ::File::APPEND | ::File::CREAT))
+        @log      = open(@filename, (::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

data/lib/semantic_logger/appender/mongodb.rb

@@ -35,7 +35,7 @@ module SemanticLogger
 
       # Create a MongoDB Appender instance
       #
-      #   SemanticLogger::Appender::MongoDB.new(:db => Mongo::Connection.new['database'])
+      #   SemanticLogger::Appender::MongoDB.new(db: Mongo::Connection.new['database'])
       #
       # Parameters:
       # :db [Mongo::Database]
@@ -116,7 +116,7 @@ module SemanticLogger
       #
       # Creates an index based on tags to support faster lookups
       def create_indexes
-        options = {:capped => true, :size => @collection_size}
+        options       = {capped: true, size: @collection_size}
         options[:max] = @collection_max if @collection_max
         db.create_collection(collection_name, options)
         db[@collection_name].ensure_index('tags')
@@ -141,14 +141,14 @@ module SemanticLogger
       #  Replace this formatter by supplying a Block to the initializer
       def default_formatter
         Proc.new do |log|
-          document = {
-            :time        => log.time,
-            :host_name   => host_name,
-            :pid         => $$,
-            :thread_name => log.thread_name,
-            :name        => log.name,
-            :level       => log.level,
-            :level_index => log.level_index,
+          document               = {
+            time:        log.time,
+            host_name:   host_name,
+            pid:         $$,
+            thread_name: log.thread_name,
+            name:        log.name,
+            level:       log.level,
+            level_index: log.level_index,
           }
           document[:application] = application if application
           document[:message]     = self.class.strip_colorizing(log.message) if log.message
@@ -156,9 +156,9 @@ module SemanticLogger
           document[:tags]        = log.tags if log.tags && (log.tags.size > 0)
           document[:payload]     = log.payload if log.payload
           document[:exception]   = {
-            :name        => log.exception.class.name,
-            :message     => log.exception.message,
-            :stack_trace => log.exception.backtrace
+            name:        log.exception.class.name,
+            message:     log.exception.message,
+            stack_trace: log.exception.backtrace
           } if log.exception
           document
         end
@@ -191,4 +191,4 @@ module SemanticLogger
 
     end
   end
-end
+end

data/lib/semantic_logger/appender/new_relic.rb

@@ -63,7 +63,7 @@ class SemanticLogger::Appender::NewRelic < SemanticLogger::Appender::Base
   # Allow the level for this appender to be overwritten
   #   Default: :error
   #   Note: Not recommended to set the log level to :info, :debug, or :trace as that would flood NewRelic with Error notices
-  def initialize(level=:error,&block)
+  def initialize(level=:error, &block)
     # Pass on the level and custom formatter if supplied
     super(level, &block)
   end
@@ -77,16 +77,16 @@ class SemanticLogger::Appender::NewRelic < SemanticLogger::Appender::Base
   def default_formatter
     Proc.new do |log|
       short_message = self.class.first_non_empty_line(log.message)
-      metric = log.metric || "#{log.name}/#{short_message}"
+      metric        = log.metric || "#{log.name}/#{short_message}"
 
-      custom_params = { :thread_name => log.thread_name }
+      custom_params            = {thread_name: log.thread_name}
       # Only show the message under custom attributes if the error message uses an exception or shortened message (first non-empty line).
-      custom_params[:message]  = log.message  if log.message && (log.exception || log.message != short_message)
+      custom_params[:message]  = log.message if log.message && (log.exception || log.message != short_message)
       custom_params[:duration] = "#{log.duration} ms" if log.duration
-      custom_params[:payload]  = log.payload  if log.payload
-      custom_params[:tags]     = log.tags     if log.tags && (log.tags.size > 0)
+      custom_params[:payload]  = log.payload if log.payload
+      custom_params[:tags]     = log.tags if log.tags && (log.tags.size > 0)
 
-      { :metric => metric, :custom_params => custom_params }
+      {metric: metric, custom_params: custom_params}
     end
   end
 

data/lib/semantic_logger/appender/splunk.rb

@@ -20,7 +20,7 @@ class SemanticLogger::Appender::Splunk < SemanticLogger::Appender::Base
   # open the handles to resources
   def reopen
     # Connect to splunk. Connect is a synonym for creating a Service by hand and calling login.
-    @service = Splunk::connect(@config)
+    @service       = Splunk::connect(@config)
 
     # The index we are logging to
     @service_index = @service.indexes[@index]
@@ -46,7 +46,7 @@ class SemanticLogger::Appender::Splunk < SemanticLogger::Appender::Base
       password: options[:password]
     }
 
-    @index = options[:index]
+    @index = options[:index] || 'main'
 
     if @config[:username].nil?
       raise ArgumentError, 'Must supply a username.'
@@ -56,4 +56,4 @@ class SemanticLogger::Appender::Splunk < SemanticLogger::Appender::Base
       raise ArgumentError, 'Must supply an index.'
     end
   end
-end
+end

data/lib/semantic_logger/appender/syslog.rb

@@ -48,12 +48,12 @@ module SemanticLogger
       # ::Syslog::LOG_INFO    - "Informational message"
       # ::Syslog::LOG_DEBUG   - "Debugging information"
       DEFAULT_LEVEL_MAP = {
-        :fatal   => ::Syslog::LOG_CRIT,
-        :error   => ::Syslog::LOG_ERR,
-        :warn    => ::Syslog::LOG_WARNING,
-        :info    => ::Syslog::LOG_NOTICE,
-        :debug   => ::Syslog::LOG_INFO,
-        :trace   => ::Syslog::LOG_DEBUG
+        fatal: ::Syslog::LOG_CRIT,
+        error: ::Syslog::LOG_ERR,
+        warn:  ::Syslog::LOG_WARNING,
+        info:  ::Syslog::LOG_NOTICE,
+        debug: ::Syslog::LOG_INFO,
+        trace: ::Syslog::LOG_DEBUG
       }
 
       # For more information on the Syslog constants used below see http://ruby-doc.org/stdlib-2.0.0/libdoc/syslog/rdoc/Syslog.html
@@ -106,18 +106,18 @@ module SemanticLogger
       #
       #   :level_map [Hash]
       #     Supply a custom map of SemanticLogger levels to syslog levels.
-      #     For example, passing in { :warn => ::Syslog::LOG_NOTICE }
+      #     For example, passing in { warn: ::Syslog::LOG_NOTICE }
       #       would result in a log mapping that matches the default level map,
       #       except for :warn, which ends up with a LOG_NOTICE level instead of a
       #       LOG_WARNING one.
       #     Without overriding any parameters, the level map will be
       #       LEVEL_MAP = {
-      #         :fatal   => ::Syslog::LOG_CRIT,
-      #         :error   => ::Syslog::LOG_ERR,
-      #         :warn    => ::Syslog::LOG_WARNING,
-      #         :info    => ::Syslog::LOG_NOTICE,
-      #         :debug   => ::Syslog::LOG_INFO,
-      #         :trace   => ::Syslog::LOG_DEBUG
+      #         fatal:   ::Syslog::LOG_CRIT,
+      #         error:   ::Syslog::LOG_ERR,
+      #         warn:    ::Syslog::LOG_WARNING,
+      #         info:    ::Syslog::LOG_NOTICE,
+      #         debug:   ::Syslog::LOG_INFO,
+      #         trace:   ::Syslog::LOG_DEBUG
       #       }
       #
       #   :local_hostname [String]
@@ -143,19 +143,19 @@ module SemanticLogger
       #     For a list of options see the net_tcp_client documentation:
       #       https://www.omniref.com/ruby/gems/net_tcp_client/1.0.0/symbols/Net::TCPClient/initialize
       def initialize(params = {}, &block)
-        params              = params.dup
-        @ident              = params.delete(:ident) || 'ruby'
-        @options            = params.delete(:options) || (::Syslog::LOG_PID | ::Syslog::LOG_CONS)
-        @facility           = params.delete(:facility) || ::Syslog::LOG_USER
-        filter              = params.delete(:filter)
-        level               = params.delete(:level)
-        level_map           = params.delete(:level_map)
-        @level_map          = DEFAULT_LEVEL_MAP.dup
+        params     = params.dup
+        @ident     = params.delete(:ident) || 'ruby'
+        @options   = params.delete(:options) || (::Syslog::LOG_PID | ::Syslog::LOG_CONS)
+        @facility  = params.delete(:facility) || ::Syslog::LOG_USER
+        filter     = params.delete(:filter)
+        level      = params.delete(:level)
+        level_map  = params.delete(:level_map)
+        @level_map = DEFAULT_LEVEL_MAP.dup
         @level_map.update(level_map) if level_map
-        @server             = params.delete(:server) || 'syslog://localhost'
-        uri                 = URI(@server)
-        @host               = uri.host || 'localhost'
-        @protocol           = (uri.scheme || :syslog).to_sym
+        @server   = params.delete(:server) || 'syslog://localhost'
+        uri       = URI(@server)
+        @host     = uri.host || 'localhost'
+        @protocol = (uri.scheme || :syslog).to_sym
         raise "Unknown protocol #{@protocol}!" unless [:syslog, :tcp, :udp].include?(@protocol)
         @host               = 'localhost' if @protocol == :syslog
         @port               = URI(@server).port || 514
@@ -163,7 +163,7 @@ module SemanticLogger
         @tcp_client_options = params.delete(:tcp_client)
 
         # Warn about any unknown configuration options.
-        params.each_pair { |key,val| SemanticLogger::Logger.logger.warn "Ignoring unknown configuration option: #{key.inspect} => #{val.inspect}" }
+        params.each_pair { |key, val| SemanticLogger::Logger.logger.warn "Ignoring unknown configuration option: #{key.inspect} => #{val.inspect}" }
 
         # The syslog_protocol gem is required when logging over TCP or UDP.
         if [:tcp, :udp].include?(@protocol)
@@ -175,7 +175,7 @@ module SemanticLogger
 
           # The net_tcp_client gem is required when logging over TCP.
           if protocol == :tcp
-            @tcp_client_options ||= {}
+            @tcp_client_options          ||= {}
             @tcp_client_options[:server] = "#{@host}:#{@port}"
             begin
               require 'net/tcp_client'
@@ -199,7 +199,7 @@ module SemanticLogger
         when :tcp
           # Use the local logger for @remote_syslog so errors with the remote logger can be recorded locally.
           @tcp_client_options[:logger] = SemanticLogger::Logger.logger
-          @remote_syslog = Net::TCPClient.new(@tcp_client_options)
+          @remote_syslog               = Net::TCPClient.new(@tcp_client_options)
         when :udp
           @remote_syslog = UDPSocket.new
         else
@@ -215,7 +215,7 @@ module SemanticLogger
         case @protocol
         when :syslog
           # Since the Ruby Syslog API supports sprintf format strings, double up all existing '%'
-          message = formatter.call(log).gsub "%", "%%"
+          message = formatter.call(log).gsub '%', '%%'
           ::Syslog.log @level_map[log.level], message
         when :tcp
           @remote_syslog.retry_on_connection_failure { @remote_syslog.write("#{syslog_packet_formatter(log)}\r\n") }
@@ -238,8 +238,8 @@ module SemanticLogger
           tags = log.tags.collect { |tag| "[#{tag}]" }.join(" ") + " " if log.tags && (log.tags.size > 0)
 
           message = log.message.to_s
-          message << " -- " << log.payload.inspect if log.payload
-          message << " -- " << "#{log.exception.class}: #{log.exception.message}\n#{(log.exception.backtrace || []).join("\n")}" if log.exception
+          message << ' -- ' << log.payload.inspect if log.payload
+          message << ' -- ' << "#{log.exception.class}: #{log.exception.message}\n#{(log.exception.backtrace || []).join("\n")}" if log.exception
 
           duration_str = log.duration ? "(#{'%.1f' % log.duration}ms) " : ''
 
@@ -249,10 +249,10 @@ module SemanticLogger
 
       # Format the syslog packet so it can be sent over TCP or UDP
       def syslog_packet_formatter(log)
-        packet = SyslogProtocol::Packet.new
+        packet          = SyslogProtocol::Packet.new
         packet.hostname = @local_hostname
         packet.facility = @facility
-        packet.severity =  @level_map[log.level]
+        packet.severity = @level_map[log.level]
         packet.tag      = @ident
         packet.content  = default_formatter.call(log)
         packet.to_s