JavaエージェントAPIの使用ガイド

New Relicがトランザクションを自動作成しない場合、Transaction を作成する。

報告されるべき作業を含むメソッドで@Trace(dispatcher = true)。このアノテーションを既存トランザクションのコンテキスト内のメソッドで使用した場合、新たなトランザクションは開始されず、このメソッドを既存トランザクションに含めることになります。

New Relicが自動的にトレースしないメソッドの経過時間を取得する

時間を計測したいメソッドに@Trace()する。

現在の名前を設定する Transaction

NewRelic.setTransactionName(...)

現在のTransaction のレスポンスタイムに対しタイマーを開始し、作成する Transaction を Web トランザクションとしてではなく、Other Webトランザクションとして報告する。

NewRelic.setRequestAndReponse(...)

カスタム属性をTransactionsに追加する TransactionEvents

NewRelic.addCustomParameter(...)

enduser.idエージェント属性を設定して、ユーザー追跡をTransactionsに追加します。

NewRelic.setUserId()

Transaction がNew Relicに報告されるのを防ぐ。

NewRelic.ignoreTransaction()

アプリケーションの TransactionApdex スコアを計算するときに を除外する

NewRelic.ignoreApdex()

既存の Transaction にリンクされている場合の非同期メソッドをトレースする。

@Trace(async = true)

現在のスレッド上の Transaction に関連する Token をリンクする。

Token.link() または Token.linkAndExpire()

現在の Tokenに関連する Transaction を失効させる

Token.expire()

Segmentの時間計測を停止し、その親の一部として報告させる Transaction

Segment.end()

Segmentの時間計測を停止し、その親の一部として報告させない Transaction

Segment.ignore()

受信または送信メッセージのタイプ固有のヘッダーについて説明します。

Headers

Headersの提供された実装については、ConcurrentHashMapHeadersを使用してください。

Kafkaを使用したDT API使用におけるW3Cトレースコンテキストヘッダーの実装例を参照してください。

ディストリビューティッド（分散）トレーシングのヘッダーを作成して、Headersデータ構造に挿入します。このAPIは、newrelicヘッダーとW3C Trace Contextヘッダー（traceparentとtracestate）の両方を挿入します。明示的にnewrelicヘッダーを除外するようにエージェントが設定されている場合は例外です。

Transaction.insertDistributedTraceHeaders(Headers)

現行のトランザクションおよびその他のAPIクラスへのリファレンスの取得の詳細については、リファレンスの取得をご覧ください。

呼び出し元サービスから送信されたディストリビューティッド（分散）トレーシングヘッダーを受け入れて、ディストリビューティッド（分散）トレースでこれらのサービスをリンクします。

Transaction.acceptDistributedTraceHeaders(TransportType, Headers)

現行のトランザクションおよびその他のAPIクラスへのリファレンスの取得の詳細については、リファレンスの取得をご覧ください。

ディストリビューティッド（分散）トレーシングのヘッダーを受け入れる際のトランスポートタイプを定義するための列挙体の定数を提供するユーティリティクラスを理解します。

分散トレースのカスタム属性をSpanEventsに追加

NewRelic.getAgent().getTracedMethod().addCustomAttribute(...)

呼び出したサービスに送るペイロードを作成する。

Transaction.createDistributedTracePayload()

現行のトランザクションおよびその他のAPIクラスへのリファレンスの取得の詳細については、リファレンスの取得をご覧ください。

最初のサービスから送られたペイロードを受け取る。その結果、これらのサービスを1つのトレース内で結びつけることができる。

Transaction.acceptDistributedTracePayload(...)

現行のトランザクションおよびその他のAPIクラスへのリファレンスの取得の詳細については、リファレンスの取得をご覧ください。

サービス接続に使用するペイロード。text() コールが、ペイロードのJSON文字列表現を返す。

DistributedTracePayload.text()

サービス接続に使用するペイロード。httpSafe() コールが、base64エンコードされたペイロードのJSON文字列表現を返す。

DistributedTracePayload.httpSafe()

プロプライエタリRPCトランスポートなど、New Relicがデフォルトでサポートしていないカスタムトランスポートチャネルを通してトレースする

Transaction.getRequestMetadata(), .processRequestMetadata(...), .getResponseMetadata(), .processResponseMetadata(...)

Transactionを使用してNew Relic APIクラスへのリファレンスを取得する方法については、このドキュメントの情報もご覧ください。

のメトリック名やロールアップメトリック名を表示または変更する TracedMethod

（OtherTransaction/allなどのロールアップメトリック名は特定のトランザクションに限定されておらず、すべてのバックグラウンドトランザクションを表しています。）

TracedMethod.getMetricName(), .setMetricName(...), .setRollupMetricName(...)

TracedMethodを使用してNew Relic APIクラスへのリファレンスを取得する方法については、このドキュメントの情報もご覧ください。

JavaエージェントAPIの @Trace アノテーションを使用してトレースされている、外部HTTPサービス、データベースサーバー、メッセージキュー、またその他の外部リソースへのコールを報告する

TracedMethod.reportAsExternal(...)はExternalParametersビルダーを使用して構築された引数を渡します。

TracedMethodを使用してNew Relic APIクラスへのリファレンスを取得する方法については、このドキュメントの情報もご覧ください。

New Relicによってインストゥルメントされている外部HTTPまたはJMSサービスと通信している際に、クロスアプリケーショントレーシングを有効化して追加する

TracedMethod.addOutboundRequestHeaders(...)ならびに TracedMethod.reportAsExternal(...)

TracedMethodを使用してNew Relic APIクラスへのリファレンスを取得する方法については、このドキュメントの情報もご覧ください。

自動でサポートされないアプリケーションサーバーやディスパッチャーに対しタイミングを追加する。

Transaction.setRequest(...), Transaction.setResponse(...)、またはNewRelic.setRequestAndResponse(...)、および Transaction.markResponseSent()

Transactionを使用してNew Relic APIクラスへのリファレンスを取得する方法については、このドキュメントの情報もご覧ください。

現在の へのリファレンスを入手する Transaction

NewRelic.getAgent().getTransaction()

非同期の作業をリンクするための Token を入手する。

開始して、へのリファレンスを入手する Segment

現在トレースされているメソッドへのリファレンスを入手する。

NewRelic.getAgent().getTracedMethod()

Agent ロガーへのリファレンスを入手する。

NewRelic.getAgent().getLogger()

AgentAgentコンフィギュレーションへのリファレンスを入手する。

NewRelic.getAgent().getConfig()

カスタムメトリックスに対するアグリゲータへのリファレンスを入手する。

NewRelic.getAgent().getAggregator()

カスタムイベントを記録するために、Insights（カスタムイベントを管理する機能の元の名前）への参照を取得する

NewRelic.getAgent().getInsights()

アプリケーションサーバーやディスパッチャーに対してポート、名前、バージョン情報、もしくはJVMに対してインスタンス名を明示的に設定する。

New Relicが自動的に報告しないエラーを報告する。

NewRelic.noticeError(...)

トランザクション内では、noticeErrorへの最後の呼び出しが優先されます。トランザクションごとに1つのエラーのみが報告されます。

独自のカスタム定義フィンガープリントでエラーをグループ化し、ErrorGroupCallbackインターフェイスの実装を用いて、New Relicに送信されるエラーのグループキーを生成します。フィンガープリントは、エラー受信トレイUIでエラーメッセージのグループ化に使用します。

コールバック関数を使用して、独自のエラーフィンガープリントを設定します。指定されたエラーのグループキーの生成に使用するErrorGroupCallbackを登録します。

NewRelic.setErrorGroupCallback(errorGroupCallback)

New Relicが自動的にヘッダに追加しない に対する、ブラウザ ページロードタイミングTransactionsを追加する。

カスタムメトリックスを作成および蓄積する。

NewRelic.recordMetric(...)、.recordResponseTimeMetric(...) 、または .incrementCounter(...)

カスタムイベントを記録

Insights.recordCustomEvent(...)

または、NewRelic.addCustomParameter(...)を使用して、New Relicが定義したTransactionEventタイプにカスタム属性を追加する。

Insightsを使用してNew Relic APIクラスへのリファレンスを取得する方法については、このドキュメントの情報もご覧ください。

エージェントに一般的なクラウドプロバイダーのアカウント情報を提供する

NewRelic.getAgent().getCloud().setAccountInfo(CloudAccountInfo.AWS_ACCOUNT_ID, "...");

このメソッドを使用すると、アカウント情報の種類とその値を指定できます。エージェントは、選択したクラウドサービススパンのcloud.resource_id属性の設定にこの情報を使用します。

AWS DynamoDBとKinesisの両サービスでは、cloud.resource_id属性を設定するためにこの値が必要となります。同様に、AWS Lambdaでは、アカウントIDが関数名の一部として使用されていない場合にこの値が必要となります。

このメソッドを呼び出すと、それぞれのクラウド設定が上書きされます。上記の呼び出しではcloud.aws.account_idが上書きされます。

SDKクライアント固有のクラウドプロバイダーのアカウント情報をエージェントに提供する

NewRelic.getAgent().getCloud().setAccountInfo(sdkClient, CloudAccountInfo.AWS_ACCOUNT_ID, "...");

この呼び出しは前のメソッドと同じ情報を提供するものですが、特定のSDKクライアントに固有のものです。特定のSDKクライアントを使用する場合、一般的なデータではなくこのデータが使用されます。