PHPエージェントの分散型トレーシング

New Relic の PHP エージェントは、 分散型トレース (PHP エージェント バージョン 9.8 以降、 W3C Trace Context を含む) をサポートしています。これにより、リクエストが分散システムを通過する際の経路を確認することができます。このドキュメントでは、PHP アプリケーションやサービスで分散型トレースを有効にするための PHP 固有のヒントを紹介します。

PHPの分散型トレーシングを有効にする

PHP エージェントの分散トレースを有効または無効にするには、以下の手順に従います。

1. 該当する場合は、PHPエージェント をアップデートして、分散型トレーシングをサポートするようにしてください（バージョン8.4以降、ただし、最も完全な機能を得るためにはバージョン9.8以降を推奨します）。

2. トランザクショントレーサー構成オプションが有効になっていることを確認します（デフォルトはtrue ）。

   newrelic.transaction_tracer.enabled = true

   コピー

3. distributed_tracing_enabled構成オプションを使用してPHPエージェントの分散トレースを有効（または無効）にします。

   newrelic.distributed_tracing_enabled = true

   コピー

4. トランザクショントレーサーの閾値 の値を適切な値に設定する。 推奨。

   • すべてのトランザクションを分散トレースの対象にする場合は、この値を0秒に設定します。
   • 実行時間の長いトランザクションのトレースのみに関心がある場合、またはトランザクションごとにトレースを生成すると許容できないアプリケーションパフォーマンスが発生する場合は、この値を0秒より高く設定します。

   例えば：

   newrelic.transaction_tracer.threshold = 0

   コピー

5. オプションで、W3Cトレースコンテキストトレースのみが必要な場合は、 newrelic.distributed_tracing_exclude_newrelic_header構成オプションを使用してNew RelicDistributedTracingヘッダーを無効にできます。

   newrelic.distributed_tracing_exclude_newrelic_header = 1

6. コンフィグレーションの設定でスパンを有効にします。

   newrelic.span_events_enabled = true

7. エージェントが新しく設定された値を取り込むために、必ずウェブサーバー（またはその他のPHP SAPI）を再起動してください。

インフィニット トレースの有効化

Infinite Tracing (PHP エージェント バージョン 9.12 以降) は、分散型トレーシングを拡張し、New Relic Edge と呼ばれる AWS 上のサービスクラスタで動作するトレースオブザーバーにスパンデータを収集します。PHP エージェントは、すべてのスパンをトレースオブザーバーに送信し、それらをトレースにまとめて New Relic で表示できるようにします。

Infinite Tracingを有効にするには、分散型トレーシングを有効にし、以下の追加設定を行います。

newrelic.span_events_enabled = true
newrelic.infinite_tracing.trace_observer.host=" YOUR_TRACE_OBSERVER_HOST"

自動分散型トレーシング装置の活用

PHPエージェントは、いくつかのネイティブなPHP関数やサードパーティのHTTPクライアントを自動的に計測し、分散されたトレース情報を提供します。これらは以下の通りです。

• PHP関数file_get_contents
• PHP関数curl_execおよびcurl_multi_exec
• ガズル4、ガズル5、ガズル6
• Drupalの drupal_http_request function
• Laravelのキュー・ジョブ

トレースの詳細レベルの設定

分散トレーシングのサポートは、PHPエージェントの トランザクショントレーサー に依存します。 分散トレーシングが有効になっている場合 、 スパン は、トランザクショントレーサーが見る各セグメントに対して作成されます。

スパンがサンプリングされると、PHPエージェントは、外部呼び出しに関連するスパンを他のスパンよりも優先し、期間の降順で記録されます。トランザクションごとにサンプリングされるスパンの最大数を決定するためのini設定があり、パフォーマンスに影響を与える可能性があります。

PHP関数呼び出しについて報告されている重要でないスパンが多すぎる場合は、 newrelic.transaction_tracer.detailを0に設定することで、トランザクショントレーサーの詳細を減らすことができます。次に、 newrelic.transaction_tracer.custom構成設定またはnewrelic_add_custom_tracer APIメソッドを使用して、トレースに追加する特定のPHP関数またはメソッドのトレースセグメントとスパンを追加できます。

トレースの詳細についてログを調べる

ログとアプリケーションのデータを統合して、トラブルシューティングをより簡単かつ迅速に行うことができます。コンテキストのログでは、エラーとトレースに関連するログメッセージをアプリケーションのUIで直接表示できます。

1. Transactionsページでトレースをクリックして、Trace detailsページに移動します。
2. トレースの詳細ページで、See logsをクリックします。
3. 各ログメッセージに関連する詳細を表示するには、メッセージを直接クリックしてください。

また、Kubernetesクラスターなどのインフラストラクチャデータのコンテキストでログを表示することもできます。別のUIページに切り替える必要はありません。

アプリケーションやサービスを手動でインストルメントする

サポートされていないライブラリを使用している場合や、HTTPベースではない分散システムコンポーネント(メッセージングキューなど)を使用している場合は、PHPエージェントAPIを使用して、分散トレースに含めるべきトランザクションを手動で特定することができます。これは、2つのステップで行います。

1. サービスやアプリケーションを変更して、 create or insert 分散型トレースデータ
2. 他のトランザクションやリクエストによって作成された 分散型トレースデータを受け入れるように、サービスやアプリケーションを変更します。

以下の例では、一般的なメッセージ/ジョブキューを使用しています。実際の詳細は、分散トレースにどのようなシステムを追加しようとしているかによって異なりますが、基本的なコンセプトは同じです。また、ジョブキューを例に挙げましたが、これらのメソッドは 任意の 分散システムコンポーネントに使用することができます。

より詳細な情報を得るため、またはサービス間の接続を確認するために手動でインスツルメンテーションを使用する場合の詳細については、 分散型トレースAPIに関するドキュメント を参照してください。

ヘッダーAPI

// create a job object
$job = new \Generic\Queue\Job;

// set the information needed to run the queue job
$job->setData('info', $info);

// save the job
$job->save();

$outbound_headers = array();
if (newrelic_insert_distributed_trace_headers($outbound_headers)) {

    // create a job object
    $job = new \Generic\Queue\Job;

    // set the information needed to run the queue job
    $job->setData('info', $info);

    // add the headers to the job data
    $job->setData('nr_dt_headers', $outbound_headers);

    // save the job
    $job->save();
} else {
    echo "Unable to obtain distributed tracing headers";
}

// create the job runner
$jobRunner = \Generic\Queue\Runner;

// grab jobs until there aren't any
while($job = $jobRunner->next()) {
    // run the job
    $job->run();
}

// create the job runner
$jobRunner = \Generic\Queue\Runner;

while($job = $jobRunner->next()) {
    $inbound_headers = $job->getData('nr_dt_headers');
    if($inbound_headers) {
        newrelic_accept_distributed_trace_headers($inbound_headers);
    }
    $job->run();
}

ペイロードAPI（非推奨）

// create a job object
$job = new \Generic\Queue\Job;

// set the information needed to run the queue job
$job->setData('info', $info);

// save the job
$job->save();

$payload = newrelic_create_distributed_trace_payload();

// create a job object
$job = new \Generic\Queue\Job;

// set the information needed to run the queue job
$job->setData('info', $info);

// add the payload data to the job data as a text json string
$job->setData('dt_payload', $payload->Text());

// save the job
$job->save();

// create the job runner
$jobRunner = \Generic\Queue\Runner;

// grab jobs until there aren't any
while($job = $jobRunner->next()) {
    // run the job
    $job->run();
}

// create the job runner
$jobRunner = \Generic\Queue\Runner;

while($job = $jobRunner->next()) {
    $payload = $job->getData('dt_payload');
    if($payload) {
        newrelic_accept_distributed_trace_payload($payload);
    }
    $job->run();
}

// create the HTTP safe payload string 
$payload = newrelic_create_distributed_trace_payload();
$httpSafePayload = $payload->httpSafe();

// ...

// accept the HTTP safe payload string
newrelic_accept_distributed_trace_payload_httpsafe($httpSafePayload);

コマンドラインPHPプログラム

PHPコマンドラインから実行されるPHPプログラムは、常にエージェントの分散トレーサーによってサンプリングされます。実行するプログラムによっては、これらのプロセスで、分散トレースのコレクションに過剰な表現が見られる場合があります。このような状況では、 newrelic.ini filesのper-directory newrelic.enabled設定を使用して、コマンドラインインストルメンテーションを無効にすることを選択できます。