Add configurable logging

Author: pitr-ch

lib/concurrent/actress.rb

@@ -3,6 +3,7 @@
 require 'concurrent/configuration'
 require 'concurrent/executor/one_by_one'
 require 'concurrent/ivar'
+require 'concurrent/logging'
 
 module Concurrent
 

lib/concurrent/actress/core.rb

@@ -7,6 +7,7 @@ module Actress
     # @api private
     class Core
       include TypeCheck
+      include Concurrent::Logging
 
       attr_reader :reference, :name, :path, :executor
 
@@ -15,6 +16,8 @@ class Core
       # @option opts [Context] actress_class a class to be instantiated defining Actor's behaviour
       # @option opts [Array<Object>] args arguments for actress_class instantiation
       # @option opts [Executor] executor, default is `Concurrent.configuration.global_task_pool`
+      # @option opts [Proc, nil] logger a proc accepting (level, progname, message = nil, &block) params,
+      #   can be used to hook actor instance to any logging system
       # @param [Proc] block for class instantiation
       def initialize(opts = {}, &block)
         @mailbox    = Array.new
@@ -32,11 +35,8 @@ def initialize(opts = {}, &block)
           raise 'only root has no parent'
         end
 
-        @path            = @parent_core ? File.join(@parent_core.path, @name) : @name
-        # TODO add proper logging
-        @logger          = Logger.new($stderr)
-        @logger.level    = opts.fetch(:logger_level, 1)
-        @logger.progname = @path
+        @path   = @parent_core ? File.join(@parent_core.path, @name) : @name
+        @logger = opts[:logger]
 
         @parent_core.add_child reference if @parent_core
 
@@ -48,7 +48,7 @@ def initialize(opts = {}, &block)
             @actress = actress_class.new *args, &block
             @actress.send :initialize_core, self
           rescue => ex
-            @logger.error ex
+            log ERROR, ex
             terminate!
           end
         end
@@ -111,7 +111,7 @@ def terminate!
         @parent_core.remove_child reference if @parent_core
         @mailbox.each do |envelope|
           reject_envelope envelope
-          @logger.debug "rejected #{envelope.message} from #{envelope.sender_path}"
+          log DEBUG, "rejected #{envelope.message} from #{envelope.sender_path}"
         end
         @mailbox.clear
         # TODO terminate all children
@@ -146,15 +146,15 @@ def receive_envelope
 
         if terminated?
           reject_envelope envelope
-          @logger.fatal "this should not be happening #{caller[0]}"
+          log FATAL, "this should not be happening #{caller[0]}"
         end
 
-        @logger.debug "received #{envelope.message} from #{envelope.sender_path}"
+        log DEBUG, "received #{envelope.message} from #{envelope.sender_path}"
 
         result = @actress.on_envelope envelope
         envelope.ivar.set result unless envelope.ivar.nil?
       rescue => error
-        @logger.error error
+        log ERROR, error
         envelope.ivar.fail error unless envelope.ivar.nil?
         terminate!
       ensure
@@ -170,7 +170,7 @@ def schedule_execution
             Thread.current[:__current_actress__] = reference
             yield
           rescue => e
-            @logger.fatal e
+            log FATAL, e
           ensure
             Thread.current[:__current_actress__] = nil
           end
@@ -181,6 +181,10 @@ def schedule_execution
       def reject_envelope(envelope)
         envelope.reject! ActressTerminated.new(reference)
       end
+
+      def log(level, message = nil, &block)
+        super level, @path, message, &block
+      end
     end
   end
 end

lib/concurrent/agent.rb

@@ -200,7 +200,6 @@ def work(&handler) # :nodoc:
       validator, value = mutex.synchronize { [@validator, @value] }
 
       begin
-        # FIXME creates second thread
         result, valid = Concurrent::timeout(@timeout) do
           result = handler.call(value)
           [result, validator.call(result)]

lib/concurrent/configuration.rb

@@ -10,11 +10,18 @@ module Concurrent
   # A gem-level configuration object.
   class Configuration
 
+    attr_accessor :logger
+
     # Create a new configuration object.
     def initialize
       @global_task_pool      = Delay.new { new_task_pool }
       @global_operation_pool = Delay.new { new_operation_pool }
       @global_timer_set      = Delay.new { Concurrent::TimerSet.new }
+      @logger                = no_logger
+    end
+
+    def no_logger
+      -> (level, progname, message = nil, &block) {}
     end
 
     # Global thread pool optimized for short *tasks*.

lib/concurrent/logging.rb

@@ -0,0 +1,11 @@
+require 'logger'
+
+module Concurrent
+  module Logging
+    include Logger::Severity
+
+    def log(level, progname, message = nil, &block)
+      (@logger || Concurrent.configuration.logger).call level, progname, message, &block
+    end
+  end
+end

spec/concurrent/actress_spec.rb

@@ -104,13 +104,13 @@ def assert condition
         end
 
         it 'terminates on failed initialization' do
-          a = AdHoc.spawn(name: :fail, logger_level: 4) { raise }
+          a = AdHoc.spawn(name: :fail, logger: Concurrent.configuration.no_logger) { raise }
           a.ask(nil).wait.rejected?.should be_true
           a.terminated?.should be_true
         end
 
         it 'terminates on failed message processing' do
-          a = AdHoc.spawn(name: :fail, logger_level: 4) { -> _ { raise } }
+          a = AdHoc.spawn(name: :fail, logger: Concurrent.configuration.no_logger) { -> _ { raise } }
           a.ask(nil).wait.rejected?.should be_true
           a.terminated?.should be_true
         end

spec/spec_helper.rb

@@ -2,8 +2,8 @@
 require 'coveralls'
 
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
 ]
 
 SimpleCov.start do
@@ -17,6 +17,10 @@
 
 require 'concurrent'
 
+logger                          = Logger.new($stderr)
+logger.level                    = Logger::INFO
+Concurrent.configuration.logger = -> (level, progname, message = nil, &block) { logger.add level, message, progname, &block }
+
 # import all the support files
 Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require File.expand_path(f) }