統合ログの推奨事項

New Relic の インフラストラクチャ エージェント は、オンホストの統合 を作成するための SDK を提供しています。このドキュメントでは、統合ログを生成するための要件とベストプラクティスについて説明します。

ロギングの要件 [#required]

どのようなログ・メッセージを作成するか、またどのような情報が問題のデバッグに役立つかは、お客様の判断に委ねられています。唯一の要件は、統合実行ファイルが標準エラー（stderr）にログを書き込むことです。

インフラストラクチャエージェントは、標準エラーに書き込まれた行をキャプチャして、インフラストラクチャエージェント自身が書き込んだ ロギングストリーム にマージします。

サードパーティのログソリューションに依存しないように、Goの統合構築ライブラリでは、一般的なログレベルを備えた シンプルなログパッケージを提供しています。

提言とベスト・プラクティス [#recommended]

ここでは、統合ログを生成するための推奨事項を説明します。

• * デフォルトでは、統合は"静かでなければなりません。" 標準出力に出力されるデータを除けば、ログや診断メッセージはほとんど生成されないはずです。
• インフラストラクチャ エージェントの verbose 設定と同様の詳細ログ モードを含めることをお勧めします。詳細ログを有効または無効にするコマンド ライン スイッチを含めます (例: -verbose)。
• 統合の実行中に統合をデバッグするには、実行するコマンド ラインの一部として定義ファイルに冗長スイッチを含めます。これにより、詳細ログがインフラストラクチャ エージェント自身のログ ファイルに送信されます。
• 一般的なデバッグの目的では、人間が判読できる「きれいに印刷された」形式 (たとえば、 --pretty) で標準出力 JSON データを書き込むフラグを使用します。「きれいに印刷された」形式で書かれた出力はデバッグのみを目的としており、インフラストラクチャ エージェントと互換性がないことに注意してください。
• 統合は、単独で実行できるように作成する必要があります。統合がエージェントと通信しているかどうか疑わしい場合は、コマンドラインから統合を実行して、期待通りの出力やログメッセージが生成されているかどうかを確認できます。

Go言語のロギングパッケージについては、 ロギングパッケージ を参照してください。