Image may be NSFW.
Clik here to view.
こんにちは、okutani(@okutani_t)です。本記事では、Herokuにログ管理ツール「papertrail」を導入する方法・使い方についてまとめています。
Herokuでの無料版papertrailでは、以下の機能が利用できます。
| 1日のログ転送量 | 10MB |
|---|---|
| ログ保持期間 | 7日間 |
| 検索可能な期間 | 2日間 |
| アラート機能 | 利用可 |
その他のプランの詳しい概要は以下のページを参考にしてください。
LINKPapertrail – Add-ons – Heroku Elements
Herokuのpapertrail公式ドキュメントは以下。
LINKPapertrail | Heroku Dev Center
ちなみに、Railsで利用できるpapertrail gemがありますが、そちらはまったくの別物なので注意してください。
また、今回はRailsプロジェクト上でpapertrailを利用しています。
それでは、Herokuにpapertrailを追加するところから見ていきましょう。
スポンサーリンク
papertrailの追加
papertrailアドオンをターミナルから追加する場合は以下を実行。
$ heroku addons:create papertrail --app アプリ名もしくは、HerokuのWeb管理画面から追加することもできます。
Image may be NSFW.
Clik here to view.
これでpapertrailが利用できるようになりました。
papertrail管理画面を起動
HerokuのWeb管理画面からpapertrailをクリック。
Image may be NSFW.
Clik here to view.
papertrailのサマリーを送るかどうか聞かれるので、お好きな方を選択。
Image may be NSFW.
Clik here to view.
papertrailのログ管理画面に入れました。
Image may be NSFW.
Clik here to view.
それでは、まずは検索機能を利用してみましょう。
検索機能を使ってみる
「Events」画面から、検索枠に「Completed 404 Not Found」と入力して検索してみます。
Image may be NSFW.
Clik here to view.
上のように、404発生時のログだけを表示することができました。
ANDやORを利用することで、特定のログを拾うことができます。
Image may be NSFW.
Clik here to view.
これで「app/web」「INFO」「2017-12-27」が含まれているログを検索することができました。
ちなみに、ログの日時は時計のアイコンからも指定することができます。
Image may be NSFW.
Clik here to view.
検索には日本語も利用できます。
Image may be NSFW.
Clik here to view.
これで便利にログを検索することができますね。
※もし他にも便利な検索方法があればぜひコメントで教えてください
アラートをSlackに飛ばしてみる
特定のログが出力されたらアラートを出す設定をおこなってみます。
今回は一例として、「404エラーが発生したらSlackに通知を出す」という通知を設定。
「Completed 404 Not Found」と検索、「Save Search」をクリック。
Image may be NSFW.
Clik here to view.
「Create a new search」に名前をつけて「Save & Setup an Alert」をクリック。
Image may be NSFW.
Clik here to view.
「Slack」をクリック。
Image may be NSFW.
Clik here to view.
お好きな設定で項目を入力。「Integration’s Webhook URL」には、流したいSlackのweb hook urlを入力。
「Create Alert」をクリック。
Image may be NSFW.
Clik here to view.
※web hook urlの取得方法は以下の記事を参考にしてください
Clik here to view.
これで404エラーがログに流れたらSlackに通知を飛ばしてくれます。
Image may be NSFW.
Clik here to view.
上記の例だと、どのページで404が発生したのか分からないので、別途、エラーログの出力形式を調整する必要があります。
他にもいろいろと便利な使い方があるかと思います。もし、いい使い方があったら教えてください。
まとめ
Herokuにpapertrailを導入する方法から、かんたんな使い方まで解説しました。
papertrailを導入しておくと、いざというときにログがすぐ追えて便利ですね。
ログの見方の知識も必要になります。私はこの機会に、ログの集め方や見るべき情報について改めて勉強しようと思いました。
Herokuユーザーの参考になれば幸いです。