【Rails】Railsアプリで「logmon」を使ってログ監視を行う

2021年3月7日 17:59

はじめに

エラーが起こってからログファイルを確認していたのではどうしても初動対応が遅れてしまいます。定期的に手動でログファイルを確認するにしてもすぐにエラーに気付けるとは限りませんし、何より毎回手動で確認するのは大変です。

定期的に自動でログファイルを監視し、エラーが起こったときにメールで通知する「ログ監視ツール」を導入すれば、すぐにエラーに気付くことができますし、手動で確認する必要がないので楽です。

本記事では、Linuxのlogmonを使ってRailsアプリのログ監視を行う方法について説明します。

ログ監視ツール

Linuxのログ監視ツールには多くの種類があります。

数あるログ監視ツールの中でもZabbixは多機能で使いやすい上に完全無料で使えるため人気があります。国内ユーザーも多いため、何かあったときに情報が得やすいという利点もあります。しかし、Zabbixはオンプレミス(専用サーバー上に構築)のため構築するのにスキルと時間が必要というハードルがあります。

今回は小規模なプロダクトのログ監視を行いたいため、できるだけシンプルで簡単に導入できるlogmonを使いたいと思います。

logmonについて

元はIBMが作成したリアルタイムにログを監視するツールです。特定のログファイルをリアルタイムに監視して、指定したパターンにマッチしたら、電子メールで送信したりスクリプト実行などができます。

logmonはパッケージとして提供されていないので、GitHubから直接ダウンロードして使います。

logmonを使ってログ監視を行う

logmonのインストール

GitHubからlogmonをダウンロードし、インストールを行います。

$ git clone https://github.com/moomindani/logmon.git
$ cd logmon
$ sudo ./setup.sh

logmonの設定

設定は/etc/logmon/logmon.confに記述していきます。基本的な書式は以下の通りです。監視文字列は|で区切って複数記述できます。この書式を複数記述することで、複数のログファイルを監視することができます。

:ファイル名
(監視文字列)
コマンド

RailsアプリのログファイルにerrorERRORのいずれかの文字列が出力されたらメールで通知するには以下のように記述します。

:/var/www/example/current/log/production.log
(error|ERROR)
echo -e "<%%%%>" | mail -s "Message Alert" admin@example.com

以下のコマンドを実行して、logmonを起動します。

# service logmon start

以下のコマンドを実行して、logmonの状態を確認します。

# service logmon status

ログ監視の設定はこれで完了ですが、現段階ではエラー内容をメールで通知することはできません。メールを送信するにはメールサーバーの設定をする必要があります。

postfixのインストール

Linuxのメール転送エージェント (Mail Transfer Agent、MTA) はpostfixがよく使われています。今回はエラー内容のメール通知ができれば良いため、postfixを使いたいと思います。

postfixをインストールするには、以下のコマンドを実行します。

# yum -y install postfix

postfixの設定

postfixの設定ファイルは/etc/postfix/main.cfです。このファイルを変更していきます。

# vi /etc/postfix/main.cf

myhostnameパラメーターを検索し、以下の通りメールサーバーのホスト名をFQDN(ホスト名+ドメイン名)で設定します。ホスト名はmail、ドメイン名はご自分で取得したドメイン名を指定します。

#myhostname = host.domain.tld
#myhostname = virtual.domain.tld
# 以下を追記
myhostname = mail.example.com

mydomainパラメーターを検索し、以下の通りドメイン名を設定します。

#mydomain = domain.tld
# 以下を追記
mydomain = example.com

masquerade_domainsパラメーターを以下の通り設定します。このパラメーターは、送信元メールアドレス(admin@mail.example.com)のサブドメイン名(mail)を除外するオプション設定です。オプションのため初期設定では項目がありません。そのため、設定ファイルの最下行に設定を追記します。

# 以下を追記
masquerade_domains = example.com

これでpostfixの設定は完了です。以下のコマンドを実行して、設定ファイルの確認を行います。何も表示されなければ問題ありません。

# postfix check

postfixを再起動して設定を反映します。

# systemctl restart postfix

以下のコマンドを実行して、正常に起動できているか確認します。

# systemctl status postfix

以下のコマンドを実行して、自動起動設定を行います。

# systemctl enable postfix

以下のコマンドを実行して、自動起動設定が有効になっているか確認します。

# systemctl is-enabled postfix

迷惑メールへの対応

postfixから送信されたメールは、SPF (Sender Policy Framework:送信元認証用の設定) やDKIM (Domainkeys Identified Mail:メール用電子署名) の設定をしていないため、受信側に迷惑メールとして届く場合があります。この対応として、比較的簡単にできるSPFの設定を行います。

SPFはDNSに対して行います。今回はDNSサーバーとしてConoHaを使用しているので、それ以外のDNSサーバーの場合は適宜読み替えてください。

ConoHaにログインします。

左のメニューから「DNS」をクリックします。

ドメイン名をクリックして設定を開きます。

ペンアイコンをクリックして編集モードにします。

「+」をクリックして新規レコードを追加します。以下のレコードを追加し「保存」ボタンをクリックします。

項目 設定値
タイプ TXT
名称 @
TTL 3600
v=spf1 +ip4:(サーバーのIPアドレス) -all

なお、SPFレコードを複数登録することはできません。既に別のSPFレコードを登録している場合、既存レコードに+ip4:(サーバーのIPアドレス)を追加してください。

以下のサイトで登録したSPFレコードの正当性を確認することができます。

ドメイン名を入力します。

以下のようにPassと表示されていれば問題ありません。

認証結果 意味
None SPFレコードが公開されていない
Neutral SPFレコードが“?”として公開されている条件にマッチした
Pass 認証処理に成功した
Fail SPFレコードが公開されているが、認証に失敗した
SoftFail SPFレコードが“~”として公開されている条件にマッチした
TempError 一時的な障害で認証処理が失敗した
PermError SPFレコードの記述に誤りがあるなどで認証処理に失敗した

これでSPFの設定は完了です。

Gmailに送信できない場合

宛先をGmailにしているとメールが送信できないという場合があるようです。Gmailにメールが送信できない場合、以下を試してみてください。

アプリパスワードの生成

Googleアカウントにログインします。

左のメニューから「セキュリティ」をクリックします。

ページ中程の「Googleへのログイン」セクションで「アプリパスワード」をクリックします。

パスワードを入力して「次へ」ボタンをクリックします。

アプリパスワード画面で、「アプリを選択」をクリックし「その他(名前を入力)」をクリックします。

適当な名前を入力し「生成」ボタンをクリックします。

生成されたアプリパスワードをコピーしておきます。

postfixの設定

SASL認証のためのコンポーネントをインストールします。

# yum install cyrus-sasl-plain

/etc/postfix/main.cfの最下部に以下の設定を追記します。

relayhost = [smtp.gmail.com]:587
smtp_sasl_auth_enable = yes
smtp_sasl_password_maps = hash:/etc/postfix/sasl_passwd
smtp_sasl_security_options = noanonymous
smtp_sasl_tls_security_options = noanonymous
smtp_sasl_mechanism_filter = plain
smtp_use_tls = yes

sasl_passwdファイルを作成し、以下を記述します。

[smtp.gmail.com]:587 (Gmailアドレス):(アプリパスワード)

以下のコマンドを実行して、パスワードファイルをハッシュ化します。

# postmap /etc/postfix/sasl_passwd
# chmod 600 /etc/postfix/sasl_passwd

postfixを再起動して設定を反映します。

# systemctl restart postfix

これでGmailに送信できるようになったはずです。

まとめ

Railsアプリのログ監視を行うことで、エラーが起こったときに即座に気付くことができ、素早い対応が可能となります。ログ監視を行うには専用サーバーを構築する方法もありますが、インストールして簡単な設定を行うだけのシンプルなツールもあります。小規模なプロダクトであれば、まずはこういった簡単なツールを導入してみることをおすすめします。

本記事を参考にして、Railsアプリのログ監視を行っていただければと思います。

関連記事

【Rails】Railsアップグレードまとめ
# はじめに Ruby on Railsに限らず、何らかのフレームワークを使ってWebシステムを構築している場合、フレームワークのアップグレード作業は避けて通れません。 一般的にフレームワークはバージョン毎にEOL (End of Life [...]
2022年10月1日 14:32
【Rails】ユーザー登録時に行うメールアドレス認証機能の実装方法
# はじめに ユーザー登録/解除やログイン/ログアウトといった認証機能の導入に「devise」というGemを使っている人は多いと思います。「devise」では以下のように記述するだけで、ユーザー登録時に確認メールを送付しメールアドレス認証を行う機 [...]
2022年9月24日 14:24
【Rails】モデルに列挙型(enum)を定義し、使いこなす方法
# はじめに Railsはモデルでカラム名と同名の列挙型(enum)を定義することで、カラムと列挙型の変数を紐付けることができます。カラムと列挙型の変数を紐付けると、カラムに対して様々な便利な使い方ができるようになります。 本記事では、モデ [...]
2022年9月3日 10:29
【Rails】RailsでCORSとPreflight requestの設定を行う方法
# はじめに RailsアプリをAPIサーバーとして構築するには、CORS (Cross-Origin Resource Sharing)と Preflight requestの設定を行う必要があります。APIサーバーは外部からの要求に対して処理 [...]
2022年8月27日 10:44
【Ruby】Bundlerを使ってRubyGemsを作成/公開する方法
# はじめに Bundlerを使ってRubyGemsを作成および公開する方法について説明します。Bundlerを使わずにRubyGemsを作成/公開する方法については以下の記事を参照してください。 <iframe class="hatena [...]
2022年7月12日 23:18
【Ruby】RubyGemsを作成/公開する方法
# はじめに RubyGemsを作成および公開する方法について説明します。Bundlerを使ってRubyGemsを作成する方法については以下の記事を参照してください。 <iframe class="hatenablogcard" style [...]
2022年7月11日 21:52
【Rails】M1チップ搭載MacでRuby on Railsの開発環境構築
# はじめに M1チップ搭載MacにRuby on Railsの開発環境を構築する手順を記載します。 - MacBook Air (M1, 2020) - macOS Monterey 12.3.1 # Homebrew ## [...]
2022年5月5日 11:56
【Rails】Rakeタスクの基本情報と作成・実行方法
# はじめに Railsには標準でRakeというGemが同梱されています。RakeはRubyで実装されたMake(UNIX系のOSで使用できるコマンド)のようなビルド作業を自動化するツールです。Ruby Make、略してRakeというわけですね。 [...]
2022年3月7日 22:12