log 0.0.10 → 1.0.0

data/lib/log.rb

@@ -1,130 +1,169 @@
 # Author: Yaron Dror (yaron.dror.bb@gmail.com)
 # Description: The file contains the code which implements the 'Log' module
-# Run: Add to 'require' list.
-# Note: The logger will be automatically initialized if log_param_auto_start is true
-#       If log_param_auto_start is false then 'Log.init' method will be called
-#       on the first attempt to log.
+# Run: Add to 'require' list. Execute Log.init
+
+#require 'email'
+require 'log4r'
+require 'log4r/outputter/emailoutputter'
 
 require 'params'
-require 'thread'
-require 'log/log_consumer.rb'
-
-module BBFS
-  # Module: Log.
-  # Abstruct: The Log is used to log info\warning\error\debug messages
-  # Note: The logger will be automatically initialized if log_param_auto_start is true
-  #       If log_param_auto_start is false then 'Log.init' method will be called
-  #       on the first attempt to log.
-  module Log
-    #Auxiliary method to retrieve the executable name
-    def Log.executable_name
-      /([a-zA-Z0-9\-_\.]+):\d+/ =~ caller[caller.size-1]
-      return $1
-    end
 
-    # Global params
-    Params.boolean 'log_param_auto_start',false, \
-      'log param. If true, log will start automatically. ' + \
-      'Else, init should be called. ' + \
-      'Else Init will be called automatically on the first attempt to log.'
-    Params.integer 'log_debug_level', 0 , 'Log level.'
-    Params.integer 'log_param_number_of_mega_bytes_stored_before_flush', 0, \
-      'log param. Number of mega bytes stored before they are flushed.'
-    Params.float 'log_param_max_elapsed_time_in_seconds_from_last_flush', 0, \
-      'log param. Max elapsed time in seconds from last flush'
-    Params.boolean 'log_write_to_file', true , \
-      'If true then the logger will write the messages to a file.'
-    Params.boolean 'log_write_to_console', false , \
-      'If true then the logger will write the messages to the console.'
-    Params.string 'log_file_name', File.expand_path("~/.bbfs/log/#{Log.executable_name}.log") , \
-      'Default log file name: ~/.bbfs/log/<executable_name>.log'
-
-    @consumers = []
-    @log_initialized = false
-
-    #Note that the logger will be automatically initialized if log_param_auto_start is true
-    if Params['log_param_auto_start'] then
-      Log.init
+# Module: Log.
+# Abstruct: The Log is used to log info\warning\error\debug messages
+#           This module is actually a wrapper to log4r gem and serves
+#           as a central code to use the log utility.
+module Log
+
+  #Auxiliary method to retrieve the executable name
+  def Log.executable_name
+    /([a-zA-Z0-9\-_\.]+):\d+/ =~ caller[caller.size-1]
+    return $1
+  end
+
+  # Global params
+  Params.integer('log_debug_level', 0 , \
+      'Verbosity of logging. 0 will log only INFO messages. Other value, will log all DEBUG messages as well.')
+  Params.boolean('log_flush_each_message', true, \
+      'If true then File and Console outputters will be flushed for each message.')
+  Params.boolean('log_write_to_file', true , \
+      'If true then the logger will write the messages to a file.')
+  Params.path('log_file_name', "~/.bbfs/log/#{Log.executable_name}.log4r" , \
+      'Default log file name: ~/.bbfs/log/<executable_name>.log')
+  Params.boolean('log_write_to_console', false , \
+      'If true then the logger will write the messages to the console.')
+  Params.boolean('log_write_to_email', false , \
+      'If true then the logger will write the error and fatal messages to email.')
+  Params.string('from_email', 'bbfsdev@gmail.com', 'From gmail address for update.')
+  Params.string('from_email_password', '', 'From gmail password.')
+  Params.string('to_email', 'bbfsdev@gmail.com', 'Destination email for updates.')
+
+  #Should be called from executable right after params handling.
+  # Init Log level and set output to file,stdout and email according to configuration params.
+  def Log.init
+    @log4r = Log4r::Logger.new 'BBFS log'
+    @log4r.trace = true
+
+    #levels setup
+    log4r_level = Log4r::DEBUG
+    log4r_level = Log4r::INFO if 0 == Params['log_debug_level']
+
+    #formatters
+    formatter = Log4r::PatternFormatter.new(:pattern => "[%l] [%d] [%m]")
+
+    #stdout setup
+    if Params['log_write_to_console']
+      stdout_outputter = Log4r::Outputter.stdout
+      stdout_outputter.formatter = formatter
+      stdout_outputter.level = log4r_level
+      @log4r.outputters << stdout_outputter
     end
 
-    # Init the Log consumers
-    def Log.init
-      Log.clear_consumers
-      # Console - If enabled, will flush the log immediately to the console
-      if Params['log_write_to_console'] then
-        console_consumer = ConsoleConsumer.new
-        @consumers.push console_consumer
-      end
-      # BufferConsumerProducer - If enabled, will use the file consumer to flush a buffer to a file
-      if Params['log_write_to_file'] then
-        file_consumer = FileConsumer.new Params['log_file_name']
-        buffer_consumer_producer = BufferConsumerProducer.new \
-          Params['log_param_number_of_mega_bytes_stored_before_flush'], \
-          Params['log_param_max_elapsed_time_in_seconds_from_last_flush']
-        buffer_consumer_producer.add_consumer file_consumer
-        @consumers.push buffer_consumer_producer
+    #file setup
+    if Params['log_write_to_file']
+      if File.exist?(Params['log_file_name'])
+        File.delete Params['log_file_name']
+      else
+        dir_name = File.dirname(Params['log_file_name'])
+        FileUtils.mkdir_p(dir_name) unless File.directory?(dir_name)
       end
-      @log_initialized = true
-      Log.info 'BBFS Log initialized.'  # log first data
-      Log.info "Log file path:'#{Params['log_file_name']}'" if Params['log_write_to_file']
-      Params.get_init_messages().each { |msg|
-        Log.info msg
-      } unless Params.get_init_messages().empty?
+      file_outputter = Log4r::FileOutputter.new('file_log', :filename => Params['log_file_name'])
+      file_outputter.level = log4r_level
+      file_outputter.formatter = formatter
+      @log4r.outputters << file_outputter
     end
 
-    # Clears consumers
-    def Log.clear_consumers
-      @consumers.clear
+    #email setup
+    if Params['log_write_to_email']
+      server_name = `hostname`.strip
+      email_outputter = Log4r::EmailOutputter.new('email_log',
+                                                  :server => 'smtp.gmail.com',
+                                                  :port => 587,
+                                                  :subject => "Error happened at #{server_name} server run by #{ENV['USER']}. Service_name is #{Params['service_name']}",
+                                                  :acct => Params['from_email'],
+                                                  :from => Params['from_email'],
+                                                  :passwd => Params['from_email_password'],
+                                                  :to => Params['to_email'],
+                                                  :immediate_at => 'FATAL,ERROR',
+                                                  :authtype => :plain,
+                                                  :tls => true,
+                                                  :formatfirst => true,
+                                                  :buffsize => 9999,
+      )
+      email_outputter.level = Log4r::ERROR
+      email_outputter.formatter = formatter
+      @log4r.outputters << email_outputter
     end
 
-    # Adding consumer to the logger
-    def Log.add_consumer consumer
-      @consumers.push consumer
-    end
+    # Write init message and user parameters
+    @log4r.info('BBFS Log initialized.')  # log first data
+    Params.get_init_messages().each { |msg|
+      @log4r.info(msg)
+    }
+  end
 
-    # formatting the data and push to consumers
-    def Log.basic msg, type
-      Log.init if not @log_initialized
-       /([a-zA-Z0-9\-_\.]+:\d+)/ =~ caller[1]
-       data = "[BBFS LOG] [#{Time.now()}] [#{type}] [#{$1}] [#{msg}]"
-       @consumers.each { |consumer| consumer.push_data data  }
-    end
+  # Auxiliary method to add the calling method to the message
+  def Log.msg_with_caller(msg)
+    /([a-zA-Z0-9\-_\.]+:\d+)/ =~ caller[1]
+    $1 + ':' + msg
+  end
 
-    # Log warning massages
-    def Log.warning msg
-      Log.basic msg, 'WARNING'
-    end
+  # Log warning massages
+  def Log.warning(msg)
+    Log.init if @log4r.nil?
+    @log4r.warn(msg_with_caller(msg))
+    Log.flush if Params['log_flush_each_message']
+  end
 
-    # Log error massages
-    def Log.error msg
-      Log.basic msg, 'ERROR'
-    end
+  # Log error massages
+  def Log.error(msg)
+    Log.init if @log4r.nil?
+    @log4r.error(msg_with_caller(msg))
+    Log.flush if Params['log_flush_each_message']
+  end
 
-    # Log info massages
-    def Log.info msg
-      Log.basic msg, 'INFO'
-    end
+  # Log info massages
+  def Log.info(msg)
+    Log.init if @log4r.nil?
+    @log4r.info(msg_with_caller(msg))
+    Log.flush if Params['log_flush_each_message']
+  end
 
-    # Log debug level 1 massages
-    def Log.debug1 msg
-      if Params['log_debug_level'] > 0 then
-        Log.basic msg, 'DEBUG-1'
-      end
+  # Log debug level 1 massages
+  def Log.debug1(msg)
+    if Params['log_debug_level'] >= 1
+      Log.init if @log4r.nil?
+      @log4r.debug(msg_with_caller(msg))
+      Log.flush if Params['log_flush_each_message']
     end
+  end
 
-    # Log debug level 2 massages
-    def Log.debug2 msg
-      if Params['log_debug_level'] > 1 then
-        Log.basic msg, 'DEBUG-2'
-      end
+  # Log debug level 2 massages
+  def Log.debug2(msg)
+    if Params['log_debug_level'] >= 2
+      Log.init if @log4r.nil?
+      @log4r.debug(msg_with_caller(msg))
+      Log.flush if Params['log_flush_each_message']
     end
+  end
 
-    # Log debug level 3 massages
-    def Log.debug3 msg
-      if Params['log_debug_level'] > 2 then
-        Log.basic msg, 'DEBUG-3'
-      end
+  # Log debug level 3 massages
+  def Log.debug3(msg)
+    if Params['log_debug_level'] >= 3
+      Log.init if @log4r.nil?
+      @log4r.debug(msg_with_caller(msg))
+      Log.flush if Params['log_flush_each_message']
     end
+  end
 
+  # Flush email log
+  def Log.flush()
+    return if @log4r.nil?
+    @log4r.outputters.each { |o|
+      # Not flushing to email since this will cause empty emails to be sent
+      # Email is already configured to immediately send mail on ERROR|FATAL messages.
+      o.flush unless o.is_a?(Log4r::EmailOutputter)
+    }
   end
+
+  private_class_method(:msg_with_caller)
 end

data/lib/log/version.rb

@@ -1,5 +1,3 @@
-module BBFS
-  module Log
-    VERSION = "0.0.10"
-  end
+module Log
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: log
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-02 00:00:00.000000000Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: params
-  requirement: &19845920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,28 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19845920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: log4r
+  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'
 description: logging data to file, console etc. Data can be pushed using info\warning\error\debug-levels
   categories
 email: yaron.dror.bb@gmail.com
@@ -30,10 +51,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/log.rb
-- lib/log/log_consumer.rb
 - lib/log/version.rb
-- test/log/log_test.rb
-homepage: http://github.com/yarondbb/bbfs
+homepage: http://github.com/bbfsdev/bbfs
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -53,9 +72,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Library for logging data.
-test_files:
-- test/log/log_test.rb
+test_files: []

data/lib/log/log_consumer.rb

@@ -1,102 +0,0 @@
-# Author: Yaron Dror (yaron.dror.bb@gmail.com)
-# Description: Implementation of the Log module - consumer\producer library.
-# Note: The library could be enhance in the future due to project requirement (such as logging
-# to mail, archives, remote servers etc)
-
-require 'thread'
-require 'params'
-
-module BBFS
-
-  module Log
-    Params.float 'log_param_thread_sleep_time_in_seconds', 0.5 , \
-    'log param. Thread sleep time in seconds'
-
-    # Base class for all consumers
-    # Child consumers must implement the 'consume' virtual method
-    class Consumer
-      # Initializes the consumer queue and starts a thread. The thread waits for data
-      # on the queue, and when data is popped, activates the virtual 'consume' method.
-      def initialize
-        @consumer_queue = Queue.new
-        Thread.new do
-          while (true)
-            consume @consumer_queue.pop
-          end
-        end
-      end
-
-      # push incoming data to the consumer queue
-      def push_data data
-        @consumer_queue.push data.clone
-      end
-    end
-
-    # BufferConsumerProducer acts as a consumer and as a producer.
-    # It has it's own consumers which are added to it.
-    # It saves all the data it consumes in a buffer which has a size and time limits.
-    # When one of the limits is exceeded, it flushes the buffer to it's own consumers
-    class BufferConsumerProducer < Consumer
-      def initialize buffer_size_in_mega_bytes, buffer_time_out_in_seconds
-        super()
-        @buffer_size_in_bytes = buffer_size_in_mega_bytes * 1000000
-        @buffer_time_out_in_seconds = buffer_time_out_in_seconds
-        @time_at_last_flush = Time.now.to_i
-        @buffer = []
-        @consumers = []
-        Thread.new do
-          while (true)
-            if @consumer_queue.empty? then
-              @consumer_queue.push nil
-              sleep Params['log_param_thread_sleep_time_in_seconds']
-            end
-          end
-        end
-      end
-
-      def add_consumer consumer
-        @consumers.push consumer
-      end
-
-      def consume data
-        @buffer.push data if not data.nil?
-        if (@buffer.inspect.size >= @buffer_size_in_bytes) or
-            ((Time.now.to_i - @time_at_last_flush) >= @buffer_time_out_in_seconds) then
-          flush_to_consumers
-        end
-      end
-
-      # flush the DB to the consumers
-      def flush_to_consumers
-        @consumers.each { |consumer| consumer.push_data @buffer}
-        @buffer.clear
-        @time_at_last_flush = Time.now.to_i
-      end
-    end
-
-    # The console consumer logs the data to the standard output
-    class ConsoleConsumer < Consumer
-      def consume data
-        puts data
-      end
-    end
-
-    # The file consumer logs the data to a file
-    class FileConsumer < Consumer
-      def initialize file_name
-        super()
-        @file_name = file_name
-        if File.exist? @file_name then
-          File.delete @file_name
-        end
-      end
-
-      def consume data
-        FileUtils.mkdir_p(File.dirname(@file_name))
-        file_handler = File.new @file_name, 'a'
-        file_handler.puts data
-        file_handler.close
-      end
-    end
-  end
-end

data/test/log/log_test.rb

@@ -1,165 +0,0 @@
-# Author: Yaron Dror (yaron.dror.bb@gmail.com)
-# Description: Log test file.
-# run: rake test.
-# Note: This file will be tested along with all project tests.
-
-require 'params'
-require 'test/unit'
-require_relative '../../lib/log.rb'
-require_relative '../../lib/log/log_consumer.rb'
-
-module BBFS
-
-  module Log
-    # Creating a test consumer class to be able to read the data pushed
-    # to the consumer by the logger
-    class TestConsumer < Consumer
-      attr_reader :test_queue
-
-      def initialize
-        super
-        @test_queue = Queue.new()
-      end
-
-      def consume data
-        @test_queue.push data
-      end
-    end
-
-    class TestLog < Test::Unit::TestCase
-
-      LOG_TEST_FILE_NAME = 'log_test.rb:'
-      LOG_PREFIX = 'BBFS LOG'
-
-      def initialize name
-        super
-        Params['log_write_to_console'] = false
-        Params['log_write_to_file'] = false
-        Log.init
-        @test_consumer = TestConsumer.new
-        Log.add_consumer @test_consumer
-        @line_regexp = Regexp.new(/\[(.*)\] \[(.*)\] \[(.*)\] \[(.*)\] \[(.*)\]/)
-      end
-
-      #check expected format: [LOG_PREFIX] [Time] [INFO] [FILE_NAME:LINE] [MESSAGE]
-      def assert_message line, time, type, file_line, msg
-        format_containers = @line_regexp.match(line)
-        assert_equal format_containers.captures.size, 5
-        if format_containers.captures.size == 5 then
-          assert_equal format_containers.captures[0], LOG_PREFIX
-          assert_equal format_containers.captures[1], time.to_s
-          assert_equal format_containers.captures[2], type
-          assert_equal format_containers.captures[3], file_line
-          assert_equal format_containers.captures[4], msg
-        end
-      end
-
-      def test_check_info_format
-        #set test phase
-        test_message = 'This is a test INFO message.'
-        testTime = Time.now
-        Log.info test_message
-        line = __LINE__ - 1
-        #check test phase
-        pop_message = @test_consumer.test_queue.pop
-        assert_message pop_message, testTime, 'INFO', LOG_TEST_FILE_NAME + line.to_s, test_message
-      end
-
-      def test_check_warning_format
-        #set test phase
-        test_message = 'This is a test WARNING message.'
-        testTime = Time.now
-        Log.warning test_message
-        line = __LINE__ - 1
-
-        #check test phase
-        pop_message = @test_consumer.test_queue.pop
-        assert_message pop_message, testTime, 'WARNING', LOG_TEST_FILE_NAME + line.to_s, test_message
-      end
-
-      def test_check_error_format
-        #set test phase
-        test_message = 'This is a test ERROR message.'
-        testTime = Time.now
-        Log.error test_message
-        line = __LINE__ - 1
-
-        #check test phase
-        pop_message = @test_consumer.test_queue.pop
-        assert_message pop_message, testTime, 'ERROR', LOG_TEST_FILE_NAME + line.to_s, test_message
-      end
-
-      def test_check_debug_level_0
-        #set test phase
-        Params['log_debug_level'] = 0
-        Log.debug1 'This is a test debug-1 message.'
-        Log.debug2 'This is a test debug-2 message.'
-        Log.debug3 'This is a test debug-3 message.'
-        #check test phase
-        queue_size = @test_consumer.test_queue.size
-        assert_equal queue_size, 0 , \
-          "At debug level 0, no debug messages should be found.Test found:#{queue_size} messages."
-      end
-
-      def test_check_debug_level_1
-        #set test phase
-        Params['log_debug_level'] = 1
-        test_message_1 = 'This is a test DEBUG-1 message.'
-        test_message_2 = 'This is a test DEBUG-2 message.'
-        test_message_3 = 'This is a test DEBUG-3 message.'
-        testTime = Time.now
-        Log.debug1 test_message_1
-        line = __LINE__ - 1
-        Log.debug2 test_message_2
-        Log.debug3 test_message_3
-
-        #check test phase
-        pop_message = @test_consumer.test_queue.pop
-        assert_message pop_message, testTime, 'DEBUG-1', LOG_TEST_FILE_NAME + line.to_s, test_message_1
-      end
-
-      def test_check_debug_level_2
-        #set test phase
-        Params['log_debug_level'] = 2
-        test_message_1 = 'This is a test DEBUG-1 message.'
-        test_message_2 = 'This is a test DEBUG-2 message.'
-        test_message_3 = 'This is a test DEBUG-3 message.'
-        testTime = Time.now
-        Log.debug1 test_message_1
-        line_1 = __LINE__ - 1
-        Log.debug2 test_message_2
-        line_2 = __LINE__ - 1
-        Log.debug3 test_message_3
-
-        #check test phase
-        pop_message = @test_consumer.test_queue.pop
-        assert_message pop_message, testTime, 'DEBUG-1', LOG_TEST_FILE_NAME + line_1.to_s, test_message_1
-        pop_message = @test_consumer.test_queue.pop
-        assert_message pop_message, testTime, 'DEBUG-2', LOG_TEST_FILE_NAME + line_2.to_s, test_message_2
-      end
-
-      def test_check_debug_level_3
-        #set test phase
-        Params['log_debug_level'] = 3
-        test_message_1 = 'This is a test DEBUG-1 message.'
-        test_message_2 = 'This is a test DEBUG-2 message.'
-        test_message_3 = 'This is a test DEBUG-3 message.'
-        testTime = Time.now
-        Log.debug1 'This is a test DEBUG-1 message.'
-        line_1 = __LINE__ - 1
-        Log.debug2 'This is a test DEBUG-2 message.'
-        line_2 = __LINE__ - 1
-        Log.debug3 'This is a test DEBUG-3 message.'
-        line_3 = __LINE__ - 1
-
-        #check test phase
-        pop_message = @test_consumer.test_queue.pop
-        assert_message pop_message, testTime, 'DEBUG-1', LOG_TEST_FILE_NAME + line_1.to_s, test_message_1
-        pop_message = @test_consumer.test_queue.pop
-        assert_message pop_message, testTime, 'DEBUG-2', LOG_TEST_FILE_NAME + line_2.to_s, test_message_2
-        pop_message = @test_consumer.test_queue.pop
-        assert_message pop_message, testTime, 'DEBUG-3', LOG_TEST_FILE_NAME + line_3.to_s, test_message_3
-      end
-    end
-  end
-end