log4rails 1.1.11

data/lib/log4r/outputter/udpoutputter.rb

@@ -0,0 +1,53 @@
+# :include: ../rdoc/outputter
+#
+# == Other Info
+#
+# Version:: $Id$
+# 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, hash={})
+      super(_name, hash)
+      @host = (hash[:hostname] or hash["hostname"])
+      @port = (hash[:port] or hash["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/lib/log4r/railtie.rb

@@ -0,0 +1,211 @@
+# :nodoc:
+# Version:: $Id$
+# Author:: Mike Ho <i(at)bestmike007.com>
+# How to configure log4r for rails in application.rb:
+# config.log4rails.<option> = <value>
+# config.log4rails.enabled = true # enable log4r integration
+# config.log4rails.action_mht = 500 # maximum action handling time to log with level INFO, default: 500ms.
+# config.log4rails.auto_reload = true # auto-reload log4r configuration file from config/log4r.yaml (or config/log4r-production.yaml in production environment)
+
+require 'rails'
+require 'log4r/yamlconfigurator'
+
+module Log4r
+
+  class Railtie < Rails::Railtie
+    
+    config.log4rails = ActiveSupport::OrderedOptions.new
+    # default values
+    config.log4rails.enabled = false
+    config.log4rails.action_mht = 500
+    config.log4rails.auto_reload = true
+
+    initializer "log4rails.pre_init", :before => :initialize_logger do |app|
+      if app.config.log4rails.enabled
+        Log4r::Railtie.load_config
+        Log4r::Railtie.pre_init(app, {:root => Rails.root.to_s, :env => Rails.env}.merge(app.config.log4rails))
+      end
+    end
+
+    initializer "log4rails.post_init", :after => :initialize_logger do |app|
+      if app.config.log4rails.enabled
+        Log4r::Railtie.post_init
+      end
+    end
+
+    initializer "log4rails.cache_logger", :after => :initialize_cache do |app|
+      if app.config.log4rails.enabled
+        class << Rails.cache
+          def logger
+            Log4r::Logger['rails::cache'] || Log4r::Logger.root
+          end
+          def logger=(l)
+            (l || logger).debug "Log4r is preventing set of logger for cache."
+          end
+        end
+      end
+    end
+    
+    class << self
+      
+      # remove rails default log subscriptions
+      # [ActiveRecord::LogSubscriber, ActionController::LogSubscriber, ActionView::LogSubscriber, ActionMailer::LogSubscriber] 
+      unsubscribe = lambda { |component, subscriber|
+        events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
+        events.each do |event|
+          ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener|
+            if listener.instance_variable_get('@delegate') == subscriber
+              ActiveSupport::Notifications.unsubscribe listener
+            end
+          end
+        end
+      }
+      remove_existing_log_subscriptions = lambda {
+        ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
+          case subscriber
+          when ActionView::LogSubscriber
+            unsubscribe.call(:action_view, subscriber)
+          when ActionController::LogSubscriber
+            unsubscribe.call(:action_controller, subscriber)
+          when ActiveRecord::LogSubscriber
+            unsubscribe.call(:active_record, subscriber)
+          when ActionMailer::LogSubscriber
+            unsubscribe.call(:action_mailler, subscriber)
+          end
+        end
+      }
+      
+      config_time = Time.new 0
+      config_next_check = Time.now
+      config_path = nil
+      options = nil
+      
+      define_method(:options) { options }
+      
+      # load or reload config from RAILS_ROOT/config/log4r.yaml or RAILS_ROOT/config/log4r-production.yaml
+      define_method :load_config do
+        # auto reload config every 30 seconds.
+        return if Time.now < config_next_check
+        config_next_check = Time.now + 30
+        return  if !config_path.nil? && (!File.file?(config_path) || File.mtime(config_path) == config_time)
+        config_path = File.join Rails.root, "config", "log4r.yaml"
+        begin
+          if Rails.env == 'production'
+            production_config = File.join Rails.root, "config", "log4r-production.yaml"
+            config_path = production_config if File.file?(production_config)
+          end
+          if File.file? config_path
+            YamlConfigurator.load_yaml_file config_path
+            config_path = config_path
+            config_time = File.mtime(config_path)
+            return
+          end
+          puts "Log4r Warning: Unable to find log4r config file for rails, using default config."
+        rescue Log4r::ConfigError => e
+          puts "Log4r Error: Unable to load config #{config_path}, error: #{e}. Using default config."
+        end
+        config_path = File.join File.dirname(__FILE__), 'log4r-rails.yaml'
+        YamlConfigurator.load_yaml_file config_path
+      end
+      
+      define_method :pre_init do |app, opts|
+        options = opts
+        # silence default rails logger
+        app.config.log_level = :unknown
+        # define global logger
+        setup_logger Object, "root"
+        # define rails controller logger names
+        setup_logger ActionController::Base, "rails::controllers"
+        setup_logger ActiveRecord::Base, "rails::models"
+        setup_logger ActionMailer::Base, "rails::mailers"
+        
+        remove_existing_log_subscriptions.call
+        
+        ActiveSupport::Notifications.subscribe "process_action.action_controller" do |name, start, finish, id, payload|
+          Log4r::Railtie.load_config if Log4r::Railtie.options[:auto_reload]
+          Log4r::Railtie.controller_log({ duration: ((finish - start).to_f * 100000).round / 100.0 }.merge(payload))
+        end
+        
+        ActiveSupport::Notifications.subscribe "sql.active_record" do |name, start, finish, id, payload|
+          Log4r::Railtie.load_config if Log4r::Railtie.options[:auto_reload]
+          logger = Log4r::Logger["rails::db"] || Log4r::Logger.root
+          logger.debug { "(#{((finish - start).to_f * 100000).round / 100.0 }) #{payload[:sql]}" }
+        end
+      end
+      
+      def post_init
+        setup_logger Rails, "rails"
+        # disable rack development output, e.g. Started GET "/session/new" for 127.0.0.1 at 2012-09-26 14:51:42 -0700
+        if Rails.const_defined?(:Rack) && Rails::Rack.const_defined?(:Logger)
+          setup_logger Rails::Rack::Logger, "root"
+        end
+        # override DebugExceptions output
+        ActionDispatch::DebugExceptions.module_eval %-
+          def log_error(env, wrapper)
+            logger = Rails.logger
+            exception = wrapper.exception
+            # trace = wrapper.application_trace
+            # trace = wrapper.framework_trace if trace.empty?
+            logger.info "ActionDispatch Exception: \#{exception.class} (\#{exception.message})"
+          end
+          private :log_error
+        -
+      end
+      
+      def controller_log(payload)
+        logger = Rails.logger
+        params_logger = Log4r::Logger["rails::params"] || Log4r::Logger.root
+        
+        duration = payload[:duration]
+        unless payload[:exception].nil?
+          logger.warn {
+            db = (payload[:db_runtime] * 100).round/100.0 rescue "-"
+            view = (payload[:view_runtime] * 100).round/100.0 rescue "-"
+            "#{payload[:method]} #{payload[:path]} (TIMING[ms]: sum:#{duration} db:#{db} view:#{view}) EXCEPTION: #{payload[:exception]}"
+          }
+          params_logger.info { "request params: " + payload[:params].to_json }
+          return
+        end
+        if duration >= Log4r::Railtie.options[:action_mht]
+          logger.warn {
+            db = (payload[:db_runtime] * 100).round/100.0 rescue "-"
+            view = (payload[:view_runtime] * 100).round/100.0 rescue "-"
+            "#{payload[:method]} #{payload[:path]} (TIMING[ms]: sum:#{duration} db:#{db} view:#{view})"
+          }
+        else
+          logger.info {
+            db = (payload[:db_runtime] * 100).round/100.0 rescue "-"
+            view = (payload[:view_runtime] * 100).round/100.0 rescue "-"
+            "#{payload[:method]} #{payload[:path]} (TIMING[ms]: sum:#{duration} db:#{db} view:#{view})"
+          }
+        end
+        params_logger.info { "request params: " + payload[:params].to_json }
+      end
+      
+      # convenient static method to setup logger for class and descendants.
+      def setup_logger(clazz, logger_name)
+        clazz.module_eval %(
+          class << self
+            custom_logger = nil
+            define_method :logger do
+              custom_logger || Log4r::Logger['#{logger_name}'] || Log4r::Logger.root
+            end
+            define_method :logger= do |l|
+              (l || custom_logger).debug "Log4rails is preventing set of logger. Use #custom_logger= if you really want it set."
+            end
+            define_method :custom_logger= do |l|
+              custom_logger = l
+            end
+          end
+          
+          def logger
+            #{clazz.name}.logger
+          end
+        )
+      end
+      
+    end
+    
+  end # class Railtie
+  
+end # module Log4r

data/lib/log4r/rdoc/GDC

@@ -0,0 +1,14 @@
+= GDC
+
+The GDC class implements a copy of the Global Diagnostic Context, which
+is not part of the Apache Log4j library, as of this writing (10 Jan 2009).
+
+The GDC is like the NDC and MDC classes, only it is global to the
+application (see NDC and MDC for details on those classes).
+
+The GDC is local to the main thread, and any new threads will return
+the value of the current GDC set in the main thread.
+
+Only the main thread can set the GDC, any other threads that
+attempt to will raise an exception.
+

data/lib/log4r/rdoc/MDC

@@ -0,0 +1,16 @@
+= MDC
+
+The MDC class implements a copy of the Mapped Diagnostic Context, which
+is part of the Apache Log4j library.  See the NDC documentation for
+more details.  MDCs are much like NDCs, but instead of a stack context
+it uses a map for holding this information.
+
+This allows for selection of information out of the map when
+the log message is being created.
+
+MDCs are thread safe, and are unique to each thread.
+
+An important difference between MDCs in Log4r vs Log4j is that they
+only inherit from the main thread.  Ruby treats all new threads as
+being the children of the main thread, even if they are started
+from a thread that is not main.

data/lib/log4r/rdoc/NDC

@@ -0,0 +1,41 @@
+= NDC
+
+The NDC class implements a copy of the Nested Diagnostic Context, which
+is part of the Apache Log4j library.  Nested Diagnostic Contexts were
+derived from Neil Harrison's article on "Patterns for Logging
+Diagnostic Messages", part of the book "Pattern Languages of Program
+Design 3" edited by Martin et al.
+
+NDCs in Log4r are thread safe.
+
+NDCs in log4r are close enough to NDCs in Log4j that I include its
+documentation directly:
+
+...
+A Nested Diagnostic Context, or NDC in short, is an instrument to
+distinguish interleaved log output from different sources. Log output
+is typically interleaved when a server handles multiple clients
+near-simultaneously.
+
+Interleaved log output can still be meaningful if each log entry from
+different contexts had a distinctive stamp. This is where NDCs come into
+play.
+
+Note that NDCs are managed on a per thread basis. NDC operations such as
+push, pop(), clear(), getDepth() and setMaxDepth(int) affect the NDC of
+the current thread only. NDCs of other threads remain unaffected.
+...
+
+An important difference between NDCs in Log4r vs Log4j is that you
+do not have to called NDC.remove() when exiting a thread.
+
+This class will automatically create Thread specific storage for the 
+current thread on the first call to any of its methods, i.e.
+
+  NDC.push( "client accept" );
+
+New threads may inherit the NDC of the parent thread by making use of
+the clone_stack() and inherit() methods.  By default, the NDC is not
+inherited automatically.  This is unlike MDCs, which will inherit from
+the main thread.
+

data/lib/log4r/rdoc/configurator

@@ -0,0 +1,243 @@
+= Configuring Log4r with Log4r::Configurator
+
+The Configurator class allows one to set up Log4r via XML.
+Additionally, Configurator contains methods to configure any Log4r 
+defaults. In particular, Configurator provides a method to
+customize the logging levels.
+
+Log4r is also configurable using YAML. For that, there is
+a class similar to Configurator called Log4r::YamlConfigurator. Please see
+log4r/yamlconfigurator.rb for details.
+
+REXML is required for XML configuration. Get REXML at 
+http://www.ruby-lang.org/en/raa-list.rhtml?name=REXML
+
+To use the Configurator class,
+
+  require 'log4r/configurator'
+
+== Custom Levels
+
+Suppose you want the following levels and ranks:
+
+  Foo < Bar < Baz
+
+This is easily accomplished:
+
+  Configurator.custom_levels('Foo', 'Bar', :Baz)
+
+The method accepts strings or symbols. However, custom levels must have names 
+that are valid for Ruby constants. Also, custom levels should be set before 
+anything else is done with Log4r, otherwise the default levels will be loaded.
+
+You can set custom levels in XML. That's covered in the following section.
+
+== XML Configuration
+
+If you have REXML, you can configure Log4r with XML.
+To do this, first write an XML configuration (which you can learn by
+studying this document and the examples provided in the distribution)
+and then load up the XML from within your program as follows:
+
+  Configurator.load_xml_file('/path/to/file.xml')
+
+The Log4r XML configuration system is very flexible and powerful. In fact,
+it is somewhat preferable to configuring Log4r in Ruby. In order to take
+full advantage of this feature, there are several concepts one must know.
+They are covered in the following three sections.
+
+=== Concept: XML Directives
+
+The expressive power of Ruby has enabled a feature I call 
+<i>XML directives</i>. An XML directive is a name-value pair belonging to 
+some element. It
+may be represented as an attribute (name="value") of the element, or
+as a child (<name>value</name>) of the element. Therefore, you are
+free to specify information about an object as either an attribute
+or an element. An example should clarify:
+
+  <object data="value"/>
+
+Is equivalent to:
+
+  <object>
+     <data>value</data>
+  </object>
+
+You can assume this behavior except where noted elsewhere in the API.
+
+=== Concept: XML Parameters
+
+A scheme which I call <i>XML parameters</i> enables one to utilize the XML 
+configuratin system for custom Outputters and Formatters.
+This requires <b>no</b> extra work on your part, so long as your objects 
+are set up using hash arguments and can decode string values. That is, once
+you've written a custom Outputter, it is automatically configurable in XML
+without having to write any extra code.
+
+An XML parameter is analogous to a hash argument to some object's <tt>new</tt>
+method. Consider these hash arguments to FileOutputter:
+
+  :filename => '/path/to/logs/my.log'
+  :trunc => 'true'
+
+We can specify them in XML like this:
+
+  <outputter type="FileOutputter" trunc="true">
+     <filename>/path/to/logs/my.log</filename>
+     ...
+
+The name of the element/attribute is just the name of the parameter. Note that
+the input will be a string, thus it's wise to convert the data in from 
+strings in any custom classes (to_i for integers, etc). Now let's suppose you 
+have defined a custom Outputter named MyOutputter with the following 
+additional hash args:
+
+  :myarg1 => 'foo'
+  :myarg2 => 123
+
+Automagically, you can configure your Outputter like so:
+
+  <outputter type="MyOutputter" myarg2="123">
+     <myarg1>foo</myarg1>
+     ...
+
+Isn't that nice? <tt>:-)</tt>
+
+=== Concept: Variable Substitution
+
+To kill the need for preprocessors, Configurator provides a means of variable 
+substitution for XML parameters at runtime. If you specify 
+<tt>#{foo}</tt> in an XML parameter value, Configurator will replace it with 
+the value of 'foo' in its parameter hashtable. The primary idea is that you 
+can figure stuff out in your program, 
+say the log path, and relay that information to the XML while it's being 
+loaded. Secondarily, it is a way to have aliases within an XML document.
+
+There are two ways to tell Configurator about these variables. The first
+method we'll cover is done within a Ruby program with Configurator[].
+
+  Configurator['logpath'] = '/path/to/logs'
+
+Thereafter, any occurence of <tt>#{logpath}</tt> in each and every XML 
+parameter will be substituted with '/path/to/logs'. For example:
+
+  <filename>#{logpath}/mylog.log</filename>
+
+Becomes,
+
+  <filename>/path/to/logs/mylog.log</filename>
+
+Aside from Configurator[], another way to define XML parameter variables
+is to define <tt>parameters</tt> under the <tt><pre_config></tt> element
+of an XML configuration:
+
+  <pre_config>
+     <parameter name="logpath" value="/path/to/logs'/>
+     <parameter name="other" value="somethingelse'/>
+     ...
+  </pre_config>
+
+Alternatively,
+
+  <pre_config>
+     <parameters>
+        <logpath>/path/to/logs</logpath>
+        <other>somethingelse</other>
+        ...
+     </parameters>
+     ...
+
+The end result is the same as using Configurator[]. However, this method
+is not dynamic. Configurator[] should be used when you want to set variables
+from within Ruby.
+
+= XML Grammar
+
+And now, here's the XML grammar we use to configure Log4r.
+
+== Root Element
+
+The root element is <tt><log4r_config></tt>. It can be embedded as a node of
+any other element in an XML file. For instance:
+
+  <my-xml-thing>
+     <customize-libraries>
+        <log4r_config>
+           <!-- log4r configuratin goes here -->
+        </log4r_config>
+        ...
+
+== Pre-config element
+
+The pre_config element is a child of log4r_config and contains:
+
+* 'custom_levels' element
+* 'global' element
+* 'parameters' element
+* any number of 'parameter' elements
+
+=== Pre_config: Custom Levels
+
+The custom_levels element is not an <i>XML directive</i> of pre_config. It
+<b>must</b> be specified like this:
+
+  <custom_levels>Foo, Bar, Baz</custom_levels>
+
+And <b>not</b> like this:
+
+  <!-- NOT SUPPORTED -->
+  <custom_levels levels="Foo, Bar, Baz"/>
+
+=== Pre_config: Global Level
+
+  <global level="DEBUG"/>
+
+or
+
+  <global><level>DEBUG</level></global>
+
+Here, level is an XML directive of global.
+
+=== Pre_config: Parameters
+
+Parameters are variables that will be substituted later on. Please
+see the <b>Concept: Variable Substitution</b> section above. Parameters 
+are <i>XML Directives</i>, which means they can be expressed using elements 
+or attributes. Here is an example:
+
+  <parameter name="param name 1" value="param value 1">
+  <parameter name="param name 2" value="param value 2">
+  ...
+  <parameters>
+     <param3>value3</param3>
+     <param4>value3</param4>
+     ...
+
+=== Pre_config: Complete Example
+
+   <log4r_config>
+
+      <pre_config>
+         <custom_levels>
+            Foo,Bar, Baz
+         </custom_levels>
+         <global level="Bar"/>
+         <parameters>
+            <logpath>/var/log/foo</logpath>
+            <mypattern>%l [%d] %m</mypattern>
+         </parameters>
+      </pre_config>
+
+      <!-- define some outputters and loggers -->
+      
+   </log4r_config>
+
+== Configuring Log4r Objects
+
+The XML configuration grammar for Loggers, Outputters and the like are 
+covered in the usage guidelines for those classes.
+
+== Order Doesn't Matter
+
+You can (it is hoped) define any of the XML objects in any order desired.