RubyのエージェントAPIを利用するためのガイド

New Relic の Ruby エージェントは、パブリック API を提供しており、ドキュメントは GitHub で公開されています。GitHub のドキュメントでは、Ruby アプリのカスタムインスツルメンテーションを設定し、より詳細なデータを収集する方法が紹介されています。

• 概要
• 公開APIメソッド

以下のセクションでは、共通の目標、解決策、ドキュメントの関連部分へのリンクを説明しています。

トランザクションを使用して、コードの欠落している部分をインストゥルメントする

アプリをインストゥルメントするために、New Relicはコードで各パスをそのトランザクションに分離します。New Relicは、これらのトランザクションの親メソッドの時間をインストゥルメントして総合的なパフォーマンスを測定し、追加詳細として長期間実行されているトランザクションからトランザクショントレースを収集します。

これらのメソッドは、New Relicがコードの特定の部分をインストゥルメントしていない場合に使用します。

セグメントを使用する時間固有メソッド

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

これらのメソッドは、既存のトランザクション内でメソッドをインストゥルメントする場合に使用します。

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

計測対象のコードがNew Relic UIに表示される場合もありますが、メソッドの詳細の一部が有用ではないことがあります。例：

• デフォルトの名前では、 メトリックのグループ化の問題が発生しています 。
• カスタム属性 をトランザクションに追加して、 クエリビルダ でフィルタリングできるようにしたい。

これらのメソッドは、New Relic UI ですでに表示されているトランザクションを New Relic がどのように計測するかを変更する場合に使用します。

関連ログの参照

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

• linking_metadata
• current_trace_id
• current_span_id

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

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

通常、エージェントは自動的にエラーを検出します。しかし、エージェントを使って手動でエラーをマークすることもできます。また、エラーを 無視または予想される としてマークすることもできます。

アプリケーションからカスタムイベントとメトリクスデータを送信する

APMには、任意のカスタムデータを記録する多くの方法が含まれます。New Relicデータ型の説明については、データ収集をご覧ください。

ブラウザエージェントの制御

通常、ブラウザエージェントは、ページに自動的に追加されるか、JavaScriptスニペットをコピー／ペーストすることで展開されます。これらの推奨方法の詳細については、 ブラウザモニタリングにアプリを追加する を参照してください。ただし、APMエージェントのAPIコールでブラウザエージェントを取得することもできます。詳細については、 browser_timing_header() を参照してください。

データストアへの呼び出しをインストゥルメントする

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

外部への機器呼び出し

これらの方法は、外部からの要求に応じてデータを収集するために使用します。

分散型トレーシングのためのインストゥルメントコール

これらのAPIは、 分散型トレーシングが有効になっている必要があります。.

Distributed tracing では、リクエストが分散システムを通過する際のパスを確認することができます。

以下のコールを使用して分散型トレーシングを実装する方法の一般的な説明については、 Use distributed tracing APIs を参照してください。