semantic_logger 0.7.1 → 0.8.0

data/Gemfile

@@ -7,3 +7,4 @@ group :test do
 end
 
 gem "sync_attr"
+gem "thread_safe"

data/Gemfile.lock

@@ -5,6 +5,7 @@ GEM
       i18n (~> 0.6)
       multi_json (~> 1.0)
     bson (1.7.0)
+    bson (1.7.0-java)
     bson_ext (1.7.0)
       bson (~> 1.7.0)
     i18n (0.6.1)
@@ -18,8 +19,10 @@ GEM
     shoulda-matchers (1.4.0)
       activesupport (>= 3.0.0)
     sync_attr (0.1.1)
+    thread_safe (0.0.3)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES
@@ -27,3 +30,4 @@ DEPENDENCIES
   mongo
   shoulda
   sync_attr
+  thread_safe

data/Rakefile

@@ -22,6 +22,7 @@ task :gem  do |t|
     spec.files       = FileList["./**/*"].exclude('*.gem', 'nbproject').map{|f| f.sub(/^\.\//, '')}
     spec.has_rdoc    = true
     spec.add_dependency 'sync_attr'
+    spec.add_dependency 'thread_safe'
     spec.add_development_dependency 'shoulda'
   end
   Gem::Builder.new(gemspec).build

data/dev.log

@@ -0,0 +1,18 @@
+2012-10-18 13:34:41.198757 D [95128:70168596413880] SemanticLogger::Appender::File -- SemanticLogger::Logger Appender thread started
+2012-10-18 13:34:41.202210 T [95128:70168592210640] Hello -- Trace this
+2012-10-18 13:34:41.203420 T [95128:70168592210640] Hello -- Trace After
+2012-10-18 13:35:03.207898 D [95128:70168592210640] SemanticLogger::Appender::File -- SemanticLogger::Logger process terminating, flushing appenders
+2012-10-18 13:35:03.208132 D [95128:70168596413880] SemanticLogger::Appender::File -- SemanticLogger::Logger appenders flushed
+2012-10-18 13:35:03.226551 D [95128:70168596413880] SemanticLogger::Appender::File -- SemanticLogger::Logger Appender thread stopped
+2012-10-18 13:35:16.375653 D [95296:70233482947260] SemanticLogger::Appender::File -- SemanticLogger::Logger Appender thread started
+2012-10-18 13:35:16.380396 T [95296:70233482287840] Hello -- Trace this
+2012-10-18 13:35:16.381089 T [95296:70233482287840] Hello -- Trace After
+2012-10-18 13:35:21.767557 D [95296:70233482287840] SemanticLogger::Appender::File -- SemanticLogger::Logger process terminating, flushing appenders
+2012-10-18 13:35:21.767813 D [95296:70233482947260] SemanticLogger::Appender::File -- SemanticLogger::Logger appenders flushed
+2012-10-18 13:35:21.769090 D [95296:70233482947260] SemanticLogger::Appender::File -- SemanticLogger::Logger Appender thread stopped
+2012-10-18 13:35:49.755489 D [95301:70263790953920] SemanticLogger::Appender::File -- SemanticLogger::Logger Appender thread started
+2012-10-18 13:35:58.251090 T [95301:70263790328540] Hello -- Trace this
+2012-10-18 13:35:58.252585 T [95301:70263790328540] Hello -- Trace After
+2012-10-18 13:36:08.710232 D [95301:70263790328540] SemanticLogger::Appender::File -- SemanticLogger::Logger process terminating, flushing appenders
+2012-10-18 13:36:08.711053 D [95301:70263790953920] SemanticLogger::Appender::File -- SemanticLogger::Logger appenders flushed
+2012-10-18 13:36:08.712175 D [95301:70263790953920] SemanticLogger::Appender::File -- SemanticLogger::Logger Appender thread stopped

data/lib/semantic_logger/logger.rb

@@ -1,4 +1,5 @@
 require 'thread'
+require 'thread_safe'
 require 'sync_attr'
 
 # Logger is the interface used by
@@ -36,9 +37,14 @@ module SemanticLogger
   class Logger < Base
     include SyncAttr
 
-    # Thread safe Class Attribute accessor for appenders array
-    sync_cattr_accessor :appenders do
-      []
+    # Add or remove logging appenders to the appenders Array
+    # Appenders will be written to in the order that they appear in this list
+    sync_cattr_reader :appenders do
+      # The logging thread is only started once an appender has been defined
+      startup
+
+      # Thread safe appenders array
+      ThreadSafe::Array.new
     end
 
     # Initial default Level for all new instances of SemanticLogger::Logger
@@ -90,17 +96,17 @@ module SemanticLogger
       queue.size
     end
 
-    # Flush all pending log entry disk, database, etc.
-    #  All pending log writes are completed and each appender is flushed in turn
+    # 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 @@appender_thread.alive?
+      return false unless started?
 
       reply_queue = Queue.new
       queue << { :command => :flush, :reply_queue => reply_queue }
       reply_queue.pop
     end
 
-    @@lag_check_interval = 1000
+    @@lag_check_interval = 5000
     @@lag_threshold_s = 30
 
     # Returns the check_interval which is the number of messages between checks
@@ -125,13 +131,25 @@ module SemanticLogger
       @@lag_threshold_s = time_threshold_s
     end
 
+    # Returns whether the logging thread has been started
+    def self.started?
+      defined? :@@appenders
+    end
+
     ############################################################################
     protected
 
+    @@queue = Queue.new
+
+    # Queue to hold messages that need to be logged to the various appenders
+    def self.queue
+      @@queue
+    end
+
     # Place log request on the queue for the Appender thread to write to each
     # appender in the order that they were registered
     def log(log)
-      self.class.queue << log
+      self.class.queue << log if self.class.started?
     end
 
     # Internal logger for SemanticLogger
@@ -146,24 +164,27 @@ module SemanticLogger
       SemanticLogger::Appender::File.new(STDERR, :warn)
     end
 
-    # Log to queue
-    #   Starts the appender thread the first time a logging call is made
-    sync_cattr_reader :queue do
-      startup
-      at_exit { shutdown }
-      Queue.new
-    end
-
     # Start a separate appender thread responsible for reading log messages and
     # calling the appenders in it's thread
     def self.startup
-      @@appender_thread = Thread.new do
+      # This thread is designed to never go down unless the main thread terminates
+      # Before terminating at_exit is used to flush all the appenders
+      #
+      # Should any appender fail to log or flush, the exception is logged and
+      # other appenders will still be called
+      Thread.new do
+        logger.debug "SemanticLogger::Logger Appender thread started"
         begin
-          logger.debug "SemanticLogger::Logger Appender thread started"
           count = 0
           while message = queue.pop
             if message.is_a? Log
-              appenders.each {|appender| appender.log(message) }
+              appenders.each do |appender|
+                begin
+                  appender.log(message)
+                rescue Exception => exc
+                  logger.error "SemanticLogger::Logger Appender thread: Failed to log to appender: #{appender.inspect}", exc
+                end
+              end
               count += 1
               # Check every few log messages whether this appender thread is falling behind
               if count > lag_check_interval
@@ -174,39 +195,34 @@ module SemanticLogger
               end
             else
               case message[:command]
-              when :shutdown
-                appenders.each {|appender| appender.flush }
-                message[:reply_queue] << true if message[:reply_queue]
-                logger.debug "SemanticLogger::Logger appenders flushed, now shutting down"
-                break
               when :flush
-                appenders.each {|appender| appender.flush }
+                appenders.each do |appender|
+                  begin
+                    appender.flush
+                  rescue Exception => exc
+                    logger.error "SemanticLogger::Logger Appender thread: Failed to flush appender: #{appender.inspect}", exc
+                  end
+                end
+
                 message[:reply_queue] << true if message[:reply_queue]
                 logger.debug "SemanticLogger::Logger appenders flushed"
+              else
+                logger.warn "SemanticLogger::Logger Appender thread: Ignoring unknown command: #{message[:command]}"
               end
             end
           end
         rescue Exception => exception
-          logger.error "SemanticLogger::Logger Appender thread restarting due to exception: #{exception.class}: #{exception.message}\n#{(exception.backtrace || []).join("\n")}"
-          # Start a new appender thread and let this one terminate
-          startup
+          logger.error "SemanticLogger::Logger Appender thread restarting due to exception", exception
+          retry
         ensure
           logger.debug "SemanticLogger::Logger Appender thread stopped"
         end
       end
-    end
 
-    # Stop the log appender thread and flush all appenders
-    def self.shutdown
-      return false unless @@appender_thread.alive?
-
-      logger.debug "SemanticLogger::Logger Shutdown. Stopping appender thread"
-      queue << { :command => :shutdown }
-      @@appender_thread.join
-      # Undefine the class variable for the queue since in test environments
-      # at_exit can be invoked multiple times
-      remove_class_variable(:@@queue)
-      true
+      at_exit do
+        logger.debug "SemanticLogger::Logger process terminating, flushing appenders"
+        flush
+      end
     end
 
     # Formatting does not occur within this thread, it is done by each appender

data/lib/semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module SemanticLogger #:nodoc
-  VERSION = "0.7.1"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: semantic_logger
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-15 00:00:00.000000000 Z
+date: 2012-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sync_attr
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thread_safe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -51,6 +67,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- dev.log
 - FUTURE.rb
 - Gemfile
 - Gemfile.lock
@@ -73,6 +90,8 @@ files:
 - Rakefile
 - README.md
 - semantic_logger-0.7.0.gem
+- semantic_logger-0.7.1.gem
+- semantic_logger-0.8.0.gem
 - test/appender_file_test.rb
 - test/appender_mongodb_test.rb
 - test/appender_wrapper_test.rb
@@ -92,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4306038405439856699
+      hash: 3275873948644639479
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: