このサイトは、もともと作者の自分用メモとして書き始めたものです。書いてあることが全て正しいとは限りません。他の文献、オフィシャルなサイトも確認して、自己責任にて利用してください。

logrotate

logrotate は、放っておけば際限なく肥大してしまう各種ログファイルに対して、世代ローテーションをして何代目かになったら破棄するとか、それらをメールでどこかに送信するなど、様々な処理が行える。世代管理やサイズ制限などの機構を自前で持たないプログラムからのログを管理するのになくてはならない道具だ。

Logrotate実行の流れ

logrotate 自体はデーモンではないので cron (※1) と組み合わせて利用する。実行の流れは、RedHat系ディストリビューションでは以下のようになっている：

• cron が run-parts コマンド(※2)で /etc/cron.daily/logrotate スクリプトをキックする。
• /etc/cron.daily/logrotate は 主設定ファイルである /etc/logrotate.conf から設定を読み込んで logrotate を起動する。
• /etc/logrotate.conf はそのディレクティブ "include" により、/etc/logrotate.d/ にある各ログ個別の設定を読み込む。

※1 RHEL/CentOS 6 ではシステムメンテナンスジョブの主駆動機構が cron から anacron に変わっており、cron.daily, cron.weekly 配下のスクリプトの実行も anacron の方に任されている。
※2 正確には、run-parts はシェルスクリプトで、RHEL/CentOS 5系までは cron 関連のパッケージ、6系からは anacron 関連のパッケージに含まれている。

つまり、logrotate で管理したい新たなログがあれば /etc/logrotate.d/ ディレクトリにある既存のファイルを編集するか、新たに作ってやればいいわけだ。相手が syslogd を経由してログを吐き出しているプログラムで、特にねじくれた処理を必要としないのなら、既存の /etc/logrotate.d/syslog にログファイル名を書き足すだけでも充分だ。仮に、対象のログが /var/log/some/some.log だとしたら、下記の赤字の箇所を足す：

#/etc/logrotate.d/syslog
/var/log/messages /var/log/secure /var/log/maillog /var/log/spooler /var/log/boot.log /var/log/cron /var/log/some/some.log {
  sharedscripts
  postrotate
    /bin/kill -HUP `cat /var/run/syslogd.pid 2> /dev/null` 2> /dev/null || true
  endscript
}

参考のため、主設定ファイル /etc/logrotate.conf の内容も見ておこう：

#/etc/logrotate.conf
weekly
rotate 4
create
include /etc/logrotate.d
/var/log/wtmp {
  monthly
  create 0644 root utmp
  rotate 1
}

設定の書き方

logrotateの主設定ファイルは /etc/logrotate.conf。通常は、そこにはデフォルトとなるグローバルな設定だけを書き、ログファイルグループ毎の個別の設定は /etc/logrotate.d/ 配下の設定ファイルに分割し、下記に述べる include ディレクティブで読み込ませる。logrotate の設定書式の基本は；

[logfile [logfile ...] {]
 directive
 [directive ...]
[}]

• 対象ログファイルを指定してその所作を定義する場合には { } で括る。
• 対象ログファイルは一度に複数指定 (スペース区切り) することもできる。対象ファイルは * によるワイルドカード指定も可能なので、より正確には 対象ログファイルパターン と呼ぶべきだ。ただし、拡張子も何もないただの * ではローテーション後のファイルもローテーションされてしまうので注意。ディレクトリを直接指定することはできない。また、サブディレクトリの再帰的処理も行われない。
• 対象ログファイルパターンを指定せず裸で規定したディレクティブは、グローバルな既定値として扱われる。ただし、ログファイル個別のディレクティブのほうが優先順位が高く、グローバル設定を上書きする。

上記のディレクティブのうちいくつかは logrotate のバージョンによって挙動が少々異なる (postrotate の実行条件など)。

logrotate プログラム自体にもオプションがある。例えば -d オプションを付けるとデバグモードで走り、行われるはず の動作が詳細に出力されるだけで、実際には何も行われない。これは動作を理解するのにも役に立つ。 '-d 個別設定ファイル名 ' とすると作ったばかりの設定ファイルの試験ができる。動作実験のためのちょっとしたスクリプトを作ったので tar.gz して置いておく。

捨てられるログを外部保管させる

ローカルディスク上でのローテーションは数世代に抑えたいが、古いログファイルは廃棄せずに外部媒体や別のディスクに移して長期保存(アーカイブ)したい、という、2段階管理の必要なケースが出てきた。これは logrotate 自体の機能だけでは無理だが、ちょっとしたシェルスクリプトを用意し、firstaction ブロックまたは prerotate ブロックからそれを呼んで処理してやれば実現できる。ローテーション管理下にある最古世代のログファイルを、廃棄する直前にシェルスクリプトで他所へコピーし、あとは何喰わぬ顔で通常のローテーションをさせるという手筈だ。また、logrotate には、旧ログを別ディレクトリへ移動する設定(olddir設定句)の場合でも、別のデバイス上へは移動できないという制限があるが、この手を使えばその縛りからも逃れられる。

まず、コピー処理をするシェルスクリプトを作る。これ (prerotacopy) だ。logrotate は、スクリプトブロック内に書かれたスクリプトに対して、firstaction の場合や、 sharedscripts の有効な prerotate の場合は、個別定義ブロックで謳われたローテート対象ファイルパターンリストをそのまま引数として渡してくる。nosharedscripts 状態の prerotate では、ファイルパターン毎に、実際にローテーション対象となるファイル名 (.2や-YYYYmmdd未付加) を引数にしてスクリプトが呼ばれる。prerotacopy はそれをポジショナルパラメータで受け取り、ループで回して、最古世代のファイルを所定のディレクトリへコピーする。この時注意しなければならないのは、特に firstaction や sharedscripts の場合、ログファイルのリストはワイルドカードを含むケースがあるわけで、シェルグロブの展開を踏まえて 2次元配列的に処理する必要があるという点。こんな感じだ (スクリプトから抜粋し少し単純化してある)；

for V in $*; do
    for F in $V; do
        if [ -f $F.$GEN ]; then
            EXT=$(stat $F.$GEN |grep ^Modify |cut -d' ' -f2-3 |cut -d':' -f1 |tr -d '[[:blank:]-]')
            cp -pf $F.$GEN ${OUTDIR}/$(basename $F)-$EXT || :
        fi
    done
done

設定ファイルへの組み込みは下記のようにする。dateext (ローテート後のファイルが世代番号 ".x"付きでなく日付"-YYYYmmdd" になる) が有効になっていると、削除されるファイル名の判定のしようがないので、最上流の /etc/logrotate.conf で dateext が指定されている場合は当該の個別設定ファイルに nodateext の指定が必要だ。また、logrotate 自体でファイルを圧縮する設定(compress) にしているケースも今のところ想定していない。

/var/log/test/*.log {
    daily
    rotate 5
    create
    nodateext
    nocompress
    missingok
    firstaction
        /usr/local/bin/prerotacopy -n 5 -z -o /mnt/logsave/test ${1+"$@"}
    endscript
}

prerotacopy スクリプトには、-n N で最古世代のログファイルの世代番号(※最古とは限らず応用も可能)、-o でコピー先ディレクトリを指定する。加えて -z オプションも付けると、単にコピーする代わりに gzip で圧縮する。コピー先へは、圧縮無しの場合は file-YYYYmmddHH、圧縮ありの場合は file-YYYYmmddHH.gz の名前で格納される。YYYYmmddHH はコピー元ファイルの最終更新日時から採るようにした。-a オプションは Auto-parent の意味合いで、例えば、

/var/log/ServerA/messages /var/log/ServerB/ntp.log { ...

という個別定義内で、

firstaction
    /usr/local/bin/prerotacopy -n 5 -a -o /mnt/logsave ${1+"$@"}
endscript

とやると、行き先は、ソースファイルの直上と同名のディレクトリが割り込んで /mnt/logsave/ServerA/messages-YYYYmmddHH, /mnt/logsave/ServerB/ntp.log-YYYYmmddHH という具合になる。この時の ServerA や ServerB ディレクトリは、存在しなければ自動的に作られる。ただし、それより上の /mnt/logsave や /mnt がない時はエラー扱いとした。

ここでもうひとつ注意がある。prerotacopy を prerotate ブロックで組み込む場合、logrotate のバージョンによって -n に指定すべき世代番号が異なるのだ。logrotate-3.7.1 では設定ファイルの rotate X と同じに。3.7.4 以降では、X +1 の数を指定しなければならないことが分かった。つまり、3.7.4 以降では、prerotate スクリプトが実行される時点で既に、旧世代ログのローテーションが行われている - ただしカレントログファイルのローテーションと最古ファイルの削除はまだの状態だ(つまりその時 xxx.log.1 は存在しない)。firstaction ならどちらのバージョンでも N=X でよかった。限られたバージョンしか試していないので、それ以外の場合は実地に試してみてから運用していただきたい。