semantic_logger 0.8.1 → 0.9.0

data/README.md

@@ -725,15 +725,16 @@ Basic outline for an Appender:
 ```ruby
 require 'semantic_logger'
 
-class SimpleAppender < SemanticLogger::Base
+class SimpleAppender < SemanticLogger::Appender::Base
   def initialize(level=nil, &block)
     # Set the log level and formatter if supplied
     super(level, &block)
   end
 
-  # Just display the log struct
+  # Display the log struct and the text formatted output
   def log(log)
     p log
+    puts @formatter.call(log)
   end
 
   # Optional

data/lib/semantic_logger.rb

@@ -3,6 +3,7 @@ module SemanticLogger
   autoload :Logger, 'semantic_logger/logger'
 
   module Appender
+    autoload :Base,    'semantic_logger/appender/base'
     autoload :File,    'semantic_logger/appender/file'
     autoload :Wrapper, 'semantic_logger/appender/wrapper'
     autoload :MongoDB, 'semantic_logger/appender/mongodb'

data/lib/semantic_logger/appender/base.rb

@@ -0,0 +1,83 @@
+# Base appender
+#
+#   Abstract base class for appenders
+#
+#   Implements common behavior such as default text formatter etc
+#
+#   Note: Do not create instances of this class directly
+#
+module SemanticLogger
+  module Appender
+    class Base < SemanticLogger::Base
+      attr_accessor :formatter
+
+      # Default log formatter
+      #  Replace this formatter by supplying a Block to the initializer
+      #  Generates logs of the form:
+      #    2011-07-19 14:36:15.660 D [1149:ScriptThreadProcess] Rails -- Hello World
+      def default_formatter
+        Proc.new do |log|
+          message = log.message.to_s
+          tags = log.tags.collect { |tag| "[#{tag}]" }.join(" ") + " " if log.tags && (log.tags.size > 0)
+
+          if log.payload
+            if log.payload.is_a?(Exception)
+              exception = log.payload
+              message << " -- " << "#{exception.class}: #{exception.message}\n#{(exception.backtrace || []).join("\n")}"
+            else
+              message << " -- " << self.class.inspect_payload(log.payload)
+            end
+          end
+
+          duration_str = log.duration ? "(#{'%.1f' % log.duration}ms) " : ''
+
+          "#{SemanticLogger::Appender::Base.formatted_time(log.time)} #{log.level.to_s[0..0].upcase} [#{$$}:#{log.thread_name}] #{tags}#{duration_str}#{log.name} -- #{message}"
+        end
+      end
+
+      ############################################################################
+      protected
+
+      # By default the appender should log everything that is sent to it by
+      # the loggers. That way the loggers control the log level
+      # By setting the log level to a higher value the appender can be setup
+      # to log for example only :warn or higher while other appenders
+      # are able to log lower level information
+      def initialize(level, &block)
+        # Set the formatter to the supplied block
+        @formatter = block || default_formatter
+
+        # Appenders don't take a class name, so use this class name if an appender
+        # is logged to directly
+        super(self.class, level || :trace)
+      end
+
+      # For JRuby include the Thread name rather than its id
+      if defined? Java
+        # Return the Time as a formatted string
+        # JRuby only supports time in ms
+        def self.formatted_time(time)
+          "#{time.strftime("%Y-%m-%d %H:%M:%S")}.#{"%03d" % (time.usec/1000)}"
+        end
+      else
+        # Return the Time as a formatted string
+        # Ruby MRI supports micro seconds
+        def self.formatted_time(time)
+          "#{time.strftime("%Y-%m-%d %H:%M:%S")}.#{"%06d" % (time.usec)}"
+        end
+      end
+
+      if RUBY_VERSION.to_f >= 1.9
+        # With Ruby 1.9 calling .to_s on a hash now returns { 'a' => 1 }
+        def self.inspect_payload(payload)
+          payload.to_s
+        end
+      else
+        def self.inspect_payload(payload)
+          payload.inspect
+        end
+      end
+
+    end
+  end
+end

data/lib/semantic_logger/appender/file.rb

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

data/lib/semantic_logger/appender/mongodb.rb

@@ -42,7 +42,7 @@ module SemanticLogger
     #   params: Hash
     #
     #   tracking_number: 'user defined tracking number'
-    class MongoDB < SemanticLogger::Base
+    class MongoDB < SemanticLogger::Appender::Base
       attr_reader :db, :collection_name
       attr_accessor :host_name, :safe, :application
 

data/lib/semantic_logger/appender/wrapper.rb

@@ -4,7 +4,7 @@
 #
 module SemanticLogger
   module Appender
-    class Wrapper < SemanticLogger::Base
+    class Wrapper < SemanticLogger::Appender::Base
       attr_reader :logger
 
       # Create a Logger or Rails Logger appender instance
@@ -36,8 +36,6 @@ module SemanticLogger
         super(:trace, &block)
       end
 
-      # TODO Compatible calls to #level and #level= against the underlying Rails/Ruby logger
-
       # Pass log calls to the underlying Rails, log4j or Ruby logger
       #  trace entries are mapped to debug since :trace is not supported by the
       #  Ruby or Rails Loggers

data/lib/semantic_logger/base.rb

@@ -1,6 +1,6 @@
-# Base appender
+# Base logger
 #
-#   Abstract base class for appenders
+#   Abstract base class for loggers
 #
 #   Implements common behavior such as log level, default text formatter etc
 #
@@ -8,47 +8,12 @@
 #
 module SemanticLogger
   class Base
-    attr_accessor :formatter
-    attr_reader   :level
+    # Class name to be logged
+    attr_accessor :name
 
-    def initialize(level, &block)
-      # Set the formatter to the supplied block
-      @formatter = block || default_formatter
+    attr_reader :level
 
-      # Log everything that comes to the appender by default
-      self.level = level || :trace
-    end
-
-    # Default log formatter
-    #  Replace this formatter by supplying a Block to the initializer
-    #  Generates logs of the form:
-    #    2011-07-19 14:36:15.660 D [1149:ScriptThreadProcess] Rails -- Hello World
-    def default_formatter
-      Proc.new do |log|
-        message = log.message.to_s
-        tags = log.tags.collect { |tag| "[#{tag}]" }.join(" ") + " " if log.tags && (log.tags.size > 0)
-
-        if log.payload
-          if log.payload.is_a?(Exception)
-            exception = log.payload
-            message << " -- " << "#{exception.class}: #{exception.message}\n#{(exception.backtrace || []).join("\n")}"
-          else
-            message << " -- " << self.class.inspect_payload(log.payload)
-          end
-        end
-
-        duration_str = log.duration ? "(#{'%.1f' % log.duration}ms) " : ''
-
-        "#{SemanticLogger::Base.formatted_time(log.time)} #{log.level.to_s[0..0].upcase} [#{$$}:#{log.thread_name}] #{tags}#{duration_str}#{log.name} -- #{message}"
-      end
-    end
-
-    # Write log data to underlying data storage
-    def log(log_)
-      raise "Logging Appender must implement #log(log)"
-    end
-
-    # Set the logging level for this appender
+    # Set the logging level for this logger
     #
     # Note: This level is only for this particular appender. It does not override
     #   the log level in any logging instance or the default log level
@@ -209,9 +174,34 @@ module SemanticLogger
 
     # #TODO implement a thread safe #silence method
 
+    # Initial default Level for all new instances of SemanticLogger::Logger
+    @@default_level = :info
+
+    # Allow for setting the global default log level
+    # This change only applies to _new_ loggers, existing logger levels
+    # will not be changed in any way
+    def self.default_level=(level)
+      @@default_level = level
+    end
+
+    # Returns the global default log level for new Logger instances
+    def self.default_level
+      @@default_level
+    end
+
     ############################################################################
     protected
 
+    def initialize(klass, level=nil)
+      @name = klass.is_a?(String) ? klass : klass.name
+      self.level = level || self.class.default_level
+    end
+
+    # Write log data to underlying data storage
+    def log(log_)
+      raise "Logging Appender must implement #log(log)"
+    end
+
     # Return the level index for fast comparisons
     attr_reader :level_index
 
@@ -252,33 +242,10 @@ module SemanticLogger
       def self.thread_name
         Java::java.lang::Thread.current_thread.name
       end
-
-      # Return the Time as a formatted string
-      # JRuby only supports time in ms
-      def self.formatted_time(time)
-        "#{time.strftime("%Y-%m-%d %H:%M:%S")}.#{"%03d" % (time.usec/1000)}"
-      end
     else
       def self.thread_name
         Thread.current.object_id
       end
-
-      # Return the Time as a formatted string
-      # Ruby MRI supports micro seconds
-      def self.formatted_time(time)
-        "#{time.strftime("%Y-%m-%d %H:%M:%S")}.#{"%06d" % (time.usec)}"
-      end
-    end
-
-    if RUBY_VERSION.to_f >= 1.9
-      # With Ruby 1.9 calling .to_s on a hash now returns { 'a' => 1 }
-      def self.inspect_payload(payload)
-        payload.to_s
-      end
-    else
-      def self.inspect_payload(payload)
-        payload.inspect
-      end
     end
 
     # Internal method to return the log level as an internal index
@@ -304,11 +271,5 @@ module SemanticLogger
       index
     end
 
-    # Appenders don't take a class name, so use this class name if an appender
-    # is logged to directly
-    def name
-      self.class.name
-    end
-
   end
 end

data/lib/semantic_logger/logger.rb

@@ -47,24 +47,6 @@ module SemanticLogger
       ThreadSafe::Array.new
     end
 
-    # Initial default Level for all new instances of SemanticLogger::Logger
-    @@default_level = :info
-    @@appender_thread = nil
-
-    # Allow for setting the global default log level
-    # This change only applies to _new_ loggers, existing logger levels
-    # will not be changed in any way
-    def self.default_level=(level)
-      @@default_level = level
-    end
-
-    # Returns the global default log level for new Logger instances
-    def self.default_level
-      @@default_level
-    end
-
-    attr_reader :name
-
     # Returns a Logger instance
     #
     # Return the logger for a specific class, supports class specific log levels
@@ -93,15 +75,22 @@ module SemanticLogger
     # able to write to the appenders fast enough. Either reduce the amount of
     # logging, increase the log level, reduce the number of appenders, or
     # look into speeding up the appenders themselves
-    def self.cache_count
+    def self.queue_size
       queue.size
     end
 
+    # DEPRECATED: Please use queue_size instead.
+    def self.cache_count
+      warn "[DEPRECATION] 'SemanticLogger::Logger.cache_count' is deprecated.  Please use 'SemanticLogger::Logger.queue_size' instead."
+      queue_size
+    end
+
     # Flush all queued log entries disk, database, etc.
     #  All queued log messages are written and then each appender is flushed in turn
     def self.flush
       return false unless started? && @@appender_thread && @@appender_thread.alive?
 
+      logger.debug "SemanticLogger::Logger Flushing appenders with #{queue_size} log messages on the queue"
       reply_queue = Queue.new
       queue << { :command => :flush, :reply_queue => reply_queue }
       reply_queue.pop
@@ -140,6 +129,7 @@ module SemanticLogger
     ############################################################################
     protected
 
+    @@appender_thread = nil
     @@queue = Queue.new
 
     # Queue to hold messages that need to be logged to the various appenders
@@ -190,7 +180,7 @@ module SemanticLogger
               # Check every few log messages whether this appender thread is falling behind
               if count > lag_check_interval
                 if (diff = Time.now - message.time) > lag_threshold_s
-                  logger.warn "SemanticLogger::Logger Appender thread has fallen behind by #{diff} seconds with #{cache_count} messages queued up. Consider reducing the log level or changing the appenders"
+                  logger.warn "SemanticLogger::Logger Appender thread has fallen behind by #{diff} seconds with #{queue_size} messages queued up. Consider reducing the log level or changing the appenders"
                 end
                 count = 0
               end
@@ -226,11 +216,5 @@ module SemanticLogger
       end
     end
 
-    # Formatting does not occur within this thread, it is done by each appender
-    # in the appender thread
-    def default_formatter
-      nil
-    end
-
   end
 end

data/lib/semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module SemanticLogger #:nodoc
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end

data/test/appender_mongodb_test.rb

@@ -30,7 +30,7 @@ class AppenderMongoDBTest < Test::Unit::TestCase
     context "format logs into documents" do
 
       should "handle nil name, message and hash" do
-        @appender.log SemanticLogger::Logger::Log.new(:debug)
+        @appender.log SemanticLogger::Base::Log.new(:debug)
         document = @appender.collection.find_one
         assert_equal :debug, document['level']
         assert_equal nil, document['message']
@@ -43,7 +43,7 @@ class AppenderMongoDBTest < Test::Unit::TestCase
       end
 
       should "handle nil message and payload" do
-        log = SemanticLogger::Logger::Log.new(:debug)
+        log = SemanticLogger::Base::Log.new(:debug)
         log.payload = @hash
         @appender.log(log)
 
@@ -59,7 +59,7 @@ class AppenderMongoDBTest < Test::Unit::TestCase
       end
 
       should "handle message and payload" do
-        log = SemanticLogger::Logger::Log.new(:debug)
+        log = SemanticLogger::Base::Log.new(:debug)
         log.message = 'hello world'
         log.payload = @hash
         log.thread_name = 'thread'
@@ -78,7 +78,7 @@ class AppenderMongoDBTest < Test::Unit::TestCase
       end
 
       should "handle message without payload" do
-        log = SemanticLogger::Logger::Log.new(:debug)
+        log = SemanticLogger::Base::Log.new(:debug)
         log.message = 'hello world'
         log.thread_name = 'thread'
         log.time = @time
@@ -100,7 +100,7 @@ class AppenderMongoDBTest < Test::Unit::TestCase
       # Ensure that any log level can be logged
       SemanticLogger::LEVELS.each do |level|
         should "log #{level} information" do
-          @appender.log SemanticLogger::Logger::Log.new(level, 'thread', 'my_class', 'hello world -- Calculations', @hash, @time)
+          @appender.log SemanticLogger::Base::Log.new(level, 'thread', 'my_class', 'hello world -- Calculations', @hash, @time)
           document = @appender.collection.find_one
           assert_equal level, document['level']
           assert_equal 'hello world -- Calculations', document['message']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: semantic_logger
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-19 00:00:00.000000000 Z
+date: 2012-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sync_attr
@@ -72,6 +72,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - init.txt
+- lib/semantic_logger/appender/base.rb
 - lib/semantic_logger/appender/file.rb
 - lib/semantic_logger/appender/mongodb.rb
 - lib/semantic_logger/appender/wrapper.rb
@@ -92,6 +93,7 @@ files:
 - semantic_logger-0.7.0.gem
 - semantic_logger-0.7.1.gem
 - semantic_logger-0.8.0.gem
+- semantic_logger-0.8.1.gem
 - test/appender_file_test.rb
 - test/appender_mongodb_test.rb
 - test/appender_wrapper_test.rb
@@ -111,7 +113,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3615546680742578594
+      hash: 3745819161206359497
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: