log4r 1.1.2 → 1.1.3

data/src/log4r/GDC.rb

@@ -0,0 +1,40 @@
+# :include: rdoc/GDC
+#
+# == Other Info
+# 
+# Version:: $Id: GDC.rb,v 1.1 2010/01/12 02:53:43 colbygk Exp $
+# Author:: Colby Gutierrez-Kraybill <colby(at)astro.berkeley.edu>
+
+module Log4r
+  GDCNAME = "log4rGDC"
+
+  # See log4r/GDC.rb
+  class GDC
+    private_class_method :new
+
+    def self.check_thread_instance()
+      if ( Thread.main != Thread.current ):
+	raise "Can only initialize Global Diagnostic Context from Thread.main" 
+      else
+	if ( Thread.main[GDCNAME] == nil ):
+	  Thread.main[GDCNAME] = $0
+	end
+      end
+    end
+
+    def self.clear()
+      check_thread_instance()
+    end
+
+    def self.get()
+      check_thread_instance()
+      return Thread.main[GDCNAME]
+    end
+
+    def self.set( a_name )
+      check_thread_instance()
+      Thread.main[GDCNAME] = a_name
+    end
+  end
+end
+

data/src/log4r/MDC.rb

@@ -0,0 +1,59 @@
+# :include: rdoc/MDC
+#
+# == Other Info
+# 
+# Version:: $Id: MDC.rb,v 1.1 2010/01/12 02:21:29 colbygk Exp $
+# Author:: Colby Gutierrez-Kraybill <colby(at)astro.berkeley.edu>
+
+require 'monitor'
+
+module Log4r
+  MDCNAME = "log4rMDC"
+  MDCNAMEMAXDEPTH = "log4rMDCMAXDEPTH"
+  $globalMDCLock = Monitor.new
+
+  # See log4r/MDC.rb
+  class MDC < Monitor
+    private_class_method :new
+
+    def self.check_thread_instance()
+      # need to interlock here, so that if
+      # another thread is entering this section
+      # of code before the main thread does,
+      # then the main thread copy of the MDC
+      # is setup before then attempting to clone
+      # it off
+      if ( Thread.current[MDCNAME] == nil ) then
+	$globalMDCLock.synchronize do 
+	  if ( Thread.main[MDCNAME] == nil ) then
+	    Thread.main[MDCNAME] = Hash.new
+	  end
+	  if ( Thread.current != Thread.main ) then
+	    Thread.current[MDCNAME] = Hash.new
+	    Thread.main[MDCNAME].each{ |k,v| Thread.current[MDCNAME][k] = v }
+	  end
+	end
+      end
+    end
+
+    def self.get( a_key )
+      self.check_thread_instance()
+      Thread.current[MDCNAME].fetch(a_key, "");
+    end
+
+    def self.get_context()
+      self.check_thread_instance()
+      return Thread.current[MDCNAME].clone
+    end
+
+    def self.put( a_key, a_value )
+      self.check_thread_instance()
+      Thread.current[MDCNAME][a_key] = a_value
+    end
+
+    def self.remove( a_key )
+      self.check_thread_instance()
+      Thread.current[MDCNAME].delete( a_key )
+    end
+  end
+end

data/src/log4r/NDC.rb

@@ -0,0 +1,87 @@
+# :include: rdoc/NDC
+#
+# == Other Info
+# 
+# Version:: $Id: NDC.rb,v 1.1 2010/01/12 02:21:29 colbygk Exp $
+# Author:: Colby Gutierrez-Kraybill <colby(at)astro.berkeley.edu>
+
+module Log4r
+  NDCNAME = "log4rNDC"
+  NDCNAMEMAXDEPTH = "log4rNDCMAXDEPTH"
+  NDCDEFAULTMAXDEPTH = 100
+
+  # See log4r/NDC.rb
+  class NDC
+    private_class_method :new
+
+    def self.check_thread_instance()
+      if ( Thread.current[NDCNAME] == nil ):
+	Thread.current[NDCNAME] = Array.new
+	Thread.current[NDCNAMEMAXDEPTH] = NDCDEFAULTMAXDEPTH
+	Thread.current[NDCNAME]
+      end
+    end
+
+    def self.clear()
+      self.check_thread_instance()
+      Thread.current[NDCNAME].clear
+    end
+
+    def self.clone_stack()
+      self.check_thread_instance()
+      return Thread.current[NDCNAME].clone
+    end
+
+    def self.get_depth()
+      self.check_thread_instance()
+      return Thread.current[NDCNAME].length
+    end
+
+    def self.inherit( a_stack )
+      if ( a_stack.class == Array ) then
+	if ( Thread.current[NDCNAME] != nil ) then
+	  Thread.current[NDCNAME].clear
+	  Thread.current[NDCNAME] = nil
+	end
+	Thread.current[NDCNAME] = a_stack
+      else
+	raise "Expecting Array in NDC.inherit"
+      end
+    end
+
+    def self.get()
+      self.check_thread_instance
+      return Thread.current[NDCNAME] * " "
+    end
+
+    def self.peek()
+      self.check_thread_instance()
+      return Thread.current[NDCNAME].last
+    end
+
+    def self.pop()
+      self.check_thread_instance()
+      return Thread.current[NDCNAME].pop
+    end
+
+    def self.push( value )
+      self.check_thread_instance()
+      if ( Thread.current[NDCNAME].length < Thread.current[NDCNAMEMAXDEPTH] ):
+	Thread.current[NDCNAME].push( value )
+      end
+    end
+
+    def self.remove()
+      self.check_thread_instance()
+      Thread.current[NDCNAME].clear
+      Thread.current[NDCNAMEMAXDEPTH] = nil
+      Thread.current[NDCNAME] = nil
+    end
+
+    def self.set_max_depth( max_depth )
+      self.check_thread_instance()
+      Thread.current[NDCNAMEMAXDEPTH] = max_depth
+    end
+  end
+end
+

data/src/log4r/formatter/patternformatter.rb

@@ -2,9 +2,12 @@
 #
 # == Other Info
 #
-# Version:: $Id: patternformatter.rb,v 1.5 2009/09/25 20:33:33 colbygk Exp $
+# Version:: $Id: patternformatter.rb,v 1.6 2009/10/28 19:55:34 colbygk Exp $
 
 require "log4r/formatter/formatter"
+require "log4r/GDC"
+require "log4r/MDC"
+require "log4r/NDC"
   
 module Log4r
   # See log4r/formatter/patternformatter.rb
@@ -14,23 +17,29 @@ module Log4r
     # %c - event short name
     # %C - event fullname
     # %d - date
+    # %g - Global Diagnostic Context (GDC)
     # %t - trace
     # %m - message
     # %h - thread name
     # %p - process ID aka PID
     # %M - formatted message
     # %l - Level in string form
+    # %x - Nested Diagnostic Context (NDC)
+    # %X - Mapped Diagnostic Context (MDC), syntax is "%X.key"
     # %% - Insert a %
     DirectiveTable = {
       "c" => 'event.name',
       "C" => 'event.fullname',
       "d" => 'format_date',
+      "g" => 'GDC.get()',
       "t" => '(event.tracer.nil? ? "no trace" : event.tracer[0])',
       "m" => 'event.data',
-      "h" => 'thread_name',
+      "h" => '(Thread.current[:name] or Thread.current.to_s)',
       "p" => 'Process.pid.to_s',
       "M" => 'format_object(event.data)',
       "l" => 'LNAMES[event.level]',
+      "x" => 'NDC.get()',
+      "X" => '($4 != "" ? MDC.get($4.to_s)',
       "%" => '"%"'
     }
   
@@ -74,10 +83,6 @@ module Log4r
       PatternFormatter.create_format_methods(self)
     end
 
-    def thread_name
-      Thread.current[:name] || Thread.current.to_s
-    end
-
     # PatternFormatter works by dynamically defining a <tt>format</tt> method
     # based on the supplied pattern format. This method contains a call to 
     # Kernel#sptrintf with arguments containing the data requested in

data/src/log4r/outputter/bob.patch

@@ -0,0 +1,25 @@
+      begin
+        3.times do
+          begin
+            ### send email
+            @smtp.sendmail(rfc822msg, @from, @to)
+            break
+          rescue Net::SMTPServerBusy => e
+            Logger.log_internal(-2) {
+              "Try to restart EmailOutputter '#{@name}'! (#{e.message})"
+            }
+            @smtp = Net::SMTP.start(*@params)
+          rescue Exception => e
+            Logger.log_internal(-2) {
+              "EmailOutputter '#{@name}' couldn't send email! (#{e.message})"
+              break
+            }
+            Logger.log_internal {e}
+            self.level = OFF
+          end
+        end
+      ensure
+        @buff.clear
+      end
+    end
+  end

data/src/log4r/outputter/emailoutputter.rb.orig

@@ -0,0 +1,118 @@
+# :include: ../rdoc/emailoutputter
+
+require 'log4r/outputter/outputter'
+require 'log4r/staticlogger'
+require 'net/smtp'
+
+module Log4r
+
+  class EmailOutputter < Outputter
+    attr_reader :server, :port, :domain, :acct, :authtype, :subject
+
+    def initialize(_name, hash={})
+      super(_name, hash)
+      validate(hash)
+      @buff = []
+      begin 
+        Logger.log_internal {
+          "EmailOutputter '#{@name}' running SMTP client on #{@server}:#{@port}"
+        }
+      rescue Exception => e
+        Logger.log_internal(-2) {
+          "EmailOutputter '#{@name}' failed to start SMTP client!"
+        }
+        Logger.log_internal {e}
+        self.level = OFF
+	raise e
+      end
+    end
+
+    # send out an email with the current buffer
+    def flush
+      synch { send_mail }
+      Logger.log_internal {"Flushed EmailOutputter '#{@name}'"}
+    end
+
+    private
+
+    def validate(hash)
+      @buffsize = (hash[:buffsize] or hash['buffsize'] or 100).to_i
+      @formatfirst = Log4rTools.decode_bool(hash, :formatfirst, false)
+      decode_immediate_at(hash)
+      validate_smtp_params(hash)
+    end
+
+    def decode_immediate_at(hash)
+      @immediate = Hash.new
+      _at = (hash[:immediate_at] or hash['immediate_at'])
+      return if _at.nil?
+      Log4rTools.comma_split(_at).each {|lname|
+        level = LNAMES.index(lname)
+        if level.nil?
+          Logger.log_internal(-2) do
+            "EmailOutputter: skipping bad immediate_at level name '#{lname}'"
+          end
+          next
+        end
+        @immediate[level] = true
+      }
+    end
+
+    def validate_smtp_params(hash)
+      @from = (hash[:from] or hash['from'])
+      raise ArgumentError, "Must specify from address" if @from.nil?
+      _to = (hash[:to] or hash['to'] or "")
+      @to = Log4rTools.comma_split(_to) 
+      raise ArgumentError, "Must specify recepients" if @to.empty?
+      @server = (hash[:server] or hash['server'] or 'localhost')
+      @port = (hash[:port] or hash['port'] or 25).to_i
+      @domain = (hash[:domain] or hash['domain'] or ENV['HOSTNAME'])
+      @acct = (hash[:acct] or hash['acct'])
+      @passwd = (hash[:passwd] or hash['passwd'])
+      @authtype = (hash[:authtype] or hash['authtype'] or :cram_md5).to_s.intern
+      @subject = (hash[:subject] or hash['subject'] or "Message of #{$0}")
+      @params = [@server, @port, @domain, @acct, @passwd, @authtype]
+    end
+
+    def canonical_log(event)
+      synch {
+        @buff.push case @formatfirst
+          when true then @formatter.format event
+          else event 
+          end
+        send_mail if @buff.size >= @buffsize or @immediate[event.level]
+      }
+    end
+
+    def send_mail
+      msg = 
+        case @formatfirst
+        when true then @buff.join 
+        else @buff.collect{|e| @formatter.format e}.join 
+        end
+
+      ### build a mail header for RFC 822
+      rfc822msg =
+        "From: #{@from}\n" +
+        "To: #{@to}\n" +
+        "Subject: #{@subject}\n" +
+        "Date: #{Time.now.strftime( "%a, %d %b %Y %H:%M:%S %z %Z")}\n" +
+        "Message-Id: <#{"%.8f" % Time.now.to_f}@#{@domain}>\n\n" +
+        "#{msg}"
+
+      ### send email
+      begin Net::SMTP.start(*@params) do |smtp|
+        smtp.sendmail(rfc822msg, @from, @to)
+      end
+      rescue Exception => e
+        Logger.log_internal(-2) {
+          "EmailOutputter '#{@name}' couldn't send email!"
+        }
+        Logger.log_internal {e}
+        self.level = OFF
+	raise e
+      ensure @buff.clear
+      end
+    end
+  end
+end

data/src/log4r/outputter/emailoutputter.rb.rej

@@ -0,0 +1,46 @@
+***************
+*** 100,114 ****
+         "Message-Id: <#{"%.8f" % Time.now.to_f}@#{@domain}>\n\n" +
+  	"#{msg}"
+  
+-       ### send email
+-       begin @smtp.sendmail(rfc822msg, @from, @to)
+-       rescue Exception => e
+-         Logger.log_internal(-2) {
+-           "EmailOutputter '#{@name}' couldn't send email!"
+-         }
+-         Logger.log_internal {e}
+-         self.level = OFF
+-       ensure @buff.clear
+        end
+      end
+    end
+--- 100,127 ----
+         "Message-Id: <#{"%.8f" % Time.now.to_f}@#{@domain}>\n\n" +
+  	"#{msg}"
+  
++       begin
++         3.times do
++           begin
++             ### send email
++             @smtp.sendmail(rfc822msg, @from, @to)
++             break
++           rescue Net::SMTPServerBusy => e
++             Logger.log_internal(-2) {
++               "Try to restart EmailOutputter '#{@name}'! (#{e.message})"
++             }
++             @smtp = Net::SMTP.start(*@params)
++           rescue Exception => e
++             Logger.log_internal(-2) {
++               "EmailOutputter '#{@name}' couldn't send email! (#{e.message})"
++               break
++             }
++             Logger.log_internal {e}
++             self.level = OFF
++           end
++         end
++       ensure
++         @buff.clear
+        end
+      end
+    end

data/src/log4r/outputter/fileoutputter.rb

@@ -1,5 +1,5 @@
 # :nodoc:
-# Version:: $Id: fileoutputter.rb,v 1.1.1.1 2004/03/19 03:31:09 fando Exp $
+# Version:: $Id: fileoutputter.rb,v 1.2 2009/09/29 18:13:13 colbygk Exp $
 
 require "log4r/outputter/iooutputter"
 require "log4r/staticlogger"
@@ -18,6 +18,7 @@ module Log4r
 
       @trunc = Log4rTools.decode_bool(hash, :trunc, true)
       _filename = (hash[:filename] or hash['filename'])
+      @create = Log4rTools.decode_bool(hash, :create, true)
 
       if _filename.class != String
         raise TypeError, "Argument 'filename' must be a String", caller
@@ -38,10 +39,16 @@ module Log4r
       end
 
       @filename = _filename
-      @out = File.new(@filename, (@trunc ? "w" : "a")) 
-      Logger.log_internal {
-        "FileOutputter '#{@name}' writing to #{@filename}"
-      }
+      if ( @create == true ) then
+	@out = File.new(@filename, (@trunc ? "w" : "a")) 
+	Logger.log_internal {
+	  "FileOutputter '#{@name}' writing to #{@filename}"
+	}
+      else
+	Logger.log_internal {
+	  "FileOutputter '#{@name}' called with :create == false, #{@filename}"
+	}
+      end
     end
 
   end