Skip to content
Takashi Hayasaka edited this page May 17, 2013 · 5 revisions

Papertrailは、アプリケーションとプラットフォーム上のログに対し、リアルタイムでの追跡機能、検索機能、アラートを上げる機能を含む、ログの集積と管理をホストする機能を提供するアドオンです。

ログ管理のアドオンをアプリケーションへ追加することで、リアルタイムにアプリケーションの状況を把握することが可能となり、トラブル発生時の対応もより迅速となります。また、Herokuに対し最適化された簡潔なアラート機能を提供し、ログのアーカイブも容易にしてくれます。Papertrailは、Webブラウザ、クライアントからのコマンドライン、HTTP APIを経由してアクセスすることが可能です。

ログはHerokuがサポートしているプログラミング言語、または、buildpackから生成され、自動的にPapertrailへルートされます。コードの変更は一切不要です。

アドオンの設定

PapertrailはCLIを経由してHeroku上のアプリケーションへアタッチされます。:

利用可能なプランの確認はこちらで行えます。
:::term
$ heroku addons:add papertrail
-----> Adding papertrail to sharp-mountain-4005... done, v18 (free)

Papertrailをアタッチ後の設定は全て自動化されています。アプリケーションの変更は必要ありません。

アプリケーションとHerokuのアウトプットが、10秒以内にPapertrail上へ記録され始めるでしょう。それ以降はリアルタイムで記録されて行きます。アクティベーションは概して迅速ですが、5分程度を要します。

ログへのアクセス方法

ログへのアクセス、または開封には、4通りの方法があります。:

ダッシュボード

Papertrailのダッシュボードに関する詳細な情報は、help.papertrailapp.comを参照して下さい。

Papertrailのダッシュボードは、ログの追跡と検索を可能とし、さらに検索結果とアラートの保存方法をどうするかと言ったPapertrail自体の設定も許可します。

ダッシュボードのアクセスには、Herokuアプリケーション用のWebインターフェースを訪問して下さい。該当するアプリケーションを選び出し、アドオンのリストからPapertrailを選択します。

ダッシュボードへは、CLIを経由してアクセスすることも可能です。:

:::term
$ heroku addons:open papertrail
Opening papertrail for sharp-mountain-4005…

追跡と検索用のherokuプラグイン

Papertrailは、herokuコマンドラインからログの追跡と検索を可能とするオプションのプラグインを提供しています。これらを使用するには、ローカルの端末にPapertrailのHeroku用プラグインをインストールして下さい。

これらはオプションで、個人毎の端末で実行されます。Heroku上のアプリケーションの一部となるわけではありません。

:::term
$ heroku plugins:install https://github.com/papertrail/papertrail-heroku-plugin

プラグインが、heroku pt:logsコマンドを追加します。利用方法に関しては、プラグインのREADMEを参照して下さい。

URLのブックマーク登録

Papertrail上に記録されたアプリケーションのイベントを直に参照するには、URL形式を使用して下さい。:

https://api.heroku.com/myapps/<アプリケーション名>/addons/papertrail:<Papertrailのプラン名>

このURLは、heroku.comへのシングルサインオンを使います。heroku.com内を行ったり来たりする必要はありません。例えば、sharp-mountain-4005という名称のアプリケーションがあったとして、papertrail:chokladのプランを利用している場合、以下のURLをブックマーク登録して下さい。:

https://api.heroku.com/myapps/sharp-mountain-4005/addons/papertrail:choklad

コマンドラインによるショートカット

コマンドラインからPapertrailのWebインターフェースを起動するには、heroku addons:open papertrailを実行して下さい。以下のようになります。:

:::term
$ heroku addons:open --app sharp-mountain-4005 papertrail

デフォルトに設定しているブラウザが、Papertrailをロードするでしょう。この動作を行うpt bashのエイリアスを追加するには、下記を実行して下さい。:

:::term
$ echo "alias pt='heroku addons:open --app sharp-mountain-4005 papertrail'" >> ~/.bashrc

アカウントのステータス

アカウントのステータスを参照するには、ダッシュボード経由でPapertrailへアクセスし、アカウントのメニューをクリックして下さい。

各種プランのマイグレート

アプリケーションの管理者は、マイグレーションを行っている期間中のアプリケーションの機能を保証するために、マイグレーションのタイミングを慎重に検討するべきです。

heroku addons:upgradeコマンドを使い、新規プランへマイグレートして下さい。必要に応じて新規プランのオプションを申し込む場合以外、プランのアップグレード、及びダウングレードが既存のログへ影響を与えることはありません。

:::term
$ heroku addons:upgrade papertrail:newplan
-----> Upgrading papertrail:newplan to sharp-mountain-4005... done, v18 ($29/mo)
       Your plan has been updated to: papertrail:newplan

アドオンのリムーブ

Papertrailは、CLI経由でリムーブすることが可能です。

この行為は、関連する全てのデータを破棄し、元に戻すことが出来ませんので注意して下さい!
:::term
$ heroku addons:remove papertrail
-----> Removing papertrail from sharp-mountain-4005... done, v20 (free)

Papertrailをリムーブする前に、アーカイブページからログがダウンロードされ、データのエクスポートが実行されます。

サポート

Papertrailへのサポートとランタイムの問題は全て、Heroku Support channelsを経由して提示して下さい。サポート対象外の問題やプロダクトへのフィードバックに関しても、歓迎しています。サポートのチャットへ参加して下さい。[email protected]へのemailも歓迎します。または、help.papertrailapp.comを訪問して下さい。

Clone this wiki locally