この記事は株式会社ネクスト(Lifull) Advent Calendar 2016の3日目の記事です。遅くなってしまいましたが、なんとか当日に間に合わせましたいました。

本記事はLinuxのlogrotateコマンドについての説明をするものであり、その他のログに関する話は一切出てきません。ご了承ください。

man logrotateにも書いてあることですがlogrotateは複数のログファイルを圧縮、削除、メールで送信するための機能です。これにより「ファイルサイズがN以上になったら」とか「日次・週次・月次などで分割」などが容易に可能になります。

logrotate自体はデーモンではなくcrondによって実現されています。利用する前にcrondが動いていることを確認しましょう。

続いてlogrotateがインストールされているかの確認です。たぶん通常はインストールされていて、ある程度よしなに動くように設定されていると思います。

インストールされてなかったらyumで入れればよいかと思われます。

ではlogrotateの動作を確認していきましょう

練習用のログファイルを用意します。適当にapacheのログファイルを/tmp/logにコピーして置いておきました。すでにある程度logrotate済みのファイルでしたので*-yyyymmmdd形式になってます。

とりあえずこのaccess_logを対象とする設定ファイルを書いてみます。

設定ファイル内では対象とするログのファイルパス、もしくはディレクトリパスを指定します。ファイルパスではワイルドカードの*が利用可能で、パターンにマッチするファイルが全て対象となります。またディレクトリパスを指定した場合は該当のディレクトリ以下のファイルすべてが対象となりますので、いずれの利用も注意しておこなってください。

早速この設定でlogrotateを実行してみましょう。このとき-dオプションを付けることで実際にlogrotateは行われずに、どのように動作するのかをデバッグすることができます。-dオプションを省略すると設定次第ではログが破壊的変更を受けますのでいろいろ試すときはバックアップをとっておくと良いと思います。

記述した設定ファイルをもとに実行しようとしているのが分かります。接尾語は「-20161203」だと書いてありますが、dateextの設定（後述）をしていません。そのため古いログは.1という接尾語が採用され、元のファイル名は/tmp/log/httpd/access_log.1になったと言われています。さらにrotateオプションも使っていないため古いログ(access_log.1)が消されようとしています。しかし、そこでそんなファイルないよ、とerrorになったところでコマンドが終了しました。

では対象のログファイルがなかった場合はどのような結果になるのでしょうか？

対象のログファイルがないというエラーでコマンドが終了しました。

ということで何も指定せずに実行した場合、このようなことが分かります。

ファイルがない場合にエラーを吐いて終了するのはいいこととは思えません。ですのでmissingokオプションをつけて実行してみましょう。

エラーではなくskippingに結果が変わりました。echo $?で終了ステータスも0（正常終了）に変わったことが確認できます。

次に古いログがすぐに消されるのは困りますので1世代だけ残してもらうようにしましょう。

先ほどから接尾語が.2に変わりました。世代管理をするようになり、さらに古いファイルから削除しようとしているようです。しかし削除するときにエラーになってしまうのもなんなので試しに該当のファイルを置いて実行してみます。

エラーが出なくなりました。では次に行きましょう。

先述のdateextの設定をしてみます。

rename時のファイル名が-YYYYMMDDに変わりました。でもファイル名にハイフンを使うのは好きじゃないんだよね、_で区切りたいんだよね、というケースもあるかと思います。その場合はdateformatが利用可能です。

dateformatには%Y%m%dか%sが利用可能です。%sですとUnixtimeになりますがシステムクロックが2001年9月9日以降に設定されている必要があります。（ってmanで出てきました）また、並び順にはDDMMYYYY形式などを指定することもできますファイル名などのソートが使えなくなる可能性があることに気をつけて使ってください（ってmanで出てきました）

次に古いファイルはそんなに見ることはないでしょうから圧縮してファイルサイズを節約してみましょう。圧縮したい場合はcompressです。本当に圧縮できるのかを確認したいので-dオプションを消してやってみます。

コケました。何か一時ファイルを作ろうとするも許可がないとのことです。（これは推測混じりですが）logrotateするときにステータスをファイルで管理しています。デフォルトでは/var/lib/logrotate.stateです。こちらがroot権限であるために一般ユーザで実行すると権限で怒られてしまうのではないかと。

stateファイルも引数で指定することが可能ですので指定して実行してみましょう。

stateファイルができました。最後のrotateの日付が2016-12-3になってますね。また思惑通り、ファイルの圧縮がされ1世代前のファイルがgzip圧縮されています。

おや？上の実行後にaccess_logが存在していません。これでは次のrotateに引っかかりません。（通常はapache側で再作成してくれると思いますが）新しいログファイルを作成してほしい場合はcreateの設定を使います。createではファイルパーミッションや所有者・所有グループを指定できます。とっておいたバックアップを元に再度実行し直してみます。

gzファイルができた上にaccess_logファイルを新規に作成し直しています。

しかしログファイルはものによってはファイルハンドラを掴みっぱなしにしていてrenameができないことも考えられます。その場合はcreateではなくcopytruncateの設定の方を使います。こちらはファイルをrenameではなくcopyして、元のファイルの「内容」を消すというものです。コピー→削除の間に若干のタイムラグがあるので頻繁に書き込みが行われている場合にはデータの欠損が発生しうることがあります。（ってmanで出てきました）またcreateとcopytruncateの両方を記述しているとcopytruncateのほうが優先されます。

先程のrenamingからcopyingに挙動が変わりました。createかcopytruncateかは利用場面に応じて使い分けてください。

次はローテーションの間隔です。daily, weekly, monthlyのいずれかが指定可能です。 version3.8.5からhourlyが追加されていました。また、yearlyも存在していました。なぜこのような間隔になるのかというとcron.dailyに登録されているからです。

またweeklyの場合はいつrotateされるのかというと日曜日です。cronでは曜日の指定を数字でおこないますが0が日曜日で6が土曜日です。logrotateでは、この数字が前回より小さくなったときに週が変わったと認識するため日曜日にrotateされます。またmonthlyの場合は毎月1日となります。ログの増加量と相談して選ぶとよいかと思います。

しかし、日付間隔だけでrotateするというのも適切ではありません。全然ファイルサイズが増えないのであればmonthlyより広い間隔でもいいかもしれませんし、すごい勢いで増えるのであればもっと早いタイミングでrotateしたいでしょう。

その場合はsize, もしくはmaxsize, minsizeなどを使いましょう。

sizeなどにはバイト数を指定できます。さらに単位としてk(キロバイト)、M（メガバイト）、G(ギガバイト）も利用可能です。なぜかkだけ小文字です。

sizeの場合は、時間指定と排他的な設定で、指定した数値を超えた場合にrotateされるようになり、dailyなどの時間指定は無視されます。一方[max|min]sizeは時間指定と排他ではなくともに生きる設定です。

ここから記述内容に誤りがありました。正確な情報はコメント欄を参照ください

ですので2MBちょっとのaccess_logに対してrotateするまでもない、という場合に以下のようにmaxsizeを3Mと設定してみます。

するとrotateの必要はない、といった感じでrotateされていません。maxsizeを2Mにしてみるとrotateされます。

ここまで記述内容に誤りがありました。

1つずつ設定を解説していきました。本当はもっといろいろあります。圧縮をgzip以外にするとかメールで送信するとかdelaycompressとか…。時間の関係上、基本的なところしか書いていませんがご査収ください。（暇があれば追記していきたいですね）

次は4日目のkaiharaさんのService Worker Offline Cache Techniquesです。よろしくどうぞ！