GoエージェントAPI使用の手引き

New Relic Go エージェント は、お客様の Go 言語アプリケーションやマイクロサービスを監視し、パフォーマンスの問題を特定して解決するのに役立ちます。Go エージェント API は、いくつか用意されている New Relic API のひとつです。

トランザクションの監視

トランザクションを監視するためにコードを手動でインストルメントする前に、 互換性と要件 を満たしていること、そして 最新バージョンの Go エージェント を使用していることを確認してください。

セグメントを使用した時間固有の方法

トランザクションはすでに New Relic で表示されているが、そのトランザクション中に呼び出された特定のメソッドに関する十分なデータがない場合、 セグメントを作成することができます 。例えば、複雑なロジックを持つメソッドの時間を計測したい場合、トランザクション内の各メソッドにセグメントを作成することができます。

既存のトランザクション内でメソッドを計測するには、次のようなセグメントを作成します。

• コードのブロック
• 関数
• データストア
• 外部サービス

トランザクションが開始された場所とは別のゴルーチンで作業が行われている場合は、 NewGoroutine() API を使用する必要があります。

トランザクションのメタデータを強化する

New Relic がトランザクションに対してレポートするメタデータを管理することができます。ここでは、トランザクションに対して異なるレベルの詳細情報を必要とする場合の例を紹介します。

• メトリックのグループ化の問題が発生している場合 、トランザクションのデフォルトの名前を変更して、より識別しやすくしてください。
• トランザクションのダッシュボードを作成したい場合は、 カスタムアトリビュート を追加してください。

外部サービスへの機器呼び出し

これらのメソッドを使用して、アプリの他のアプリやデータベースへの接続に関するデータを収集します。

エラーを収集または無視する

エージェントは自動的にエラーを検出します。Go エージェントが New Relic にエラーを報告する方法を変更したい場合は、 エラーコレクターの設定 を変更してください。

エラー フィンガープリント: 検出された各エラーにエラー グループを動的に適用します。

コールバック関数をエージェントに提供して、通知された各エラーに目的の エラー グループを 動的に適用できます。Go エージェント構成オプション newrelic.ConfigSetErrorGroupCallbackFunction を使用して、エージェントにコールバックを提供します。

この API 呼び出しは、唯一の引数としてコールバック メソッド (タイプ newrelic.ErrorGroupCallbackである必要があります) を取ります。次に例を示します。

myCallbackFunc := CallbackFunc(errorInfo newrelic.ErrorInfo) string {
   if errorInfo.Message == "example error message" {
       return "example group 1"
   }
   if errorInfo.GetHttpResponseCode() == "403" && errorInfo.GetUserID() == "user 2" {
       return "user 2 payment issue"
   }

   // use default error grouping behavior
   return ""
}

app, err := newrelic.NewApplication(
   newrelic.ConfigSetErrorGroupCallbackFunction(myCallbackFunc)
)

示されている例では、タイプ newrelic.ErrorInfo のオブジェクトを受け取り、エラー グループを表す文字列を返すコールバック プロシージャが作成されます。 ErrorGroupCallback 関数が空でない文字列を返す場合、通知されたエラーのデフォルトのグループ化動作をオーバーライドし、サーバー側のグループ化ロジックを適用することに注意してください。

コールバック関数は、入力引数 newrelic.ErrorInfo オブジェクトを 1 つだけ受け取る必要があります。オブジェクトには以下が含まれます。

ユーザー追跡: ユーザー ID を各トランザクションおよびエラーに関連付ける

New Relic Go エージェントがユーザー ID を認識している場合、トランザクションとエラーをユーザー ID に関連付けることができます。Go エージェント API txn.SetUserID("example user ID") を使用して、エージェントにユーザー ID を提供します。

この API 呼び出しには、エンド ユーザーの一意の識別子を表す文字列の 1 つの引数が必要です。この文字列は、UUID、データベース ID などです。トランザクションを関連付けるユーザー ID を New Relic Go エージェントに通知するために、トランザクションごとに少なくとも 1 回は API 呼び出しを行う必要があります。次に、トランザクションの存続期間中にエージェントがエラーに気付くと、エラーには、ユーザー ID 値を保持する enduser.id エージェント属性が含まれます。

API は、新しいユーザー ID がスコープに入るたびに呼び出されることを意図しているため、理想的には、ユーザー セッションの作成を認識しているミドルウェアを介して呼び出されます。New Relic Go エージェントがユーザー ID を認識すると、現在のトランザクションおよび現在のトランザクションの存続期間中に検出されたエラーに enduser.id エージェント属性を提供します。

アプリからカスタムデータを送信する

カスタムデータ を Go エージェントで記録するには、以下のいずれかの方法を使用します。

• カスタムイベント
• カスタムアトリビュート
• カスタムメトリック

関連ログを見る

アプリケーションのエラーとトレースのコンテキスト内でログを直接表示するには、次のAPI呼び出しを使用してログに注釈を付けます。

• GetTraceMetadata
• GetLinkingMetadata

ログデータと他のテレメトリーデータとの相関関係については、 logs in context のドキュメントをご覧ください。

ブラウザモニタリングでブラウザのパフォーマンスを監視

browserブラウザ監視と Go エージェント を使用してアプリのブラウザ を監視するには、次のいずれかの方法を使用できます。

Goエージェントの設定変更

New Relic モニタリングのいくつかの側面を管理するために、 Go エージェントの設定を変更することができます。; 例えば。

• 高セキュリティモードをオンにする
• フィルタリングやソートのためのカスタムラベルの追加
• 報告される情報の管理