トレースAPIに関する情報 データの要件を含みます。
- データの仕様と上限値
- 必要なメタデータ（ヘッダ、クエリパラメータ）
- レスポンスバリデーションの詳細
このドキュメントは、Trace API 全体に適用されます。特定のデータフォーマットに関するルールについては
エンドポイント
すべてのトレースデータは、HTTPS POST で Trace API エンドポイントに送信されます。お客様のセットアップに応じて、いくつかのエンドポイントを用意しています。
デフォルトのトレースAPIエンドポイント：
https://trace-api.newrelic.com/trace/v1EUのデータセンター：
https://trace-api.eu.newrelic.com/trace/v1(他の EUのエンドポイントを参照)Infinite Tracing: Trace observer setup を完了すると、エンドポイントとして使用するためのカスタム
YOUR_TRACE_OBSERVER_URL
の値が得られます。トレース API を使用する統合を使用している場合（たとえば、 これらの統合 ）、その統合をそのエンドポイントで設定する必要があります。また、トレースサービスの サンプリングを調整する必要があります。 100% のスパンを送信するようにしてください。
FedRAMPについては、 FedRAMP endpoints を参照してください。
データフォーマット
現在、Trace APIは2種類のデータ形式を受け付けています。
zipkin: Zipkin のトレースデータを報告するためのものです。Zipkin データは Zipkin JSON v2 である必要があります。newrelic: その他のすべてのトレースデータを報告するためのものです。
制限された属性
下の表の属性は、 newrelic-format JSON (in the attributes block) と zipkin -format JSON (in the tags block) で制限されています。 これらのキーを持つすべての値は省略されます。 。
制限付き属性 | 説明 |
|---|---|
文字列 | このスパンを作成したエンティティの一意の識別子。 |
文字列 | APMエージェントからのデータとの下位互換性のために使用されます。 |
以下の表の属性は、エンティティを識別するために内部的に使用されます。メトリック・データ・ポイントの属性セクションでこれらのキーを使用して送信された値は、UIにエンティティが表示されなかったり、遠隔測定が期待したエンティティに関連付けられないなど、未定義の動作を引き起こす可能性があります。詳細については、 Entity synthesis を参照してください。
制限付き属性 | 説明 |
|---|---|
文字列 | このスパンに関連するエンティティの一意の識別子。 |
文字列 | エンティティの人間が読める名前で、UIでエンティティを識別するためによく使われます。 |
文字列 | ホストやアプリケーションなど、異なるタイプのエンティティを区別するために使用されます。 |
リクエストのメタデータ（ヘッダ、クエリパラメータ）
次の表は、すべてのトレースデータ形式に必要なリクエストメタデータを示しています。このメタデータは、インジェストリクエストのHTTPヘッダとして送信することもできますし、場合によってはクエリパラメータとして提供することもできます。これは、ヘッダの修正ができないトレースフレームワークでは必要になるかもしれません。
重要
セキュリティ上の注意：クエリパラメータはURL内に存在し、暗号化されてNew Relicに受信される前にログに記録される可能性があるため、ヘッダーの使用をお勧めします。クエリーパラメーターとして送られるデータはすべて、URLセーフでなければなりません。
ヘッダー | クエリのパラメータ？ | 詳細 |
|---|---|---|
| いいえ | 必須です。 Must be |
| いいえ | 必須です。 リクエストボディの長さをオクテット(8ビットバイト)で表したもの。このヘッダーは、通常、データを送信する基礎となるHTTPクライアントによってデフォルトで設定されており、ほとんどの場合、エンドユーザーが追加の努力をする必要はありません。 |
| はい（大文字と小文字を区別します） | 必要です。 Trace APIには、 ライセンスキー が必要です。これがヘッダーとクエリーパラメーターの両方で提供されている場合は、値が一致している必要があります。 |
| いいえ | 圧縮されたペイロードの場合は必要です。 値は |
| はい | Required for 存在する場合、 |
| はい | に必要です。 存在する場合は、 これらの値の組み合わせは2通りしかありません。
|
| いいえ | Optional - Reserved for future use. The value must be a valid |
レスポンス・バリデーション
トレースデータの送信に成功した場合のレスポンスには、 requestId が含まれます。例えば、以下のようになります。
{"requestId":"c1bb62fc-001a-b000-0000-016bb152e1bb"}成功/エラーの通知方法は2種類あります。
HTTPステータスコード （同期）。認証やリクエストのエラーは、HTTPステータスコードで通知されます。
NrIntegrationErrorevents (asynchronous)。JSONペイロードのエラーやその他のセマンティックエラーは、NrIntegrationErrorイベント を通じて非同期的にシグナルが送られます。このイベントは、 ライセンスキー がリクエストに関連付けられているアカウントに保存されます。このタイプのすべてのエラーについて、属性newRelicFeatureはDistributed Tracingとなり、requestIdはエンドポイント応答のrequestIdとなります。
202 レスポンスを受信し、 NrIntegrationError イベントが表示されなければ、約1分でNew Relic Oneのグローバルな 分散型トレースUI にデータが表示されるはずです。標準的な トレース検索 のような方法でトレースを見つけることができるはずです。
traceId = TRACE_ID_SENTデータ制限
トレース関連の制限については、 How distributed tracing works を参照してください。