出力形式
pgBadgerは、ファイル名の拡張子または-x / --extensionから出力形式を選びます。-o / --outfileを複数回指定すると、1回の解析から複数形式を生成できます。
| 形式 | 一般的な拡張子 | 主な用途 |
|---|---|---|
| HTML | .html | グラフ付きで、人が読みやすく操作可能なレポート |
| テキスト | .txt | ターミナルでの確認とプレーンテキストによる保存 |
| バイナリ | .bin | 統合可能な中間統計とレポートの再生成 |
| JSON | .json | 他のソフトウェアとの連携。JSON::XSが必要 |
| 生のCSV | 選択した出力ファイル | --dump-raw-csvによる行単位の抽出 |
HTMLとテキスト
デフォルトの出力先はout.htmlです。
通常、HTMLには単独での閲覧に必要なスクリプト、スタイル、フォント、レポートデータが埋め込まれます。-X / --extra-filesを指定すると、共通のJavaScriptとCSSを増分レポートの外に配置します。これらのアセットはHTMLのディレクトリツリーとともに保持してください。
テキスト出力を明示的に生成します。
出力ファイル名に-を指定すると、対応する形式を標準出力に書き出せます。
バイナリの中間データ
バイナリ出力では、解析と表示を分離します。追記され続ける1日分のログから、1時間ごとの差分を生成できます。
1つ以上のバイナリファイルを統合して、新しいレポートを生成します。
サーバーが1時間ごとにログファイルを作成する場合は、ローテーションごとにバイナリファイルを作成し、必要に応じて累積HTMLを再生成します。
互換性のあるpgBadgerバージョンのバイナリファイルをまとめて保持してください。長期間使用しているレポートディレクトリをアップグレードする前に、リリースノートで増分形式の互換性を確認してください。
JSON
JSON出力は、監視やレポート処理パイプラインなどのプログラムによる利用を想定しています。
まずJSON::XSをインストールしてください。ファイルサイズや生成時間より読みやすさを優先する場合は、--prettify-jsonを追加します。
生データとクエリーのエクスポート
コマンドリファレンスでは、専用のエクスポート機能も提供されています。
--dump-raw-csvはログを解析し、レポートを生成せずに行単位のCSVを書き出します。--csv-separatorは生のCSVの区切り文字を変更します。--dump-all-queriesはバインドパラメーターを置換した後のすべてのクエリーを出力します。--normalized-onlyは正規化したクエリーを書き出します。--query-numberingはクエリーのテキスト出力に番号を付けます。
これらのモードの出力には、アプリケーションのSQL、識別子、ユーザー、クライアントアドレス、リテラル値が含まれる場合があります。共有前に出力を確認し、目的の分析にリテラルが不要であれば--anonymizeを使用してください。