読者です 読者をやめる 読者になる 読者になる

ひらおかゆみのなげやりブログ

もう、なげやりです…

Payara ServerのLog Viewerについて

このエントリは、Payara Advent Calendar 2016の24日目です。昨日は@n_agetsuさんの「PayaraのJMX Monitoring Service」でした。明日は@khasunumaです。

1. はじめに

このアドベントカレンダーをご覧の方はご存じのはずですが、Payara ServerにはWebインタフェースのAdmin Consoleが付いています。Payara Serverの操作を一通り行える優れものですが、その中にはLog Viewerという興味深い機能があります。文字通り、ログを見るための機能です。

2. Log Viewerの使い方

操作は簡単で、まず左側の「server (Admin Server)」をクリックして「General Information」を表示します。

f:id:yumix_h:20161211233037p:plain

サーバのステータスの上にいくつかボタンがありますが、その中の「View Log Files」をクリックします。これでLog Viewerが開きます。

f:id:yumix_h:20161211233500p:plain

Log Level、Recordの先頭と最後、タイムスタンプなどでの絞り込みができます。詳細は一覧のMessageのところにある「(details)」というリンクをクリックすると見ることができます。ここではRecord Number 51(つまり一番上)の詳細を表示してみます。

f:id:yumix_h:20161211233741p:plain

Log Viewerには「Advanced Search」という機能があり、さらに細かな条件でログを検索することができます。以下のスクリーンショットから、どれだけ細かく検索オプションを指定できるのかがわかります。

f:id:yumix_h:20161211234007p:plain

Log Viewerの関連機能として、ログをそのまま表示するRaw Log Viewer、ログの強制ローテートなどがあります。「Domain」の「Domain Logs」タブで「Collect Logs」ボタンをクリックするとログをダウンロードすることも可能です。

3. まとめ

Windowsにはgrepsedawkも入っていないので、ログの検索が可能なLog Viewerは心強い味方となることでしょう。また、サーバマシンにsshで直接ログインできない環境であっても、Admin Consoleさえ使えれば、Log Viewerでログの解析もできますし、ログを差し押さえたければダウンロードすればOKです。

もし、皆さんのPayara ServerがAdmin Consoleにログインできるのであれば、ログに関する操作はすべてAdmin Consoleだけで行えます。Windows環境でPayara Serverを使用している方、リモート接続が制限されている環境でPayara Serverを使用せざるを得ない方にとっては、Log Viewerは非常に強力なツールだと思います。ぜひ、お試しください。

4. 制限事項

server-config → Logger Segins  Log File Logging Format でログ・ファイルの出力形式 (デフォルトでは ODL) を JSON に変更すると、JSON ログLog Viewerでは表示できません。

f:id:yumix_h:20161212001752p:plain

参考まで、ログ出力形式をJSONに設定すると、JSONで出力されたログはLog Viewerでは表示できません。

f:id:yumix_h:20161212001810p:plain

仕様なのか、バグなのかは私では判断なかったので、とりあえずバグかも?ということで事象を報告しました。 

github.com

@khasunumaが何の前触れもなく付けてきたコメントをまとめると、

  • ソースコードから判断する限り、バグではなく制限事項と考えられるため、これは改善要望とすべき
  • PayaraのログにはULF形式とODF形式以外に「カスタム・フォーマッタ」が使用でき、JSON形式は現時点ではカスタム・フォーマッタ扱い
  • Log Viewerはカスタム・フォーマッタには対応しておらず、そのためJSON形式のログは表示することができない
  • 現状、Admin ConsoleでJSON形式のログを表示するなら、Log ViewerではなくRaw Log Viewerの方を使った方がいい

だそうです(分かるような、分からないような…)。さらにPayaraのMike Croft (@croft) さんからは、この件は改善要望として取り上げるとのコメントをいただきました。