sawmill 0.1.11 → 0.1.12

data/History.rdoc

@@ -1,3 +1,13 @@
+=== 0.1.12 / 2010-11-01
+
+* A date-based rotater can now force log files to be written to by only one process. Useful in environments where you have an unknown number of processes(i.e. a Passenger-based deployment), each of which needs a separate log file.
+* Provided a Railtie for easy integration into a Rails 3 application.
+* The record_progname and attribute_level can now be set on a logger after creation.
+
+=== 0.1.11 / 2010-10-19
+
+* Fixed a missing require.
+
 === 0.0.10 / 2010-01-31
 
 * Fixed a rotater issue that sometimes caused rotation to occur one record too late.

data/README.rdoc

@@ -22,11 +22,12 @@ Sawmill is an extension to the standard ruby Logger mechanism that enables autom
 * Parse logfiles back into log entries and log records
 * Log analysis framework
 * Rack middleware for quick setup of web service logs
+* Railtie for Rails 3 integration
 
 === Requirements
 
-* Ruby 1.8.6 or later (1.8.7 recommended), Ruby 1.9.1 or later, or JRuby 1.4 or later.
-* Blockenspiel 0.3.1 or later.
+* Ruby 1.8.7 or later (Ruby 1.9.2 or later recommended), or JRuby 1.4 or later.
+* Blockenspiel 0.4.1 or later.
 
 === Installation
 
@@ -48,11 +49,13 @@ Contact the author at dazuma at gmail dot com.
 
 === Author / Credits
 
-Lumber is written by Daniel Azuma (http://www.daniel-azuma.com/).
+Sawmill is written by Daniel Azuma (http://www.daniel-azuma.com/).
 
-== LICENSE:
+Development of Sawmill is sponsored by GeoPage (http://www.geopage.com/).
 
-Copyright 2009 Daniel Azuma.
+=== License
+
+Copyright 2009-2010 Daniel Azuma.
 
 All rights reserved.
 

data/Version

@@ -1 +1 @@
-0.1.11
+0.1.12

data/lib/sawmill/errors.rb

@@ -67,6 +67,12 @@ module Sawmill
     end
     
     
+    # Could not open a log file because a uniquifier failed.
+    
+    class NoUniqueLogFileError < SawmillError
+    end
+    
+    
   end
   
   

data/lib/sawmill/logger.rb

@@ -34,10 +34,7 @@
 ;
 
 
-begin
-  require 'securerandom'
-rescue ::LoadError
-end
+require 'securerandom'
 
 
 module Sawmill
@@ -254,6 +251,20 @@ module Sawmill
     end
     
     
+    # Get the current record progname setting for this logger
+    
+    def record_progname
+      @record_progname
+    end
+    
+    
+    # Set the current record progname setting for this logger
+    
+    def record_progname=(value_)
+      @record_progname = value_.to_s.gsub(/\s+/, '')
+    end
+    
+    
     # Get the current level setting for this logger as a Sawmill::Level.
     
     def level
@@ -282,6 +293,32 @@ module Sawmill
     alias_method :sev_threshold, :level
     
     
+    # Get the current attribute level setting for this logger as a
+    # Sawmill::Level.
+    
+    def attribute_level
+      @attribute_level
+    end
+    
+    
+    # Set the current attribute level setting for this logger.
+    # You may specify the level as a string, a symbol, an integer, or a
+    # Sawmill::Level. Ruby's logger constants such as ::Logger::INFO
+    # will also work.
+    
+    def attribute_level=(value_)
+      if value_.kind_of?(Level)
+        @attribute_level = value_
+      else
+        level_obj_ = @level_group.get(value_)
+        if level_obj_.nil?
+          raise Errors::UnknownLevelError, value_
+        end
+        @attribute_level = level_obj_
+      end
+    end
+    
+    
     # Get the LevelGroup in use by this Logger. This setting cannot be
     # changed once the logger is constructed.
     
@@ -348,32 +385,16 @@ module Sawmill
     
     
     def self._get_default_record_id_generator  # :nodoc:
-      unless @_default_generator
-        if defined?(::SecureRandom)
-          _random_hex32 = ::Proc.new do
-            ::SecureRandom.hex(16)
-          end
-        elsif defined?(::ActiveSupport::SecureRandom)
-          _random_hex32 = ::Proc.new do
-            ::ActiveSupport::SecureRandom.hex(16)
-          end
-        else
-          _random_hex32 = ::Proc.new do
-            ::Kernel.rand(0x100000000000000000000000000000000).to_s(16).rjust(32, '0')
-          end
-        end
-        @_default_generator = ::Proc.new do
-          uuid_ = _random_hex32.call
-          uuid_[12] = '4'
-          uuid_[16] = (uuid_[16,1].to_i(16)&3|8).to_s(16)
-          uuid_.insert(8, '-')
-          uuid_.insert(13, '-')
-          uuid_.insert(18, '-')
-          uuid_.insert(23, '-')
-          uuid_
-        end
+      @_default_generator ||= ::Proc.new do
+        uuid_ = ::SecureRandom.hex(16)
+        uuid_[12] = '4'
+        uuid_[16] = (uuid_[16,1].to_i(16)&3|8).to_s(16)
+        uuid_.insert(8, '-')
+        uuid_.insert(13, '-')
+        uuid_.insert(18, '-')
+        uuid_.insert(23, '-')
+        uuid_
       end
-      @_default_generator
     end
     
     

data/lib/sawmill/railtie.rb

@@ -0,0 +1,153 @@
+# -----------------------------------------------------------------------------
+# 
+# Sawmill railtie
+# 
+# -----------------------------------------------------------------------------
+# Copyright 2009 Daniel Azuma
+# 
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the copyright holder, nor the names of any other
+#   contributors to this software, may be used to endorse or promote products
+#   derived from this software without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+;
+
+
+require 'sawmill'
+require 'rails/railtie'
+
+
+module Sawmill
+  
+  
+  # Railtie that replaces the default Rails logger with a Sawmill logger.
+  # Sets the Rails logger to a Sawmill::Logger, and installs a
+  # Sawmill::LogRecordMiddleware to enable record-based logging.
+  # 
+  # To install into a Rails app, include this line in your
+  # config/application.rb:
+  #   require 'sawmill/railtie'
+  # It should appear before your application configuration.
+  # 
+  # You can then configure sawmill using the standard rails configuration
+  # mechanism. The sawmill configuration lives in the config.sawmill
+  # configuration namespace. See Sawmill::Railtie::Configuration for the
+  # configuration options.
+  
+  class Railtie < ::Rails::Railtie
+    
+    
+    # Configuration options. These are attributes of config.sawmill.
+    
+    class Configuration
+      
+      def initialize  # :nodoc:
+        @logfile = ::STDERR
+        @formatter_options = {}
+        @logger_options = {}
+        @include_id = false
+        @fractional_second_digits = 2
+        @level_width = nil
+        @local_time = false
+        @iso_8601_time = false
+        @length_limit = nil
+        @level = :INFO
+        @attribute_level = nil
+        @progname = 'rails'
+        @record_progname = nil
+        @record_id_generator = nil
+        @request_id_key = 'sawmill.request_id'
+        @start_time_attribute = nil
+        @end_time_attribute = nil
+      end
+      
+      # The log file to write to. This should be either an IO object, or
+      # a Sawmill::Rotater. Default is STDERR.
+      attr_accessor :logfile
+      
+      # This option is passed to Sawmill::EntryProcessor::Format::new
+      attr_accessor :include_id
+      # This option is passed to Sawmill::EntryProcessor::Format::new
+      attr_accessor :fractional_second_digits
+      # This option is passed to Sawmill::EntryProcessor::Format::new
+      attr_accessor :level_width
+      # This option is passed to Sawmill::EntryProcessor::Format::new
+      attr_accessor :local_time
+      # This option is passed to Sawmill::EntryProcessor::Format::new
+      attr_accessor :iso_8601_time
+      # This option is passed to Sawmill::EntryProcessor::Format::new
+      attr_accessor :length_limit
+      
+      # This option is passed to Sawmill::Logger::new
+      attr_accessor :level
+      # This option is passed to Sawmill::Logger::new
+      attr_accessor :attribute_level
+      # This option is passed to Sawmill::Logger::new
+      attr_accessor :progname
+      # This option is passed to Sawmill::Logger::new
+      attr_accessor :record_progname
+      # This option is passed to Sawmill::Logger::new
+      attr_accessor :record_id_generator
+      
+      # This option is passed to Sawmill::LogRecordMiddleware::new
+      attr_accessor :request_id_key
+      # This option is passed to Sawmill::LogRecordMiddleware::new
+      attr_accessor :start_time_attribute
+      # This option is passed to Sawmill::LogRecordMiddleware::new
+      attr_accessor :end_time_attribute
+      
+    end
+    
+    
+    config.sawmill = Configuration.new
+    
+    
+    initializer :initialize_sawmill, :before => :initialize_logger do |app_|
+      myconfig_ = app_.config.sawmill
+      formatter_ = Formatter.new(myconfig_.logfile || ::STDERR,
+                                 :include_id => myconfig_.include_id,
+                                 :fractional_second_digits => myconfig_.fractional_second_digits,
+                                 :level_width => myconfig_.level_width,
+                                 :local_time => myconfig_.local_time,
+                                 :iso_8601_time => myconfig_.iso_8601_time,
+                                 :length_limit => myconfig_.length_limit)
+      logger_ = Logger.new(:processor => formatter_,
+                           :level => myconfig_.level,
+                           :attribute_level  => myconfig_.attribute_level,
+                           :progname => myconfig_.progname,
+                           :record_progname => myconfig_.record_progname,
+                           :record_id_generator => myconfig_.record_id_generator)
+      app_.config.logger = logger_
+      app_.config.middleware.swap(::Rails::Rack::Logger,
+                                  ::Sawmill::LogRecordMiddleware, logger_,
+                                  :request_id_key => myconfig_.request_id_key,
+                                  :start_time_attribute => myconfig_.start_time_attribute,
+                                  :end_time_attribute => myconfig_.end_time_attribute)
+    end
+    
+    
+  end
+  
+  
+end

data/lib/sawmill/rotater/date_based_log_file.rb

@@ -76,15 +76,61 @@ module Sawmill
       #   The logfile name prefix.
       #   In the filename "rails.2009-10-11.log", the suffix is ".log".
       #   If not specified, defaults to ".log".
+      # <tt>:uniquifier</tt>::
+      #   If provided, log files are never reopened. (That is, they are
+      #   opened with ::File::CREAT | ::File::EXCL.) The value of this
+      #   parameter must be a proc that returns an actual file name to
+      #   attempt to open. This proc is called repeatedly until it either
+      #   returns a file path that does not yet exist, or signals failure
+      #   by returning nil. See the session on Uniquifiers below.
       # <tt>:local_datestamps</tt>::
       #   If true, use the local timezone to create datestamps.
       #   The default is to use UTC.
+      # 
+      # === Uniquifiers
+      # 
+      # DateBasedLogFile provides a facility for ensuring that log files
+      # are written to by only one process, by generating unique file
+      # names for log files. This facility is useful, for example, if you
+      # are deploying via Phusion Passenger where you may have a variable
+      # number of rails processes, and you want each process to own its
+      # own logfile so entries in log records are not interleaved.
+      # 
+      # To activate this feature, pass a proc to the <tt>:uniquifier</tt>
+      # option. When DateBasedLogFile wants to open a log file for
+      # writing, it first calls this proc. The proc should return a file
+      # path to try opening. DateBasedLogFile then tries to open the file
+      # with ::File::CREAT | ::File::EXCL, which will succeed only if the
+      # file has not already been created (e.g. by another process). If
+      # the file already exists, the proc will be called again, and
+      # repeatedly until it either returns a path that has not yet been
+      # created, or nil indicating that it has given up.
+      # 
+      # The proc is passed a single hash that provides information about
+      # what path to generate, as well as space for the proc to store any
+      # state it wishes to persist through the process. These keys are
+      # given to the proc by DateBasedLogFile. Any other keys are
+      # available for use by the proc.
+      # <tt>:original_path</tt>::
+      #   The original file path generated by DateBasedLogFile, which
+      #   would have been used if there were no uniquifier.
+      # <tt>:last_path</tt>::
+      #   The last path generated by the proc, or nil if this is the
+      #   first time this proc is called for a particular logfile.
+      # <tt>:basedir</tt>::
+      #   The basedir of the DateBasedLogFile.
+      # <tt>:path_prefix</tt>::
+      #   The path_prefix of the DateBasedLogFile.
+      # <tt>:path_suffix</tt>::
+      #   The path_suffix of the DateBasedLogFile.
       
       def initialize(options_)
         @turnover_frequency = options_[:turnover_frequency] || :none
-        @prefix = ::File.expand_path(options_[:path_prefix] || options_[:prefix] || 'sawmill',
-                                     options_[:basedir] || options_[:dirname] || ::Dir.getwd)
+        @basedir = options_[:basedir] || options_[:dirname] || ::Dir.getwd
+        @prefix = options_[:path_prefix] || options_[:prefix] || 'sawmill'
         @suffix = options_[:path_suffix] || options_[:suffix] || '.log'
+        @suffix = ".#{@suffix}" unless @suffix.length == 0 || @suffix[0,1] == '.'
+        @uniquifier = options_[:uniquifier]
         @local_datestamps = options_[:local_datestamps]
         @date_pattern =
           case @turnover_frequency
@@ -113,12 +159,24 @@ module Sawmill
       # Implements the rotation strategy contract.
       
       def open_handle(handle_)
-        if @date_pattern
-          path_ = "#{@prefix}.#{handle_}#{@suffix}"
+        path_ = ::File.expand_path(@date_pattern ? "#{@prefix}.#{handle_}#{@suffix}" : @prefix+@suffix, @basedir)
+        file_ = nil
+        if @uniquifier
+          hash_ = {:path_prefix => @prefix, :path_suffix => @suffix, :basedir => @basedir, :original_path => path_.dup, :last_path => nil}
+          until file_
+            path_ = @uniquifier.call(hash_)
+            unless path_
+              raise Errors::NoUniqueLogFileError, "Could not find a unique log file path for #{hash_.inspect}"
+            end
+            begin
+              file_ = ::File.open(path_, ::File::CREAT | ::File::EXCL | ::File::WRONLY)
+            rescue ::Errno::EEXIST
+              hash_[:last_path] = path_
+            end
+          end
         else
-          path_ = @prefix+@suffix
+          file_ = ::File.open(path_, 'a')
         end
-        file_ = ::File.open(path_, 'a')
         file_.sync = true
         file_
       end
@@ -137,6 +195,72 @@ module Sawmill
       end
       
       
+      class << self
+        
+        
+        # Returns a simple uniquifier that inserts an incrementing number
+        # before the path suffix. i.e. if the non-uniquified filename is
+        # "rails.2009-10-11.log", then these names are generated:
+        # 
+        #  rails.2009-10-11.0.log
+        #  rails.2009-10-11.1.log
+        #  rails.2009-10-11.2.log
+        #  etc.
+        # 
+        # The following options are available:
+        # 
+        # <tt>:min_digits</tt>::
+        #   If provided, indicates the minimum number of digits for the
+        #   unique number. For example, if :digits is set to 2, these
+        #   names are generated:
+        #    rails.2009-10-11.00.log
+        #    rails.2009-10-11.01.log
+        #    rails.2009-10-11.02.log
+        #    ...
+        #    rails.2009-10-11.09.log
+        #    rails.2009-10-11.10.log
+        #    rails.2009-10-11.11.log
+        #    ...
+        #    rails.2009-10-11.99.log
+        #    rails.2009-10-11.100.log
+        #    rails.2009-10-11.101.log
+        #    etc.
+        #   The default is 1.
+        # <tt>:start_value</tt>::
+        #   The first value for the unique number. Default is 0.
+        
+        def simple_uniquifier(opts_={})
+          if (digits_ = opts_[:min_digits])
+            pattern_ = "%s.%0#{digits_.to_i}d%s"
+          else
+            pattern_ = "%s.%d%s"
+          end
+          ::Proc.new do |hash_|
+            if hash_[:last_path]
+              hash_[:value] += 1
+            else
+              suffix_ = hash_[:path_suffix]
+              orig_ = hash_[:original_path]
+              suffix_len_ = suffix_.length
+              if suffix_len_ > 0 && orig_[-suffix_len_, suffix_len_] == suffix_
+                pre_ = orig_[0, orig_.length - suffix_len_]
+                post_ = suffix_
+              else
+                pre_ = orig_
+                post_ = ''
+              end
+              hash_[:value] = opts_[:start_value].to_i
+              hash_[:pre] = pre_
+              hash_[:post] = post_
+            end
+            pattern_ % [hash_[:pre], hash_[:value], hash_[:post]]
+          end
+        end
+        
+        
+      end
+      
+      
     end
     
     

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 11
-  version: 0.1.11
+  - 12
+  version: 0.1.12
 platform: ruby
 authors: 
 - Daniel Azuma
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-19 00:00:00 -07:00
+date: 2010-11-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,6 +60,7 @@ files:
 - lib/sawmill/logger.rb
 - lib/sawmill/multi_parser.rb
 - lib/sawmill/parser.rb
+- lib/sawmill/railtie.rb
 - lib/sawmill/record.rb
 - lib/sawmill/record_processor/compile_report.rb
 - lib/sawmill/record_processor/conditionals.rb