Tracing distribué pour vos services PHP

Le tracing distribué vous permet de voir l'intégralité du parcours de vos requests à travers un systèmes distribués. L'agent PHP instrumente automatiquement avec le traçage distribué un certain nombre de fonctions PHP natives, ainsi que certains clients HTTP tiers :

• Fonction PHP file_get_contents
• Fonctions PHP curl_exec et curl_multi_exec
• Guzzle 4, Guzzle 5, Guzzle 6
• Drupal drupal_http_request function
• Les tâches de la file d'attente de Laravel

Pour l' agent PHP, nous proposons deux types de tracing distribué (pour plus de détails, voir Comment fonctionne le span sampling) :

• Standard (échantillonnage en début de workflow) : Avant l'arrivée de toute trace, nous déterminons un pourcentage défini de trace à accepter et à analyser. Cela vous donne un point de départ solide pour voir comment le traçage peut vous aider. Il est activé par défaut dans l'agent PHP 9.21.0 et supérieur.

• Traçage infini (échantillonnage en fin de workflow) : Notre service basé sur le cloud accepte toutes vos traces puis les trie pour trouver les plus importantes. Le traçage infini analyse toutes vos traces et vous offre des options configuration pour échantillonner les traces qui comptent le plus pour vous.

Que vous souhaitiez simplement tester le traçage standard distribué (échantillonnage en début de workflow) ou que vous souhaitiez également mettre en place un traçage infini (échantillonnage en fin de workflow), vous devez commencer par mettre en place le traçage standard.

Traçage standard distribué

Il s’agit de la meilleure approche pour configurer le traçage standard distribué si vous n’avez pas encore installé d’agent APM pour vos services.

Identifier les services

Déterminez quels services touchent à votre demande afin de pouvoir instrumenter chacun d'eux pour envoyer des données trace à New Relic.

instrumenter chaque service avec un agent APM

Pour chaque service impliqué dans vos transactions, vous effectuerez une installation distincte de l'agent. Si certains de vos services utilisent d’autres langues, répétez simplement les étapes d’installation pour ces langues.

Pour démarrer la routine d'installation, cliquez sur la tuile ci-dessous. Une fois l'installation de chaque agent terminée, revenez ici pour voir des conseils pour visualiser votre trace.

Start installation

Afficher la trace

Après avoir instrumenté chacun de vos services avec l'agent APM, générez du trafic dans votre application afin que nous puissions capturer une trace. Voici quelques façons d'afficher votre trace dans l'UI:

Afficher les traces qui incluent un service spécifique

Voici une façon de voir la trace d’un service particulier :

1. Allez à one.newrelic.com > All capabilities > APM & services.
2. Cliquez sur votre entité (service).
3. Dans la section Monitor du volet de gauche, cliquez sur Distributed tracing.
4. Pour plus de détails, cliquez sur une trace individuelle. Si Group similar traces est activé dans le menu supérieur, cliquez sur un groupe trace, puis cliquez sur une trace individuelle.
5. Si vous ne voyez pas la trace souhaitée, vous pouvez filtrer par trace.id.

Afficher la trace sur les comptes

Pour voir la trace de ces comptes croisés :

1. Allez à one.newrelic.com > All capabilities > Traces.
2. Sélectionnez votre entité (service) dans le volet de gauche.
3. Pour plus de détails, cliquez sur une trace individuelle. Si Group similar traces est activé dans le menu supérieur, cliquez sur un groupe trace, puis cliquez sur une trace individuelle.
4. Si vous ne voyez pas la trace souhaitée, vous pouvez filtrer par trace.id.

Examiner le log lié à la trace

Vous pouvez rassembler votre log et vos détails de traçage pour rendre le dépannage plus facile et plus rapide. Avec les logs en contexte, vous pouvez voir le message du à côté de log la trace dans l'UI de New Relic.

Après avoir localisé une trace intéressante en suivant les étapes décrites dans Afficher la trace qui inclut un service spécifique ou Afficher la trace sur plusieurs comptes, procédez comme suit :

1. Si vous avez activé les journaux en contexte, cliquez sur l'onglet Logs (à côté de Trace details).
2. Pour afficher les détails relatifs à un log individuel, cliquez directement sur le message.

Pour plus d'aide pour trouver votre trace dans l'UI:

• Comprendre et utiliser l'UI de tracing distribué
• Interroger les données de traces distribuées

Traçage infini

Le traçage standard distribué pour l'agent APM capture jusqu'à 10 % de votre trace, mais si vous souhaitez que nous analysions toutes vos données et trouvions la trace la plus pertinente, vous pouvez configurer le traçage infini.

Avant de commencer, assurez-vous d’abord de répondre aux exigences.

Définir le niveau de détail de la trace

Le support du tracing distribué dépend du agent traceur de transaction de l' PHP. Lorsque le tracing distribué est activé, une étendue est créée pour chaque segment vu par le traceur de transaction.

Au fur et à mesure que les intervalles sont échantillonnés, l'agent PHP donnera la priorité aux intervalles liés aux appels externes par rapport aux autres intervalles, qui sont ensuite enregistrés par ordre décroissant de leur durée.

Si vous constatez qu'il y a trop d'intervalles sans importance signalés pour les appels de fonction PHP, vous pouvez réduire les détails du traceur de transaction en définissant newrelic.transaction_tracer.detail sur 0. Vous pouvez ensuite utiliser le newrelic.transaction_tracer.custom configuration paramètre ou la newrelic_add_custom_tracer API méthode pour ajouter trace des segments et des étendues pour la fonction ou les méthodes PHP spécifiques que vous souhaitez ajouter à votre trace.

Instrumenter manuellement les applications et les services avec l'API de l'agent PHP

newrelic_create_distributed_trace_payload()
newrelic_accept_distributed_trace_payload($payload)

newrelic_insert_distributed_trace_headers($outbound_headers)
newrelic_accept_distributed_trace_headers($inbound_headers)

Si vous utilisez une bibliothèque non prise en charge ou si vous disposez d'un composant système distribué non basé sur HTTP (tel qu'un fichier d'attente de messages), vous pouvez utiliser l'agent PHP API pour identifier manuellement les transactions à inclure dans une tracesystème distribuée. Il s’agit d’un processus en deux étapes :

1. Modifiez votre service ou application pour create ou insert les données de tracing distribué
2. Modifiez votre service ou application pour accept traceles données distribuées créées par d'autres transactions ou requests.

L'exemple suivant utilise une file d'attente de messages/travaux générique. Bien que les détails réels varient en fonction du type de système que vous essayez d'ajouter à une tracedistribuée, les concepts de base sont les mêmes. De plus, bien que nous ayons utilisé une file d'attente de travaux comme exemple, vous pouvez utiliser ces méthodes avec le composant any systèmes distribués.

Pour plus d'informations sur l'utilisation instrumentation manuelle pour obtenir plus de détails ou pour voir les connexions entre les services, consultez la documentation sur le tracing distribué d'API.

API d'en-tête

// 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 de charge utile (obsolète)

// 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);

Programmes PHP en ligne de commande

Les programmes PHP exécutés à partir de la ligne de commande PHP sont toujours échantillonnés par le traceur distribué de l'agent. Selon les programmes que vous exécutez, ces processus peuvent voir une surreprésentation dans votre collection de traces distribuées. Dans ces situations, vous pouvez choisir de désactiver l'instrumentation de ligne de commande en utilisant le paramètre per-directory newrelic.enabled dans votre newrelic.ini files.