開発者ドキュメント

Ubuntu20.04でLogrotateを使用してログファイルを管理する方法

getdocs

序章

Logrotateは、ログファイルの自動ローテーションと圧縮を管理するシステムユーティリティです。 ログファイルがローテーション、圧縮、および定期的に整理されていない場合、最終的にはシステムで使用可能なすべてのディスク領域を消費する可能性があります。

LogrotateはデフォルトでUbuntu20.04にインストールされ、インストールされているすべてのパッケージのログローテーションのニーズを処理するように設定されています。 rsyslog、デフォルトのシステムログプロセッサ。

この記事では、デフォルトのLogrotate構成について説明し、架空のカスタムアプリケーションのログローテーションを構成します。

前提条件

このチュートリアルでは、 Ubuntu 20.04 での初期サーバー設定で説明されているように、root以外のsudo対応ユーザーがいるUbuntu20.04サーバーがあることを前提としています。

Logrotateは他の多くのLinuxディストリビューションでも利用できますが、デフォルトの構成はまったく異なる場合があります。 LogrotateのバージョンがUbuntu20.04に類似している限り、このチュートリアルの他のセクションは引き続き適用されます。 手順1に従って、Logrotateのバージョンを確認します。

sudo対応ユーザーとしてサーバーにログインして開始します。

ステップ1—Logrotateバージョンの確認

LogrotateはデフォルトでUbuntuにインストールされます。 ただし、インストールする必要がある場合は、次のコマンドを実行してパッケージリストを更新し、パッケージを取得します。

  1. sudo apt update

  2. sudo apt install logrotate

Ubuntu以外のサーバーを使用している場合は、最初にバージョン情報を要求してLogrotateがインストールされていることを確認してください。

  1. logrotate --version



Output
logrotate 3.14.0

    Default mail command:       /usr/bin/mail
    Default compress command:   /bin/gzip
    Default uncompress command: /bin/gunzip
    Default compress extension: .gz
    Default state file path:    /var/lib/logrotate/status
    ACL support:                yes
    SELinux support:            yes

Logrotateがインストールされているが、バージョン番号が大幅に異なる場合は、このチュートリアルで説明されている構成オプションの一部に問題がある可能性があります。 Logrotateの特定のバージョンについては、そのマニュアルを読んでドキュメントを参照してください（man）ページ：

  1. man logrotate

Logrotateドキュメントのオンラインバージョンを参照することもできます。 次に、UbuntuでのLogrotateのデフォルトの構成構造を見ていきます。

ステップ2—Logrotate構成の調査

Logrotateの構成情報は、通常、Ubuntuの2つの場所にあります。

デフォルトでは、 logrotate.conf rootユーザーとsyslogグループが所有するログファイルを使用して、毎週のログローテーションを構成します。一度に4つのログファイルが保持されます（rotate 4）、および現在のログファイルがローテーションされた後に作成される新しい空のログファイル（create).

パッケージのLogrotate構成ファイルを見てみましょう。 /etc/logrotate.d. cat のファイル apt パッケージユーティリティ：

  1. cat /etc/logrotate.d/apt



Output
/var/log/apt/term.log {
  rotate 12
  monthly
  compress
  missingok
  notifempty
}

/var/log/apt/history.log {
  rotate 12
  monthly
  compress
  missingok
  notifempty
}

このファイルには、2つの異なるログファイルの構成ブロックが含まれています。 /var/log/apt/ ディレクトリ： term.log と history.log. どちらも同じオプションがあります。 これらの構成ブロックで設定されていないオプションは、デフォルト値またはで設定されているオプションを継承します /etc/logrotate.conf. logrotateファイルの設定は、logrotateのデフォルト値を上書きします。 /etc/logrotate.conf. に設定されたオプション apt ログは次のとおりです。

これらの構成ファイルもデフォルトを継承します create 動作。ローテーション後に新しいログを作成するようにLogrotateに指示します。 これはでオーバーライドできます nocreate、ただし、他のほとんどの機能は事実上無効になります。

利用可能な構成オプションは他にもたくさんあります。 あなたはタイプすることによってそれらのすべてについて読むことができます man logrotate コマンドラインでLogrotateのマニュアルページを表示します。

次に、架空のサービスのログを処理するための構成ファイルを設定します。 your-app.

ステップ3—設定例の設定

事前にパッケージ化および事前構成されたシステムサービス以外のアプリケーションでlogrotateを使用してログファイルを管理するには、次の2つのオプションがあります。

  1. 新しいLogrotate構成ファイルを作成し、 /etc/logrotate.d/. これは、他のすべての標準Logrotateジョブとともに、rootユーザーとして毎日実行されます。
  2. 新しい構成ファイルを作成し、UbuntuのデフォルトのLogrotateセットアップの外で実行します。 これは、Logrotateを root 以外のユーザーとして実行する必要がある場合、またはログを毎日より頻繁にローテーションする場合にのみ本当に必要です（ hourly の構成 /etc/logrotate.d/ システムのLogrotateセットアップは1日1回しか実行されないため、効果がありません）。

いくつかのセットアップ例を使用して、これら2つのオプションを見ていきましょう。

に構成を追加する /etc/logrotate.d/

を置く架空のWebサーバーのログローテーションを構成したい access.log と error.log の中へ /var/log/your-app/. それはとして実行されます www-data ユーザーとグループ。

の構成を追加するには your-app ログファイルを /etc/logrotate.d/、最初に新しいファイルを開きます /etc/logrotate.d ディレクトリを使用して nano またはお好みの編集者：

  1. sudo nano /etc/logrotate.d/your-app

新しい構成ファイルに次の行を追加します。

/etc/logrotate.d/your-app
/var/log/your-app/*.log {
	daily
	missingok
	rotate 14
	compress
	notifempty
	create 0640 www-data www-data
	sharedscripts
	postrotate
		systemctl reload your-app
	endscript
}

このファイルの新しい構成ディレクティブの一部は次のとおりです。

保存して終了するには nano、 押す Ctrl+X、およびプロンプトが表示されたら、 Y その後 Enter. ドライランを実行して、構成ファイルをテストできます。

  1. sudo logrotate /etc/logrotate.conf --debug

このコマンドは logrotate、それを標準構成ファイルにポイントし、デバッグモードをオンにします。

Logrotateが処理しているログファイルと、それらに対して何が行われたかについての情報が出力されます。 すべてがうまくいけば、完了です。 標準のLogrotateジョブは1日1回実行され、新しい構成が含まれます。

次に、Ubuntuのデフォルト構成をまったく使用しないセットアップを試してみます。

ステップ4—独立したLogrotate構成を作成する

この例では、ユーザーとしてアプリを実行しています sammy、に保存されるログを生成します /home/sammy/logs/. これらのログを1時間ごとにローテーションしたいので、これを外部に設定する必要があります。 /etc/logrotate.d Ubuntuが提供する構造。

まず、ホームディレクトリに構成ファイルを作成します。 テキストエディタで開きます。

  1. nano /home/sammy/logrotate.conf

次に、次の構成で貼り付けます。

/home/sammy/logrotate.conf
/home/sammy/logs/*.log {
	hourly
	missingok
	rotate 24
	compress
	create
}

ファイルを保存して閉じます。 前の手順でこれらすべてのオプションに遭遇しましたが、要約しましょう。この構成では、ファイルが1時間ごとにローテーションされ、24個の古いログが圧縮および保持され、ローテーションされたログを置き換える新しいログファイルが作成されます。

アプリケーションに合わせて構成をカスタマイズする必要がありますが、これは良いスタートです。

構成が機能することをテストするために、ログファイルを作成しましょう。 初め cd を使用してユーザーのホームディレクトリに移動します cd ~ 指図。 次に、を使用してログのディレクトリを作成します mkdir 指図。 最後に、に空のファイルを作成します logs を使用するディレクトリ touch 指図。 これらの手順を完了するには、次のコマンドを実行します。

  1. cd ~

  2. mkdir logs

  3. touch logs/access.log

正しい場所に空のログファイルがあるので、実行してみましょう logrotate 指図。

ログはによって所有されているため sammy 使用する必要はありません sudo. ただし、doはstateファイルを指定する必要があります。 このファイルは何を記録します logrotate 検出され、最後に実行されたときに実行されたアクション。これにより、次に実行されたときに何をすべきかがわかります。 この状態追跡は、デフォルトを使用するときに処理されます /etc/logrotate.conf 構成。 状態ファイルはに保存されます /var/lib/logrotate/status. デフォルト構成を使用していないため、状態ファイルの場所を手動で構成する必要があります。

この例では、Logrotateに状態ファイルをホームディレクトリに配置させます。 アクセス可能で便利な場所ならどこにでも行くことができます。 次のコマンドを実行して、 /home/sammy/logrotate.conf 作成したものと、logrotateが遭遇する状態を記録するために：

logrotate /home/sammy/logrotate.conf --state /home/sammy/logrotate-state --verbose

Output
reading config file /home/sammy/logrotate.conf

Handling 1 logs

rotating pattern: /home/sammy/logs/*.log  hourly (24 rotations)
empty log files are rotated, old logs are removed
considering log /home/sammy/logs/access.log
  log does not need rotating

The --verbose flagは、Logrotateが実行していることに関する詳細情報を出力します。 この場合、何も回転しませんでした。 Logrotateがこのログファイルに遭遇するのはこれが初めてであり、0時間経過しているため、ローテーションしないでください。

を使用して状態ファイルで調べる場合 cat ユーティリティ、Logrotateが実行に関するいくつかの情報を記録したことに注意してください。

  1. cat /home/sammy/logrotate-state



Output
logrotate state -- version 2
"/home/sammy/logs/access.log" 2021-12-3-19:0:0

Logrotateは、見たログと、最後にローテーションを検討した日時を記録しました。 この同じコマンドを1時間後に実行すると、ログは期待どおりにローテーションされます。

Logrotateでログファイルをローテーションさせたい場合は、ログファイルをローテーションする必要があります。 --force 国旗：

  1. logrotate /home/sammy/logrotate.conf --state /home/sammy/logrotate-state --verbose --force

これはテスト時に役立ちます postrotate およびその他のスクリプト。

最後に、Logrotateを1時間ごとに実行するためのcronジョブを設定する必要があります。 ユーザーのcrontabを開きます。

  1. crontab -e

これにより、テキストファイルが開きます。 cronを初めて使用する場合は、デフォルトのテキストエディタを選択するように求められる場合があります。 好みがない場合は、お勧めします nano 新規ユーザー向け。 cron構文を説明するコメントがファイルにすでに含まれている場合があります。 ファイルの最後にある新しい空白行にカーソルを移動し、以下を追加します。

crontab
14 * * * * /usr/sbin/logrotate /home/sammy/logrotate.conf --state /home/sammy/logrotate-state

このタスクは、毎日、毎時14分に実行されます。 ほぼ同じように動作します logrotate 以前に実行したコマンドですが、拡張しました logrotate そのフルパスに /usr/sbin/logrotate 安全であるために。 cronジョブを作成するときは、フルパスを使用することをお勧めします。 cronの詳細については、他のチュートリアルを確認してください。

ファイルを保存して終了します。 これによりcrontabがインストールされ、タスクは指定されたスケジュールで実行されます。

約1時間後にログディレクトリに再度アクセスすると、ローテーションおよび圧縮されたログファイルが見つかります。 access.log.1.gz （また .2.gz Logrotateを実行した場合 --force 国旗）。

結論

このチュートリアルでは、Logrotateのバージョンを確認し、デフォルトのUbuntu Logrotate構成を調べ、2つの異なるタイプのカスタム構成をセットアップしました。 Logrotateで使用できるコマンドラインと構成オプションの詳細については、次のコマンドを実行してマニュアルページを読むことができます。 man logrotate ターミナルで、またはオンラインドキュメントにアクセスしてください。

モバイルバージョンを終了