Class Logging::Appenders::RollingFile
In: lib/logging/appenders/rolling_file.rb
Parent: ::Logging::Appenders::IO

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 closed, the name is changed to indicate it is an older log file, and a new log file is created.

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 be appended to a newly opened log file of the same name (/var/log/ruby.log 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.

Methods

new  

Public Class methods

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.
 [:safe]      When set to true, extra checks are made to ensure that
              only once process can roll the log files; this option
              should only be used when multiple processes will be
              logging to the same log file (does not work on Windows)

[Validate]