log4r 1.1.5 → 1.1.6

data/README

@@ -1,8 +1,8 @@
 Log4r - A flexible logging library for Ruby
 
 
-This release:      1.1.5 
-Release date:      02/Feb/2010
+This release:      1.1.6 
+Release date:      11/Mar/2010
 License:           Ruby's 
 Maintainer:        Colby Gutierrez-Kraybill
 Contributors:      Leon Torres          Original Maintainer
@@ -10,6 +10,7 @@ Contributors:      Leon Torres          Original Maintainer
                    Steve Lumos          SyslogOutputter
                    Andreas Hund         YamlConfigurator
                    Jamis Buck           log4r.gemspec
+		   Charles Strahan	log4jxml/chainsaw integration
 Homepage:          http://rubyforge.org/projects/log4r/
 Download:          http://rubyforge.org/frs/?group_id=203
 
@@ -30,6 +31,7 @@ Requirements
 * (optional) RubyGems for installing Log4r as a gem
 * (optional) Ruby syslog library for SyslogOutputter
 * (optional) XML configuration requires REXML
+* (optional) log4j chainsaw integration requires 'builder' >= 2.0
 
 
 More Info
@@ -87,4 +89,4 @@ code yourself. It's well documented and written in Ruby. :)
 Also, try out the bug/request tracking system at 
 http://rubyforge.org/tracker/?group_id=203
 
-Version: $Id: README,v 1.8 2010/02/03 05:16:27 colbygk Exp $
+Version: $Id: README,v 1.9 2010/03/11 23:00:56 colbygk Exp $

data/Rakefile

@@ -1,5 +1,5 @@
 
-# $Id: Rakefile,v 1.8 2010/02/08 20:18:55 colbygk Exp $
+# $Id: Rakefile,v 1.9 2010/03/11 23:00:56 colbygk Exp $
 
 # incorporated from Revolution Health version of log4r
 
@@ -10,7 +10,7 @@ require 'date'
 require 'fileutils'
 
 GEM = "log4r"
-GEM_VERSION = "1.1.5"
+GEM_VERSION = "1.1.6"
 AUTHOR = "Colby Gutierrez-Kraybill"
 EMAIL = "colby@astro.berkeley.edu"
 HOMEPAGE = %q{http://log4r.rubyforge.org}

data/examples/chainsaw_settings.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
+<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/" debug="true">
+  <plugin name="log4r_test" class="org.apache.log4j.net.UDPReceiver">
+    <param name="Port" value="8071" />
+  </plugin>
+</log4j:configuration>

data/src/log4r.rb

@@ -3,7 +3,7 @@
 # == Other Info
 #
 # Author::      Leon Torres
-# Version::     $Id: log4r.rb,v 1.8 2010/02/03 05:16:12 colbygk Exp $
+# Version::     $Id: log4r.rb,v 1.9 2010/03/11 22:59:51 colbygk Exp $
 
 require "log4r/outputter/fileoutputter"
 require "log4r/outputter/consoleoutputters"
@@ -16,5 +16,5 @@ require "log4r/NDC"
 require "log4r/MDC"
 
 module Log4r
-  Log4rVersion = [1, 1, 5].join '.'
+  Log4rVersion = [1, 1, 6].join '.'
 end

data/src/log4r/formatter/log4jxmlformatter.rb

@@ -0,0 +1,61 @@
+# :include: ../rdoc/log4jxmlformatter
+#
+# == Other Info
+#
+# Version:: $Id: log4jxmlformatter.rb,v 1.2 2010/03/11 23:38:22 colbygk Exp $
+
+require "log4r/formatter/formatter"
+
+require "rubygems"
+require "builder"
+
+module Log4r
+
+  class Log4jXmlFormatter < BasicFormatter
+    
+    def format(logevent)
+      logger = logevent.fullname.gsub('::', '.')
+      timestamp = (Time.now.to_f * 1000).to_i
+      level = LNAMES[logevent.level]
+      message = format_object(logevent.data)
+      exception = message if logevent.data.kind_of? Exception
+      file, line, method = parse_caller(logevent.tracer[0]) if logevent.tracer
+      
+      builder = Builder::XmlMarkup.new
+      xml = builder.log4j :event, :logger => logger,
+                                  :timestamp => timestamp,
+                                  :level => level,
+                                  :thread => '' do |e|
+              e.log4j :NDC, NDC.get
+              e.log4j :message, message
+              e.log4j :throwable, exception if exception
+              e.log4j :locationInfo, :class => '',
+                                     :method => method,
+                                     :file => file,
+                                     :line => line
+              e.log4j :properties do |p|
+                MDC.get_context.each do |key, value|
+                  p.log4j :data, :name => key, :value => value
+                end
+              end
+            end
+      xml
+    end
+
+    #######
+    private
+    #######
+
+    def parse_caller(line)
+      if /^(.+?):(\d+)(?::in `(.*)')?/ =~ line
+        file = Regexp.last_match[1]
+        line = Regexp.last_match[2].to_i
+        method = Regexp.last_match[3]
+        [file, line, method]
+      else
+        []
+      end
+    end
+  end
+
+end

data/src/log4r/outputter/datefileoutputter.patch

@@ -0,0 +1,24 @@
+--- datefileoutputter.rb	2004-03-18 19:31:09.000000000 -0800
++++ new-datefileoutputter.rb	2010-03-11 18:36:37.000000000 -0800
+@@ -54,12 +54,19 @@
+         if not FileTest.directory?( _dirname)
+           raise StandardError, "'#{_dirname}' must be a valid directory", caller
+         end
++      end
++
++      _filename = (hash[:filename] or hash['filename'])
++      if _filename.nil?
+         @filebase = File.basename( $0, '.rb') + ".log"
+       else
+         @filebase = File.basename((hash[:filename] or hash['filename'] or ""))
+       end
+-      hash['filename'] = File.join(_dirname,
+-                    @filebase.sub(/(\.\w*)$/, "_#{@DateStamp}" + '\1'))
++
++      # Get rid of the 'nil' in the path
++      path = [_dirname, @filebase.sub(/(\.\w*)$/, "_#{@DateStamp}" + '\1')].compact
++      hash[:filename] = hash['filename'] = File.join(path)
++
+       super(_name, hash)
+     end
+ 

data/src/log4r/outputter/datefileoutputter.rb

@@ -54,12 +54,19 @@ module Log4r
         if not FileTest.directory?( _dirname)
           raise StandardError, "'#{_dirname}' must be a valid directory", caller
         end
+      end
+
+      _filename = (hash[:filename] or hash['filename'])
+      if _filename.nil?
         @filebase = File.basename( $0, '.rb') + ".log"
       else
         @filebase = File.basename((hash[:filename] or hash['filename'] or ""))
       end
-      hash['filename'] = File.join(_dirname,
-                    @filebase.sub(/(\.\w*)$/, "_#{@DateStamp}" + '\1'))
+
+      # Get rid of the 'nil' in the path
+      path = [_dirname, @filebase.sub(/(\.\w*)$/, "_#{@DateStamp}" + '\1')].compact
+      hash[:filename] = hash['filename'] = File.join(path)
+
       super(_name, hash)
     end
 

data/src/log4r/outputter/diff

@@ -0,0 +1,14 @@
+56a57,60
+>       end
+> 
+>       _filename = (hash[:filename] or hash['filename'])
+>       if _filename.nil?
+61,62c65,69
+<       hash['filename'] = File.join(_dirname,
+<                     @filebase.sub(/(\.\w*)$/, "_#{@DateStamp}" + '\1'))
+---
+> 
+>       # Get rid of the 'nil' in the path
+>       path = [_dirname, @filebase.sub(/(\.\w*)$/, "_#{@DateStamp}" + '\1')].compact
+>       hash[:filename] = hash['filename'] = File.join(path)
+> 

data/src/log4r/outputter/new-datefileoutputter.rb

@@ -0,0 +1,117 @@
+# = DateFileOutputter
+#
+# Subclass of FileOutputter that changes the log file daily. When a new
+# day begins, a new file is created with the date included in the name.
+#
+# == Usage
+#
+#   df_out = DateFileOutputter.new('name',
+#              :dirname="/tmp", :date_pattern=>"%m-%d" 
+#            )
+#
+# == Rate of Change
+#
+# A new logfile is created whenever the current time as formatted by the date
+# pattern no longer matches the previous time. (This is a simple String 
+# comparison.) So, in order to change the frequency of the rollover, just
+# alter the date pattern to match how fast the files should be generated. 
+# For instance, to generate files by the minute,
+#
+#   df_out.date_pattern = "%M"
+#
+# This causes the following files to show up one minute apart, asuming the
+# script starts at the 4th minute of the hour:
+#
+#   file_04.rb
+#   file_05.rb
+#   file_06.rb
+#   ...
+#
+# The only limitation of this approach is that the precise time cannot be
+# recorded as the smallest time interval equals the rollover period for this
+# system.
+
+require "log4r/outputter/fileoutputter"
+require "log4r/staticlogger"
+
+module Log4r
+
+  # Additional hash arguments are:
+  #
+  # [<tt>:dirname</tt>]         Directory of the log file
+  # [<tt>:date_pattern</tt>]    Time.strftime format string (default is "%Y-%m-%d")
+
+  class DateFileOutputter < FileOutputter
+    DEFAULT_DATE_FMT = "%Y-%m-%d"
+
+    def initialize(_name, hash={})
+      @DatePattern = (hash[:date_pattern] or hash['date_pattern'] or
+                      DEFAULT_DATE_FMT)
+      @DateStamp = Time.now.strftime( @DatePattern);
+      _dirname = (hash[:dirname] or hash['dirname'])
+      # hash[:dirname] masks hash[:filename]
+      if _dirname
+        if not FileTest.directory?( _dirname)
+          raise StandardError, "'#{_dirname}' must be a valid directory", caller
+        end
+      end
+
+      _filename = (hash[:filename] or hash['filename'])
+      if _filename.nil?
+        @filebase = File.basename( $0, '.rb') + ".log"
+      else
+        @filebase = File.basename((hash[:filename] or hash['filename'] or ""))
+      end
+
+      # Get rid of the 'nil' in the path
+      path = [_dirname, @filebase.sub(/(\.\w*)$/, "_#{@DateStamp}" + '\1')].compact
+      hash[:filename] = hash['filename'] = File.join(path)
+
+      super(_name, hash)
+    end
+
+    #######
+    private
+    #######
+
+    # perform the write
+    def write(data)
+      change if requiresChange
+      super
+    end
+
+    # construct a new filename from the DateStamp
+    def makeNewFilename
+        @DateStamp = Time.now.strftime( @DatePattern);
+        @filename = File.join(File.dirname(@filename),
+                    @filebase.sub(/(\.\w*)$/, "_#{@DateStamp}" + '\1'))
+    end
+
+    # does the file require a change?
+    def requiresChange
+      _DateStamp = Time.now.strftime( @DatePattern);
+      if not _DateStamp == @DateStamp
+        @DateStamp = _DateStamp
+        return true
+      end
+      false
+    end
+
+    # change the file 
+    def change
+      begin
+        @out.close
+      rescue
+        Logger.log_internal {
+          "DateFileOutputter '#{@name}' could not close #{@filename}"
+        }
+      end
+      makeNewFilename
+      @out = File.new(@filename, (@trunc ? "w" : "a"))
+      Logger.log_internal {
+        "DateFileOutputter '#{@name}' now writing to #{@filename}"
+      }
+    end
+  end
+
+end

data/src/log4r/outputter/udpoutputter.rb

@@ -0,0 +1,53 @@
+# :include: ../rdoc/outputter
+#
+# == Other Info
+#
+# Version:: $Id: udpoutputter.rb,v 1.2 2010/03/11 23:38:36 colbygk Exp $
+# Author:: Leon Torres <leon@ugcs.caltech.edu>
+
+require "log4r/outputter/outputter"
+require 'log4r/staticlogger'
+require "socket"
+
+module Log4r
+
+  class UDPOutputter < Outputter
+    attr_reader :host, :port
+    attr_accessor :udpsock
+     
+    def initialize(_name, _host, _port, hash={})
+      super(_name, hash)
+      @host = _host
+      @port = _port
+
+      begin 
+	Logger.log_internal {
+	  "UDPOutputter will send to #{@host}:#{@port}"
+	}
+	@udpsock = UDPSocket.new
+	@udpsock.connect( @host, @port )
+      rescue Exception => e
+	Logger.log_internal(ERROR) {
+	  "UDPOutputter failed to create UDP socket: #{e}"
+	}
+	Logger.log_internal {e}
+	self.level = OFF
+	raise e
+      end
+    end
+
+    #######
+    private
+    #######
+
+    def write(data)
+      @udpsock.send(data, 0)
+    rescue Exception => e
+      Logger.log_internal(ERROR) {
+	"UDPOutputter failed to send data to #{@host}:#{@port}, #{e}"
+      }
+    end
+    
+  end
+
+end

data/tests/testchainsaw.rb

@@ -0,0 +1,48 @@
+$: << File.join("..", "src")
+
+require 'log4r'
+require 'log4r/staticlogger'
+require 'log4r/formatter/log4jxmlformatter'
+require 'log4r/outputter/udpoutputter'
+require 'log4r/outputter/consoleoutputters'
+
+include Log4r
+
+log4r = Logger.new 'log4r'
+log4r.trace = true
+log4r.outputters = StdoutOutputter.new 'log4r'
+log4r.level = ALL
+
+formatter = Log4jXmlFormatter.new
+outputter = UDPOutputter.new 'udp', "localhost", 8071
+outputter.formatter = formatter
+
+mylog = Logger.new 'mylog'
+mylog.trace = true
+mylog.outputters = [outputter]
+
+# Log4r::Formatter throws when formatting
+# an excpetion with a nil backtrace (line 73).
+def get_exception(msg)
+  begin
+    raise msg
+  rescue Exception => e
+    e
+  end
+end
+
+NDC.push "saw test"
+
+MDC.put "clientip", %q{10.33.33.33}
+
+def do_log(log)
+    log.debug "This is a message with level DEBUG"
+    log.info "This is a message with level INFO"
+    log.warn "This is a message with level WARN"
+    log.error "This is a message with level ERROR"
+    log.fatal "This is a message with level FATAL"
+
+    log.fatal get_exception( "This is an exception" )
+end
+
+do_log(mylog)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: log4r
 version: !ruby/object:Gem::Version 
-  version: 1.1.5
+  version: 1.1.6
 platform: ruby
 authors: 
 - Colby Gutierrez-Kraybill
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-08 00:00:00 -08:00
+date: 2010-03-11 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -43,6 +43,7 @@ files:
 - doc/log4r.css
 - doc/rdoc-log4r.css
 - doc/templates/main.html
+- examples/chainsaw_settings.xml
 - examples/customlevels.rb
 - examples/filelog.rb
 - examples/fileroll.rb
@@ -64,6 +65,7 @@ files:
 - src/log4r/config.rb
 - src/log4r/configurator.rb
 - src/log4r/formatter/formatter.rb
+- src/log4r/formatter/log4jxmlformatter.rb
 - src/log4r/formatter/patternformatter.rb
 - src/log4r/GDC.rb
 - src/log4r/lib/drbloader.rb
@@ -75,16 +77,20 @@ files:
 - src/log4r/MDC.rb
 - src/log4r/NDC.rb
 - src/log4r/outputter/consoleoutputters.rb
+- src/log4r/outputter/datefileoutputter.patch
 - src/log4r/outputter/datefileoutputter.rb
+- src/log4r/outputter/diff
 - src/log4r/outputter/emailoutputter.rb
 - src/log4r/outputter/fileoutputter.rb
 - src/log4r/outputter/iooutputter.rb
+- src/log4r/outputter/new-datefileoutputter.rb
 - src/log4r/outputter/outputter.rb
 - src/log4r/outputter/outputterfactory.rb
 - src/log4r/outputter/remoteoutputter.rb
 - src/log4r/outputter/rollingfileoutputter.rb
 - src/log4r/outputter/staticoutputter.rb
 - src/log4r/outputter/syslogoutputter.rb
+- src/log4r/outputter/udpoutputter.rb
 - src/log4r/rdoc/configurator
 - src/log4r/rdoc/emailoutputter
 - src/log4r/rdoc/formatter
@@ -106,6 +112,7 @@ files:
 - tests/README
 - tests/testall.rb
 - tests/testbase.rb
+- tests/testchainsaw.rb
 - tests/testconf.xml
 - tests/testcustom.rb
 - tests/testformatter.rb