Linux 工具--logrotate

以下内容來自logrotate的man手冊。

LOGROTATE(8)                              System Administrator's Manual                             LOGROTATE(8)

NAME

       logrotate ‐ rotates, compresses, and mails system logs

SYNOPSIS

       logrotate [-dv] [-f|--force] [-s|--state file] config_file ..

DESCRIPTION

       logrotate  is  designed  to  ease administration of systems that generate large numbers of log files.  It  allows automatic rotation, compression, removal, and mailing of log files.  Each log file may be  handled    daily, weekly, monthly, or when it grows too large.

       指令行上可以提供任意數量的配置檔案。 較新的配置檔案可能會覆寫較早的檔案中提供的選項，是以列出logrotate配置檔案的順序很重要。 通常，應使用包含所需其他任何配置檔案的單個配置檔案。 有關如何使用include指令完成此操作的更多資訊，請參見下文。 如果在指令行上給出了目錄，則該目錄中的每個檔案都将用作配置檔案。

       如果輪換日志時發生任何錯誤，logrotate将以非零狀态退出。

OPTIONS

       -?, --help

              Prints help message.

       -d, --debug

              Turns  on debug mode and implies -v.  在調試模式下，将不會對日志或logrotate狀态檔案進行任何更改。

       -f, --force

              Tells logrotate to force the rotation, even if it doesn't think this is necessary.  強制執行logrotate，當logrotate配置檔案更改或舊日志被手動删除時，很有用。

       -m, --mail <command>

              告訴logrotate郵寄日志時使用哪個指令。 此指令應接受兩個參數：

               1）消息的主題，以及

               2）收件人。 然後，該指令必須閱讀标準輸入中的消息并将其郵寄給收件人。 預設的郵件指令是/usr/bin/mail -s。

       -s, --state <statefile>

              設定logrotate使用備用狀态檔案。 如果logrotate以不同使用者的身份運作于各種日志檔案集，則這很有用。 預設狀态檔案為/var/lib/logrotate/status.

       --usage

              Prints a short usage message.

       -v, --verbose

              Turns on verbose mode, ie. display messages during rotation.

CONFIGURATION FILE

      logrotate從指令行上指定的一系列配置檔案中讀取應處理的日志檔案的所有内容。 每個配置檔案都可以設定全局選項（本地定義覆寫全局選項，以後的定義覆寫較早的選項）并指定要輪換的日志檔案。 一個簡單的配置檔案如下所示：      

# sample logrotate configuration file
       compress
       /var/log/messages {
           rotate 5
           weekly
           postrotate
               /usr/bin/killall -HUP syslogd
           endscript
       }

       "/var/log/httpd/access.log" /var/log/httpd/error.log {
           rotate 5
           mail [email protected]
           size 100k
           sharedscripts
           postrotate
               /usr/bin/killall -HUP httpd
           endscript
       }

       /var/log/news/* {
           monthly
           rotate 2
           olddir /var/log/news/old
           missingok
           postrotate
               kill -HUP `cat /var/run/inn.pid`
           endscript
           nocompress
       }

       ~/log/*.log {}
           

            第一行：

                   # 開頭的是注釋；

                   compress是全局變量，對下面的日志配置都生效，後面其它的logrotate配置檔案可以覆寫。

       配置檔案的下一部分定義了如何處理日志檔案/var/log/messages。 日志将在删除之前先經曆五周的輪換。 旋轉日志檔案之後（但在壓縮舊版本的日志之前），将執行指令/sbin/killall -HUP syslogd。

       下一節将定義/var/log/httpd/access.log和/var/log/httpd/error.log的參數。每當大小超過100k時，每個檔案都會旋轉一次，并且經過5次旋轉後，舊日志檔案會被郵寄（未壓縮）到[email protected]，而不是被删除。 sharedscripts意味着postrotate腳本将隻運作一次（在壓縮舊日志之後），而不是為每個循環日志運作一次。請注意，日志檔案名可能用引号引起來（如果名稱包含空格，則必須使用引号）。普通的外殼引用規則适用，并支援'，'和\字元。

       下一節将定義/var/log/news中所有檔案的參數。每個檔案每月輪換一次。這被視為單個旋轉指令，并且如果多個檔案發生錯誤，則不會壓縮日志檔案。

       最後一部分使用波浪号擴充來輪換目前使用者的主目錄中的日志檔案。僅當您的glob庫支援波浪号擴充時，此選項才可用。 GNU glob确實支援這一點。

       請謹慎使用通配符。如果指定*，logrotate将旋轉所有檔案，包括先前旋轉的檔案。解決此問題的一種方法是使用olddir指令或更精确的通配符（例如* .log）。

       如果目錄/var/log/news不存在，這将導緻logrotate報告錯誤。無法使用missingok指令停止此錯誤。

       這是有關可能包含在logrotate配置檔案中的指令的更多資訊：

       compress

              Old versions of log files are compressed with gzip(1) by default. See also nocompress.

       compresscmd

              Specifies which command to use to compress log files.  The default is gzip(1).  See also compress.

       uncompresscmd

              Specifies which command to use to uncompress log files.  The default is gunzip(1).

       compressext

              Specifies which extension to use on compressed logfiles, if compression is enabled.   The  default  follows that of the configured compression command.

       compressoptions

              Command line options may be passed to the compression program, if one is in use.  The default, for  gzip(1), is "-6" (biased towards high compression at the expense of speed).  If you use a  different compression command, you may need to change the compressoptions to match.

       copy   

              Make  a  copy of the log file, but don't change the original at all.  This option can be used, for  instance, to make a snapshot快照 of the current log file, or when some other utility needs to truncate or  parse  the  file.  When this option is used, the create option will have no effect, as the old log file stays in place.

       copytruncate

              Truncate the original log file to zero size in place after creating a copy, instead of moving  the  old  log  file and optionally creating a new one.  It can be used when some program cannot be told to close its logfile and thus might continue writing (appending) to the previous log file forever.

              Note  that  there  is  a very small time slice between copying the file and truncating it, so some logging data might be lost.  When this option is used, the create option will have no  effect,  as the old log file stays in place.

       create mode owner group, create owner group

              Immediately after rotation (before the postrotate script is run) the log file is created (with the same name as the log file just rotated).  mode specifies the mode for the log file in  octal  (the same  as  chmod(2)),  owner specifies the user name who will own the log file, and group specifies the group the log file will belong to. Any of the log file attributes may  be  omitted,  in  which case  those  attributes for the new file will use the same values as the original log file for the omitted attributes. This option can be disabled using the nocreate option.

       daily  Log files are rotated every day.

       dateext

              Archive old versions of log files adding a date extension like YYYYMMDD instead of simply adding a number. The extension may be configured using the dateformat and dateyesterday options.

       dateformat format_string

              Specify  the  extension for dateext using the notation similar to strftime(3) function. Only %Y %m %d and %s specifiers are allowed.  The default value is -%Y%m%d. Note that also the character separating log name from the extension is part of the dateformat string. The system clock must be set past Sep 9th 2001 for %s to work correctly.  Note that the datestamps  generated  by  this  format must be lexically sortable (i.e., first the year, then the month then the day. e.g., 2001/12/01 is ok, but 01/12/2001 is not, since 01/11/2002 would sort lower while it is later).  This is  because when using the rotate option, logrotate sorts all rotated filenames to find out which logfiles are older and should be removed.

       dateyesterday

              Use yesterday's instead of today's date to create the dateext extension, so that the  rotated  log file has a date in its name that is the same as the timestamps within it.

       delaycompress

              Postpone  compression  of  the previous log file to the next rotation cycle.  This only has effect when used in combination with compress.  It can be used when some program cannot be told to  close its logfile and thus might continue writing to the previous log file for some time.

       extension ext

              Log  files with ext extension can keep it after the rotation.  If compression  is  used,  the compression extension (normally .gz) appears  after  ext.  For  example  you  have  a  logfile  named mylog.foo and want to rotate it to mylog.1.foo.gz instead of mylog.foo.1.gz.

       hourly

              Log  files  are  rotated  every  hour. Note that usually logrotate is configured to be run by cron  daily. You have to change this configuration and run logrotate hourly to be able to really  rotate logs hourly.

       ifempty

              Rotate  the  log  file  even  if  it  is  empty,  overriding the notifempty option (ifempty is the  default).

       include file_or_directory

              Reads the file given as an argument as if it was  included  inline  where  the  include  directive appears. If a directory is given, most of the files in that directory are read in alphabetic order  before processing of the including file continues. The only files  which  are  ignored  are  files which  are  not regular files (such as directories and named pipes) and files whose names end with one of the taboo extensions, as specified by the tabooext directive.

       mail address

              When a log is rotated out of existence, it is mailed to address. If no mail should be generated by  a particular log, the nomail directive may be used.

       mailfirst

              When using the mail command, mail the just-rotated file, instead of the about-to-expire file.

       maillast

              When using the mail command, mail the about-to-expire file, instead of the just-rotated file (this  is the default).

       maxage count

              Remove rotated logs older than <count> days. The age is only checked  if  the  logfile  is  to  be rotated. The files are mailed to the configured address if maillast and mail are configured.

       maxsize size

              Log files are rotated when they grow bigger than size bytes even before the additionally specified time interval (daily, weekly, monthly, or yearly).  The related size option is similar except that it  is  mutually  exclusive  with the time interval options, and it causes log files to be rotated without regard for the last rotation time.  When maxsize is used, both the size and timestamp of a log file are considered.

               當日志檔案變得大于大小位元組時，甚至在額外指定的時間間隔（每天，每周，每月或每年）之前，日志檔案就會輪換。

       minsize  size

              Log files are rotated when they grow bigger than size bytes, but not before the additionally specified time interval (daily, weekly, monthly, or yearly).   The  related  size  option  is  similar except that it is mutually exclusive with the time interval options, and it causes log files to be rotated without regard for the last rotation time.  When minsize is used, both the size and  timestamp of a log file are considered.

              當日志檔案增長到大于大小位元組時，而不是在額外指定的時間間隔（每天，每周，每月或每年）之前，将對其進行輪換。

       missingok

              If  the  log  file  is  missing,  go on to the next one without issuing an error message. See also  nomissingok.

       monthly

              Log files are rotated the first time logrotate is run in a month (this is normally  on  the  firstday of the month).

       nocompress

              Old versions of log files are not compressed. See also compress.

       nocopy

              Do not copy the original log file and leave it in place.  (this overrides the copy option).

       nocopytruncate

              Do not truncate the original log file in place after creating a copy (this overrides the copytruncate option).

       nocreate

              New log files are not created (this overrides the create option).

       nodelaycompress

              Do not postpone compression of the previous log file to the next rotation  cycle  (this  overrides the delaycompress option).

       nodateext

              Do not archive  old versions of log files with date extension (this overrides the dateext option).

       nomail

              Do not mail old log files to any address.

       nomissingok

              If a log file does not exist, issue an error. This is the default.

       noolddir

              Logs are rotated in the directory they normally reside in (this overrides the olddir option).

       nosharedscripts

              Run prerotate and postrotate scripts for every log file which is rotated (this is the default, and overrides the sharedscripts option). The absolute path to the log file is passed as first argument to  the script. If the scripts exit with error, the remaining actions will not be executed for the  affected log only. 

              為每個輪換的日志檔案運作prerotate和postrotate腳本（這是預設設定，并覆寫sharedscripts選項）。

       noshred

              Do not use shred when deleting old log files. See also shred.

       notifempty

              Do not rotate the log if it is empty (this overrides the ifempty option).

              空日志不rotate。

       olddir directory

              Logs are moved into directory for rotation. The directory must be on the same physical  device  as the  log  file  being rotated, and is assumed to be relative to the directory holding the log file unless an absolute path name is specified. When this option is used all old versions  of  the  log end up in directory.  This option may be overridden by the noolddir option.

       postrotate/endscript

              The  lines between postrotate and endscript (both of which must appear on lines by themselves) are executed (using /bin/sh) after the log file is rotated. These directives may only appear inside  a log  file  definition.  Normally, the absolute path to the log file is passed as first argument to the script. If sharedscripts is specified, whole pattern is passed to the script.  See  also  prerotate. See sharedscripts and nosharedscripts for error handling.

               旋轉日志檔案後，将執行postrotate和endscript之間的行（兩者都必須自己顯示在行上）。

       prerotate/endscript

              The  lines  between prerotate and endscript (both of which must appear on lines by themselves) are executed (using /bin/sh) before the log file is rotated and only  if  the  log  will  actually  be rotated.  These  directives  may  only appear inside a log file definition. Normally, the absolute path to the log file is passed as first argument to the script.  If  sharedscripts  is  specified, whole  pattern  is  passed  to  the script.  See also postrotate.  See sharedscripts and nosharedscripts for error handling.

       firstaction/endscript

              The lines between firstaction and endscript (both of which must appear on lines by themselves) are executed  (using /bin/sh) once before all log files that match the wildcarded pattern are rotated, before prerotate script is run and only if at least one  log  will  actually  be  rotated.   These directives  may only appear inside a log file definition. Whole pattern is passed to the script as first argument. If the script exits with error, no further processing is done.  See  also  lastaction.

               僅在旋轉所有與通配符模式比對的日志檔案之前，在運作prerotate腳本之前并且僅在至少一個以下條件下，執行一次（使用/ bin / sh）firstaction和endscript之間的行（兩者都必須自己顯示在行上） 日志實際上将被輪換。

       lastaction/endscript

              The  lines between lastaction and endscript (both of which must appear on lines by themselves) are executed (using /bin/sh) once after all log files that match the wildcarded pattern  are  rotated, after  postrotate script is run and only if at least one log is rotated. These directives may only appear inside a log file definition. Whole pattern is passed to the script as first  argument.  If the script exits with error, just an error message is shown (as this is the last action). See also firstaction.

            在旋轉所有與通配符模式比對的日志檔案之後，在運作postrotate腳本之後，并且僅當至少一個以下條件運作時，一次執行lastaction和endscript之間的行（兩者都必須自己顯示在行上）： 日志被旋轉。

       preremove/endscript

              The lines between preremove and endscript (both of which must appear on lines by  themselves)  are executed (using /bin/sh) once just before removal of a log file.  The logrotate will pass the name of file which is soon to be removed. See also firstaction.

       rotate count

              Log files are rotated count times before being removed or mailed to the  address  specified  in  a mail directive. If count is 0, old versions are removed rather than rotated.

              日志檔案将旋轉count次，然後再删除或郵寄到mail指令中指定的位址。 如果count為0，則将删除舊版本，而不是旋轉舊版本。

       size size

              Log files are rotated only if they grow bigger then size bytes. If size is followed by k, the size is assumed to be in kilobytes.  If the M is used, the size is in megabytes, and if G is used,  the size is in gigabytes. So size 100, size 100k, size 100M and size 100G are all valid.

       sharedscripts

              Normally,  prerotate and postrotate scripts are run for each log which is rotated and the absolute path to the log file is passed as first argument to the script. That means a single script may  be run  multiple  times  for log file entries which match multiple files (such as the /var/log/news/* example). If sharedscripts is specified, the scripts are only run once, no matter  how  many  logs match  the  wildcarded pattern, and whole pattern is passed to them.  However, if none of the logs in the pattern require rotating, the scripts will not be run at all.  If  the  scripts  exit  with error,  the  remaining  actions  will  not  be  executed  for  any logs. This option overrides the nosharedscripts option and implies create option.

             通常，對每個循環日志運作prerotate和postrotate腳本，并将日志檔案的絕對路徑作為第一個參數傳遞給腳本。

       shred 

              Delete log files using shred -u instead of unlink().  This should ensure that logs are  not  readable after their scheduled deletion; this is off by default.  See also noshred.

       shredcycles count

              Asks  GNU  shred(1)  to  overwrite  log  files  count times before deletion.  Without this option, shred's default will be used.

       start count

              This is the number to use as the base for rotation. For example, if you specify 0, the  logs  will  be created with a .0 extension as they are rotated from the original log files.  If you specify 9,  log files will be created with a .9, skipping 0-8.  Files will still  be  rotated  the  number  of times specified with the rotate directive.

       su user group

              Rotate log files set under this user and group instead of using default user/group (usually root). user specifies the user name used for rotation and group specifies the group used for rotation. If the  user/group  you specify here does not have sufficient privilege to make files with the ownership you've specified in a create instruction, it will cause an error.

       tabooext [+] list

              The current taboo extension list is changed (see the include  directive  for  information  on  the taboo  extensions).  If  a  + precedes the list of extensions, the current taboo extension list is augmented, otherwise it is replaced. At startup,  the  taboo  extension  list  contains  .rpmsave,.rpmorig, ~, .disabled, .dpkg-old, .dpkg-dist, .dpkg-new, .cfsaved, .ucf-old, .ucf-dist, .ucf-new,.rpmnew, .swp, .cfsaved, .rhn-cfg-tmp-*

       weekly

              Log files are rotated if the current weekday is less than the weekday of the last rotation  or  if  more than a week has passed since the last rotation. This is normally the same as rotating logs on the first day of the week, but it works better if logrotate is not run every night.

       yearly

              Log files are rotated if the current year is not the same as the last rotation.

FILES

       /var/lib/logrotate.status  Default state file.

       /etc/logrotate.conf        Configuration options.

SEE ALSO

       gzip(1)

NOTES

       The killall(1) program in Debian is found in the psmisc package.

AUTHORS

       Erik Troan, Preston Brown, Jan Kaluza.

       <[email protected]>

       <http://fedorahosted.org/logrotate/>

       Corrections and changes for Debian by Paul Martin <[email protected]>

Linux                                            Wed Nov 5 2002                                     LOGROTATE(8)