sgeorgi-logging 1.4.2

data/lib/logging/appenders/rolling_file.rb

@@ -0,0 +1,327 @@
+
+module Logging::Appenders
+
+  # An appender that writes to a file and ensures that the file size or age
+  # never exceeds some user specified level.
+  #
+  # The goal of this class is to write log messages to a file. When the file
+  # age or size exceeds a given limit then the log file is copied and then
+  # truncated. The name of the copy indicates it is an older log file.
+  #
+  # The name of the log file is changed by inserting the age of the log file
+  # (as a single number) between the log file name and the extension. If the
+  # file has no extension then the number is appended to the filename. Here
+  # is a simple example:
+  #
+  #    /var/log/ruby.log   =>   /var/log/ruby.1.log
+  #
+  # New log messages will continue to be appended to the same log file
+  # (<tt>/var/log/ruby.log</tt> in our example above). The age number for all
+  # older log files is incremented when the log file is rolled. The number of
+  # older log files to keep can be given, otherwise all the log files are
+  # kept.
+  #
+  # The actual process of rolling all the log file names can be expensive if
+  # there are many, many older log files to process.
+  #
+  # If you do not wish to use numbered files when rolling, you can specify the
+  # :roll_by option as 'date'. This will use a date/time stamp to
+  # differentiate the older files from one another. If you configure your
+  # rolling file appender to roll daily and ignore the file size:
+  #
+  #    /var/log/ruby.log   =>   /var/log/ruby.20091225.log
+  #
+  # Where the date is expressed as <tt>%Y%m%d</tt> in the Time#strftime format.
+  #
+  # NOTE: this class is not safe to use when log messages are written to files
+  # on NFS mounts or other remote file system. It should only be used for log
+  # files on the local file system. The exception to this is when a single
+  # process is writing to the log file; remote file systems are safe to
+  # use in this case but still not recommended.
+  #
+  class RollingFile < ::Logging::Appenders::IO
+
+    # call-seq:
+    #    RollingFile.new( name, opts )
+    #
+    # Creates a new Rolling File Appender. The _name_ is the unique Appender
+    # name used to retrieve this appender from the Appender hash. The only
+    # required option is the filename to use for creating log files.
+    #
+    #  [:filename]  The base filename to use when constructing new log
+    #               filenames.
+    #
+    # The following options are optional:
+    #
+    #  [:layout]    The Layout that will be used by this appender. The Basic
+    #               layout will be used if none is given.
+    #  [:truncate]  When set to true any existing log files will be rolled
+    #               immediately and a new, empty log file will be created.
+    #  [:size]      The maximum allowed size (in bytes) of a log file before
+    #               it is rolled.
+    #  [:age]       The maximum age (in seconds) of a log file before it is
+    #               rolled. The age can also be given as 'daily', 'weekly',
+    #               or 'monthly'.
+    #  [:keep]      The number of rolled log files to keep.
+    #  [:roll_by]   How to name the rolled log files. This can be 'number' or
+    #               'date'.
+    #
+    def initialize( name, opts = {} )
+      # raise an error if a filename was not given
+      @fn = opts.getopt(:filename, name)
+      @fn_copy = @fn + '._copy_'
+      raise ArgumentError, 'no filename was given' if @fn.nil?
+      ::Logging::Appenders::File.assert_valid_logfile(@fn)
+
+      # grab our options
+      @size = opts.getopt(:size, :as => Integer)
+
+      code = 'def sufficiently_aged?() false end'
+      @age_fn = @fn + '.age'
+      @age_fn_mtime = nil
+
+      case @age = opts.getopt(:age)
+      when 'daily'
+        code = <<-CODE
+        def sufficiently_aged?
+          @age_fn_mtime ||= ::File.mtime(@age_fn)
+          now = Time.now
+          if (now.day != @age_fn_mtime.day) or (now - @age_fn_mtime) > 86400
+            return true
+          end
+          false
+        end
+        CODE
+      when 'weekly'
+        code = <<-CODE
+        def sufficiently_aged?
+          @age_fn_mtime ||= ::File.mtime(@age_fn)
+          if (Time.now - @age_fn_mtime) > 604800
+            return true
+          end
+          false
+        end
+        CODE
+      when 'monthly'
+        code = <<-CODE
+        def sufficiently_aged?
+          @age_fn_mtime ||= ::File.mtime(@age_fn)
+          now = Time.now
+          if (now.month != @age_fn_mtime.month) or (now - @age_fn_mtime) > 2678400
+            return true
+          end
+          false
+        end
+        CODE
+      when Integer, String
+        @age = Integer(@age)
+        code = <<-CODE
+        def sufficiently_aged?
+          @age_fn_mtime ||= ::File.mtime(@age_fn)
+          if (Time.now - @age_fn_mtime) > @age
+            return true
+          end
+          false
+        end
+        CODE
+      end
+
+      FileUtils.touch(@age_fn) if @age and !test(?f, @age_fn)
+
+      meta = class << self; self end
+      meta.class_eval code, __FILE__, __LINE__
+
+      super(name, ::File.new(@fn, 'a'), opts)
+
+      # setup the file roller
+      @roller =
+          case opts.getopt(:roll_by)
+          when 'number'; NumberedRoller.new(@fn, opts)
+          when 'date'; DateRoller.new(@fn, opts)
+          else
+            (@age and !@size) ?
+                DateRoller.new(@fn, opts) :
+                NumberedRoller.new(@fn, opts)
+          end
+
+      # if the truncate flag was set to true, then roll
+      roll_now = opts.getopt(:truncate, false)
+      if roll_now
+        copy_truncate
+        @roller.roll_files
+      end
+    end
+
+    # Returns the path to the logfile.
+    #
+    def filename() @fn.dup end
+
+    # Reopen the connection to the underlying logging destination. If the
+    # connection is currently closed then it will be opened. If the connection
+    # is currently open then it will be closed and immediately opened.
+    #
+    def reopen
+      @mutex.synchronize {
+        if defined? @io and @io
+          flush
+          @io.close rescue nil
+        end
+        @closed = false
+        @io = ::File.new(@fn, 'a')
+        @io.sync = true
+      }
+      self
+    end
+
+
+    private
+
+    # call-seq:
+    #    write( event )
+    #
+    # Write the given _event_ to the log file. The log file will be rolled
+    # if the maximum file size is exceeded or if the file is older than the
+    # maximum age.
+    #
+    def write( event )
+      str = event.instance_of?(::Logging::LogEvent) ?
+            @layout.format(event) : event.to_s
+      return if str.empty?
+
+      @io.flock_sh { write_explicit(str) }
+
+      if roll_required?
+        @io.flock? {
+          @age_fn_mtime = nil
+          copy_truncate if roll_required?
+        }
+        @roller.roll_files
+      end
+    end
+
+    # Returns +true+ if the log file needs to be rolled.
+    #
+    def roll_required?
+      return false if ::File.exist? @fn_copy
+
+      # check if max size has been exceeded
+      s = @size ? ::File.size(@fn) > @size : false
+
+      # check if max age has been exceeded
+      a = sufficiently_aged?
+
+      return (s || a)
+    end
+
+    # Copy the contents of the logfile to another file. Truncate the logfile
+    # to zero length. This method will set the roll flag so that all the
+    # current logfiles will be rolled along with the copied file.
+    #
+    def copy_truncate
+      return unless ::File.exist?(@fn)
+      FileUtils.copy @fn, @fn_copy
+      @io.truncate 0
+
+      # touch the age file if needed
+      if @age
+        FileUtils.touch @age_fn
+        @age_fn_mtime = nil
+      end
+
+      @roller.roll = true
+    end
+
+
+    # :stopdoc:
+    class NumberedRoller
+      attr_accessor :roll
+
+      def initialize( fn, opts )
+        # grab the information we need to properly roll files
+        ext = ::File.extname(fn)
+        bn = ::File.join(::File.dirname(fn), ::File.basename(fn, ext))
+        @rgxp = %r/\.(\d+)#{Regexp.escape(ext)}\z/
+        @glob = "#{bn}.*#{ext}"
+        @logname_fmt = "#{bn}.%d#{ext}"
+        @fn_copy = fn + '._copy_'
+        @keep = opts.getopt(:keep, :as => Integer)
+        @roll = false
+      end
+
+      def roll_files
+        return unless @roll and ::File.exist?(@fn_copy)
+
+        files = Dir.glob(@glob).find_all {|fn| @rgxp =~ fn}
+        unless files.empty?
+          # sort the files in revese order based on their count number
+          files = files.sort do |a,b|
+                    a = Integer(@rgxp.match(a)[1])
+                    b = Integer(@rgxp.match(b)[1])
+                    b <=> a
+                  end
+
+          # for each file, roll its count number one higher
+          files.each do |fn|
+            cnt = Integer(@rgxp.match(fn)[1])
+            if @keep and cnt >= @keep
+              ::File.delete fn
+              next
+            end
+            ::File.rename fn, sprintf(@logname_fmt, cnt+1)
+          end
+        end
+
+        # finally reanme the copied log file
+        ::File.rename(@fn_copy, sprintf(@logname_fmt, 1))
+      ensure
+        @roll = false
+      end
+    end
+
+    class DateRoller
+      attr_accessor :roll
+
+      def initialize( fn, opts )
+        @fn_copy = fn + '._copy_'
+        @roll = false
+        @keep = opts.getopt(:keep, :as => Integer)
+
+        ext = ::File.extname(fn)
+        bn = ::File.join(::File.dirname(fn), ::File.basename(fn, ext))
+
+        if @keep
+          @rgxp = %r/\.(\d+)(-\d+)?#{Regexp.escape(ext)}\z/
+          @glob = "#{bn}.*#{ext}"
+        end
+
+        if %w[daily weekly monthly].include?(opts.getopt(:age)) and !opts.getopt(:size)
+          @logname_fmt = "#{bn}.%Y%m%d#{ext}"
+        else
+          @logname_fmt = "#{bn}.%Y%m%d-%H%M%S#{ext}"
+        end
+      end
+
+      def roll_files
+        return unless @roll and ::File.exist?(@fn_copy)
+
+        # reanme the copied log file
+        ::File.rename(@fn_copy, Time.now.strftime(@logname_fmt))
+
+        # prune old log files
+        if @keep
+          files = Dir.glob(@glob).find_all {|fn| @rgxp =~ fn}
+          length = files.length
+          if length > @keep
+            files.sort {|a,b| b <=> a}.last(length-@keep).each {|fn| ::File.delete fn}
+          end
+        end
+      ensure
+        @roll = false
+      end
+    end
+    # :startdoc:
+
+  end  # class RollingFile
+end  # module Logging::Appenders
+
+# EOF

data/lib/logging/appenders/string_io.rb

@@ -0,0 +1,68 @@
+
+module Logging::Appenders
+
+  # This class provides an Appender that can write to a StringIO instance.
+  # This is very useful for testing log message output.
+  #
+  class StringIo < ::Logging::Appenders::IO
+
+    # The StringIO instance the appender is writing to.
+    attr_reader :sio
+
+    # call-seq:
+    #    StringIo.new( name, opts = {} )
+    #
+    # Creates a new StrinIo appender that will append log messages to a
+    # StringIO instance.
+    #
+    def initialize( name, opts = {} )
+      @sio = StringIO.new
+      @sio.extend IoToS
+      @pos = 0
+      super(name, @sio, opts)
+    end
+
+    # Clears the internal StringIO instance. All log messages are removed
+    # from the buffer.
+    #
+    def clear
+      sync {
+        @pos = 0
+        @sio.seek 0
+        @sio.truncate 0
+      }
+    end
+    alias :reset :clear
+
+    %w[read readline readlines].each do|m|
+      class_eval <<-CODE
+        def #{m}( *args )
+          sync {
+            begin
+              @sio.seek @pos
+              rv = @sio.#{m}(*args)
+              @pos = @sio.tell
+              rv
+            rescue EOFError
+              nil
+            end
+          }
+        end
+      CODE
+    end
+
+    # :stopdoc:
+    module IoToS
+      def to_s
+        seek 0
+        str = read
+        seek 0
+        return str
+      end
+    end
+    # :startdoc:
+
+  end  # class StringIo
+end  # module Logging::Appenders
+
+# EOF

data/lib/logging/appenders/syslog.rb

@@ -0,0 +1,210 @@
+
+# only load this class if we have the syslog library
+# Windows does not have syslog
+#
+if HAVE_SYSLOG
+
+module Logging::Appenders
+
+  # This class provides an Appender that can write to the UNIX syslog
+  # daemon.
+  #
+  class Syslog < ::Logging::Appender
+    include ::Syslog::Constants
+
+    # call-seq:
+    #    Syslog.new( name, opts = {} )
+    #
+    # Create an appender that will log messages to the system message
+    # logger. The message is then written to the system console, log files,
+    # logged-in users, or forwarded to other machines as appropriate. The
+    # options that can be used to configure the appender are as follows:
+    #
+    #    :ident     => identifier string (name is used by default)
+    #    :logopt    => options used when opening the connection
+    #    :facility  => the syslog facility to use
+    #
+    # The parameter :ident is a string that will be prepended to every
+    # message. The :logopt argument is a bit field specifying logging
+    # options, which is formed by OR'ing one or more of the following
+    # values:
+    #
+    #    LOG_CONS      If syslog() cannot pass the message to syslogd(8) it
+    #                  wil attempt to write the message to the console
+    #                  ('/dev/console').
+    #
+    #    LOG_NDELAY    Open the connection to syslogd(8) immediately. Normally
+    #                  the open is delayed until the first message is logged.
+    #                  Useful for programs that need to manage the order in
+    #                  which file descriptors are allocated.
+    #
+    #    LOG_PERROR    Write the message to standard error output as well to
+    #                  the system log.
+    #
+    #    LOG_PID       Log the process id with each message: useful for
+    #                  identifying instantiations of daemons.
+    #
+    # The :facility parameter encodes a default facility to be assigned to
+    # all messages that do not have an explicit facility encoded:
+    #
+    #    LOG_AUTH      The authorization system: login(1), su(1), getty(8),
+    #                  etc.
+    #
+    #    LOG_AUTHPRIV  The same as LOG_AUTH, but logged to a file readable
+    #                  only by selected individuals.
+    #
+    #    LOG_CONSOLE   Messages written to /dev/console by the kernel console
+    #                  output driver.
+    #
+    #    LOG_CRON      The cron daemon: cron(8).
+    #
+    #    LOG_DAEMON    System daemons, such as routed(8), that are not
+    #                  provided for explicitly by other facilities.
+    #
+    #    LOG_FTP       The file transfer protocol daemons: ftpd(8), tftpd(8).
+    #
+    #    LOG_KERN      Messages generated by the kernel. These cannot be
+    #                  generated by any user processes.
+    #
+    #    LOG_LPR       The line printer spooling system: lpr(1), lpc(8),
+    #                  lpd(8), etc.
+    #
+    #    LOG_MAIL      The mail system.
+    #
+    #    LOG_NEWS      The network news system.
+    #
+    #    LOG_SECURITY  Security subsystems, such as ipfw(4).
+    #
+    #    LOG_SYSLOG    Messages generated internally by syslogd(8).
+    #
+    #    LOG_USER      Messages generated by random user processes. This is
+    #                  the default facility identifier if none is specified.
+    #
+    #    LOG_UUCP      The uucp system.
+    #
+    #    LOG_LOCAL0    Reserved for local use. Similarly for LOG_LOCAL1
+    #                  through LOG_LOCAL7.
+    #
+    def initialize( name, opts = {} )
+      @ident = opts.getopt(:ident, name)
+      @logopt = opts.getopt(:logopt, (LOG_PID | LOG_CONS), :as => Integer)
+      @facility = opts.getopt(:facility, LOG_USER, :as => Integer)
+      @syslog = ::Syslog.open(@ident, @logopt, @facility)
+
+      # provides a mapping from the default Logging levels
+      # to the syslog levels
+      @map = [LOG_DEBUG, LOG_INFO, LOG_WARNING, LOG_ERR, LOG_CRIT]
+
+      map = opts.getopt(:map)
+      self.map = map unless map.nil?
+
+      super
+    end
+
+    # call-seq:
+    #    map = { logging_levels => syslog_levels }
+    #
+    # Configure the mapping from the Logging levels to the syslog levels.
+    # This is needed in order to log events at the proper syslog level.
+    #
+    # Without any configuration, the following maping will be used:
+    #
+    #    :debug  =>  LOG_DEBUG
+    #    :info   =>  LOG_INFO
+    #    :warn   =>  LOG_WARNING
+    #    :error  =>  LOG_ERR
+    #    :fatal  =>  LOG_CRIT
+    #
+    def map=( levels )
+      map = []
+      levels.keys.each do |lvl|
+        num = ::Logging.level_num(lvl)
+        map[num] = syslog_level_num(levels[lvl])
+      end
+      @map = map
+    end
+
+    # call-seq:
+    #    close
+    #
+    # Closes the connetion to the syslog facility.
+    #
+    def close( footer = true )
+      super
+      @syslog.close
+      self
+    end
+
+    # call-seq:
+    #    closed?    => true or false
+    #
+    # Queries the connection to the syslog facility and returns +true+ if
+    # the connection is closed.
+    #
+    def closed?
+      !@syslog.opened?
+    end
+
+    # Reopen the connection to the underlying logging destination. If the
+    # connection is currently closed then it will be opened. If the connection
+    # is currently open then it will be closed and immediately opened.
+    #
+    def reopen
+      @mutex.synchronize {
+        if @syslog.opened?
+          flush
+          @syslog.close
+        end
+        @syslog = ::Syslog.open(@ident, @logopt, @facility)
+        @closed = false
+      }
+      self
+    end
+
+
+    private
+
+    # call-seq:
+    #    write( event )
+    #
+    # Write the given _event_ to the syslog facility. The log event will be
+    # processed through the Layout assciated with this appender. The message
+    # will be logged at the level specified by the event.
+    #
+    def write( event )
+      pri = LOG_DEBUG
+      message = if event.instance_of?(::Logging::LogEvent)
+          pri = @map[event.level]
+          @layout.format(event)
+        else
+          event.to_s
+        end
+      return if message.empty?
+
+      @syslog.log(pri, '%s', message)
+      self
+    end
+
+    # call-seq:
+    #    syslog_level_num( level )    => integer
+    #
+    # Takes the given _level_ as a string, symbol, or integer and returns
+    # the corresponding syslog level number.
+    #
+    def syslog_level_num( level )
+      case level
+      when Integer; level
+      when String, Symbol
+        level = level.to_s.upcase
+        self.class.const_get level
+      else
+        raise ArgumentError, "unkonwn level '#{level}'"
+      end
+    end
+
+  end  # class Syslog
+
+end  # module Logging::Appenders
+end  # HAVE_SYSLOG
+
+# EOF