green_syslogger 0.1.2 → 0.2.0

data/Manifest

@@ -1,5 +1,6 @@
 Manifest
 README.md
 Rakefile
+green_syslogger.gemspec
 lib/green_syslogger.rb
 test/green_syslogger_test.rb

data/README.md

@@ -4,6 +4,14 @@
 
 Syslogger that makes your life greener
 
+Custom Rails Logger
+
+* Use Syslog like back storage
+* Posibility to use custom 'facility'
+* Posibility to use custom 'tag'
+* Posibility to use custom 'tag' only in a concrete point so you can configure Syslog to filter this concrete message to another file
+* Compatible with `config.logger.auto_flushing = false` so every log of a simple request will be written on an atomic way
+
 ## Install
 
     $ [sudo] gem install green_syslogger
@@ -13,34 +21,45 @@ Syslogger that makes your life greener
     require 'green_syslogger'
     logger = GreenSyslogger.new
     logger.debug( 'debug message' )
-   
-To configure it on the <RAILS_ENVIRONMENT>.rb:
 
+To install it configure it on the <RAILS_ENVIRONMENT>.rb:
     config.logger = GreenSyslogger.new(<default tag>, <facility>, <level>)
 
-
 By default
-
     GreenSyslogger.new('rails', 'local2', :debug)
 
+Example for Rails configuration:
+
+    config.log_level = :info
+    config.logger = GreenSyslogger.new('myapp', 'local1', config.log_level)
+    config.colorize_logging = false
+    config.logger.auto_flushing = false
 
 To use it: 
 
     logger.debug("my debug message")
     logger.error("my error message")
 
-
 To user another tag:
 
     logger.custom("my custom message", <tag>, <level>)
 
-
 By default:
 
     logger.custom("my custom message", 'custom', :info)
 
 ## TODO
 
+In the `GreenSyslogger.custom` there are two reopen connections just to be allowed to change the `tag`, could be better to change the `tag` without reconnect.
+
+There is not `GreenSyslogger.silencer`. Maybe is a good idea to implemented.
+
+## Change log
+
+### v 0.2.0
+
+* Compatible with `config.logger.auto_flushing = false` so every log of a simple request will be written on an atomic way
+
 
 ## Credits
 

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'  
 require 'echoe'  
   
-Echoe.new('green_syslogger', '0.1.2') do |p|  
+Echoe.new('green_syslogger', '0.2.0') do |p|  
   p.description     = "Syslogger that makes your life greener"  
   p.url             = "https://github.com/SponsorPay/GreenSyslogger"  
   p.author          = "Fernando Guillen <http://fernandoguillen.info> & Juan Jose Vidal <@j2vidal>"

data/green_syslogger.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{green_syslogger}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Fernando Guillen <http://fernandoguillen.info> & Juan Jose Vidal <@j2vidal>"]
-  s.date = %q{2010-11-09}
+  s.date = %q{2010-11-12}
   s.description = %q{Syslogger that makes your life greener}
   s.email = %q{fguillen.mail@gmail.com}
   s.extra_rdoc_files = ["README.md", "lib/green_syslogger.rb"]
-  s.files = ["Manifest", "README.md", "Rakefile", "lib/green_syslogger.rb", "test/green_syslogger_test.rb", "green_syslogger.gemspec"]
+  s.files = ["Manifest", "README.md", "Rakefile", "green_syslogger.gemspec", "lib/green_syslogger.rb", "test/green_syslogger_test.rb"]
   s.homepage = %q{https://github.com/SponsorPay/GreenSyslogger}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Green_syslogger", "--main", "README.md"]
   s.require_paths = ["lib"]

data/lib/green_syslogger.rb

@@ -1,14 +1,27 @@
 require 'syslog'
 
 #
-# Custom log
+# Custom Rails Logger
 #
-# To install it cofigure it on the <RAILS_ENVIRONMENT>.rb:
+# * Use Syslog like back storage
+# * Posibility to use custom 'facility'
+# * Posibility to use custom 'tag'
+# * Posibility to use custom 'tag' only in a concrete point so you can configure Syslog to filter this concrete message to another file
+# * Compatible with `config.logger.auto_flushing = false` so every log of a simple request will be written on an atomic way
+#
+# To install it configure it on the <RAILS_ENVIRONMENT>.rb:
 #    config.logger = GreenSyslogger.new(<default tag>, <facility>, <level>)
 #
 # By default
 #     GreenSyslogger.new('rails', 'local2', :debug)
 #
+# Example for Rails configuration:
+#
+#    config.log_level = :info
+#    config.logger = GreenSyslogger.new('myapp', 'local1', config.log_level)
+#    config.colorize_logging = false
+#    config.logger.auto_flushing = false
+#
 # To use it: 
 #
 #    logger.debug("my debug message")
@@ -32,62 +45,114 @@ class GreenSyslogger
     :warn     => [:warning  , 2],
     :error    => [:err      , 3],
     :fatal    => [:emerg    , 4],
-    :unknown  => [:debub    , 5]
+    :unknown  => [:debug    , 5]
   }
   
-  DEFAULT_CONF  = [ Syslog::LOG_PID, Syslog::LOG_LOCAL2 ]
+  DEFAULT_MAX_BUFFER_SIZE = 500
   
   def initialize(tag = 'rails', facility = 'local2', level = :debug)
     @tag = tag
     @facility = facility
     @level = level
-    @syslog = Syslog.open( @tag, Syslog::LOG_PID, Syslog.const_get( "LOG_#{@facility.upcase}" ) )
+    @max_buffer_size = 1
+    @buffer = {}
+    @guard = Mutex.new
+    @syslog = Syslog.open(@tag, Syslog::LOG_PID, Syslog.const_get("LOG_#{@facility.upcase}"))
   end
   
   def close
     @syslog.close
   end
-  
-  def opened?
-    @syslog.opened?
-  end
 
+  # This method is a kind of a back door, using it you can 
+  # change the 'tag' with this message is tagged.
+  #
   # level default to 'info'
   # tag default 'ids-custom'
   def custom(message, tag = 'custom', level = :info)
-    @syslog = Syslog.reopen( tag, Syslog::LOG_PID, Syslog.const_get( "LOG_#{@facility.upcase}" ) )
-    self.log(message, level)
-    @syslog = Syslog.reopen( @tag, Syslog::LOG_PID, Syslog.const_get( "LOG_#{@facility.upcase}" ) )
-  end
-  
-  # level default to 'info'
-  def log(message, level = :info)
-    # File.open("/tmp/ids.log", 'w') { |f| f.write(message) }
-    @syslog.send( LEVELS_MAP[level][0], clean( message ) )
+    add(tag, level, message)
   end
   
   LEVELS_MAP.each_key do |level|
     define_method level do |message|
-      if self.send("#{level}?")
-        self.log(message, level)
-      end
+      add(@tag, level, message)
     end
     
     define_method "#{level}?" do
-      LEVELS_MAP[level][1] >= LEVELS_MAP[@level][1]
+      level?(level)
+    end
+  end
+  
+  
+  # If it is set to 'true' every line will be sent in the time is wrotten
+  # If it is set to 'false' the buffer will be flushed at the end of the request by Rails
+  # There is a DEFAULT_MAX_BUFFER_SIZE security buffer size
+  #
+  # only true or false
+  def auto_flushing=(value)
+    @max_buffer_size = value ? 1 : DEFAULT_MAX_BUFFER_SIZE
+  end
+  
+  def flush
+    @guard.synchronize do
+      buffer.each do |buff|
+        date = buff[0]
+        tag = buff[1]
+        level = buff[2]
+        message = buff[3]
+        
+        message = "[#{date.strftime('%Y-%m-%d %H:%M:%S')}] #{message}"
+        
+        if(tag == @tag)
+          @syslog.send(LEVELS_MAP[level][0], message)
+        else
+          @syslog = Syslog.reopen(tag, Syslog::LOG_PID, Syslog.const_get("LOG_#{@facility.upcase}"))
+          @syslog.send(LEVELS_MAP[level][0], message)
+          @syslog = Syslog.reopen(@tag, Syslog::LOG_PID, Syslog.const_get("LOG_#{@facility.upcase}"))
+        end
+      end
     end
+    
+    clear_buffer
   end
   
-  private 
+  
+  private
+  
+    def level?(level)
+      LEVELS_MAP[level][1] >= LEVELS_MAP[@level][1]
+    end
+    
+    def add(tag, level, message)
+      if(level?(level))
+        # The init of the request
+        if( message.gsub!("\n\nStarted", 'Started') )
+          add(tag, level, '---')
+        end
+        
+        buffer << [Time.now, tag, level, message]
+        auto_flush
+      end
+    end
+    
+    def auto_flush
+      self.flush  if buffer.size >= @max_buffer_size
+    end
 
-    # Clean up messages so they're nice and pretty.
-    # Taken from SyslogLogger
-    def clean(message)
-      message = message.to_s.dup
-      message.strip!
-      message.gsub!(/%/, '%%') # syslog(3) freaks on % (printf)
-      message.gsub!(/\e\[[^m]*m/, '') # remove useless ansi color codes
-      return message
+    def buffer
+      @buffer[Thread.current] ||= []
     end
 
+    def clear_buffer
+      @buffer.delete(Thread.current)
+    end
+    
+    # This is really only for debbugging
+    def log_to_file(message)
+      File.open("/tmp/my.log", 'w') do |f| 
+        f.write(">> #{message}\n")
+        f.flush
+      end
+    end
+    
 end

data/test/green_syslogger_test.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'test/unit'
 require 'mocha'
+require 'delorean'
 require File.expand_path(File.dirname(__FILE__) + '/../lib/green_syslogger')
 
 
@@ -18,43 +19,43 @@ class GreenSysloggerTest < Test::Unit::TestCase
   def test_initialize_by_default
     Syslog.expects(:open).with('rails', Syslog::LOG_PID, Syslog::LOG_LOCAL2).returns( @logger.instance_eval('@syslog') )
     @logger = GreenSyslogger.new
+    
+    assert_equal('rails', @logger.instance_eval("@tag"))
+    assert_equal('local2', @logger.instance_eval("@facility"))
     assert_equal(:debug, @logger.instance_eval("@level"))
+    assert_equal(1, @logger.instance_eval("@max_buffer_size"))
   end
   
   def test_initialize_with_params
     Syslog.expects(:open).with('my tag', Syslog::LOG_PID, Syslog::LOG_LOCAL3).returns( @logger.instance_eval('@syslog') )
     @logger = GreenSyslogger.new('my tag', 'local3', :info)
+    
+    assert_equal('my tag', @logger.instance_eval("@tag"))
+    assert_equal('local3', @logger.instance_eval("@facility"))
     assert_equal(:info, @logger.instance_eval("@level"))
+    assert_equal(1, @logger.instance_eval("@max_buffer_size"))
   end
   
   def test_has_a_collection_of_methods
     GreenSyslogger::LEVELS_MAP.each_key do |level|
-      @logger.expects(:log).with(@message, level)
+      @logger.expects(:add).with('rails', level, @message)
       @logger.send(level, @message)
     end
   end
 
-  def test_log
-    @logger.instance_eval('@syslog').expects(:debug).with(@message)
-    @logger.log(@message, :debug)
-  end
-
-  def test_log_cleaned
-    @logger.expects(:clean).with(@message).returns("#{@message} cleaned")
-    @logger.instance_eval('@syslog').expects(:debug).with("#{@message} cleaned")
-    @logger.log(@message, :debug)
-  end
-
-  def test_clean
-    dirty_message = "\x1B[[1m\x1B[[36mSQL (0.339ms)\x1B[[0m  \x1B[[1m select landing_page_id, count(*) cnt from transactions \n where landing_page_id in (4278,4279,4334,4338,4340,4342) \n and status >= 45 and created_at >= '2010-11-08T11:30:22'\n group by landing_page_id\n\x1B[[0m"
-    clean_message = "SQL (0.339ms)   select landing_page_id, count(*) cnt from transactions \n where landing_page_id in (4278,4279,4334,4338,4340,4342) \n and status >= 45 and created_at >= '2010-11-08T11:30:22'\n group by landing_page_id\n"
-
-    assert_equal(clean_message, @logger.send(:clean, dirty_message))
+  def test_debug_with_defaul_initialization
+    @logger.expects(:auto_flush)
+    
+    Delorean.time_travel_to("2010-01-01 10:10:10") do
+      @logger.debug('wadus message')
+    end
+    
+    assert_equal([Time.parse('2010-01-01 10:10:10').to_s, 'rails', 'debug', 'wadus message'], @logger.instance_eval('buffer')[0].map { |e| e.to_s })
   end
 
   def test_log_in_debug_level
     @logger.level = :debug
-    @logger.expects(:log).times(3)
+    @logger.expects(:auto_flush).times(3)
     @logger.debug(@message)
     @logger.info(@message)
     @logger.error(@message)
@@ -62,16 +63,56 @@ class GreenSysloggerTest < Test::Unit::TestCase
 
   def test_log_in_info_level
     @logger.level = :info
-    @logger.expects(:log).times(2)
+    @logger.expects(:auto_flush).times(2)
     @logger.debug(@message)
     @logger.info(@message)
     @logger.error(@message)
   end
 
   def test_log_with_custom_tag
-    Syslog.expects(:reopen).returns(@logger.instance_eval('@syslog')).twice
-    @logger.expects(:log)
-    @logger.custom(@message)
+    @logger.expects(:add).with('my tag', :info, @message)
+    @logger.custom(@message, 'my tag')
+  end
+  
+  def test_auto_flush_activate
+    @logger.auto_flushing = true
+    @logger.expects(:flush).times(1)
+    @logger.debug('wadus message')
+  end
+
+  def test_auto_flush_deactivate
+    old_max_buffer_size = GreenSyslogger::DEFAULT_MAX_BUFFER_SIZE
+    GreenSyslogger.send(:remove_const, :DEFAULT_MAX_BUFFER_SIZE)
+    GreenSyslogger.const_set(:DEFAULT_MAX_BUFFER_SIZE, 3)
+    
+    @logger.auto_flushing = false
+    @logger.expects(:flush).times(1)
+    
+    @logger.debug('wadus message')
+    @logger.debug('wadus message')
+    @logger.debug('wadus message')
+    
+    GreenSyslogger.send(:remove_const, :DEFAULT_MAX_BUFFER_SIZE)
+    GreenSyslogger.const_set(:DEFAULT_MAX_BUFFER_SIZE, old_max_buffer_size)
   end
+  
+  def test_flush
+    @syslog = @logger.instance_eval('@syslog')
+    Syslog.expects(:reopen).returns(@syslog).times(2)
+    @syslog.expects(:debug).times(2)
+    @syslog.expects(:info).times(2)
+    
+    @logger.auto_flushing = false
+    @logger.debug('wadus debug')
+    @logger.info('wadus info')
+    @logger.custom('wadus custom tag info', 'new tag', :info)
+    @logger.debug('wadus info again')
 
+    @logger.flush
+  end
+  
+  def test_especial_case_init_of_request
+    @logger.expects(:auto_flush).twice
+    @logger.info("\n\nStarted")
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: green_syslogger
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Fernando Guillen <http://fernandoguillen.info> & Juan Jose Vidal <@j2vidal>
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-09 00:00:00 +01:00
+date: 2010-11-12 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -32,9 +32,9 @@ files:
 - Manifest
 - README.md
 - Rakefile
+- green_syslogger.gemspec
 - lib/green_syslogger.rb
 - test/green_syslogger_test.rb
-- green_syslogger.gemspec
 has_rdoc: true
 homepage: https://github.com/SponsorPay/GreenSyslogger
 licenses: []