Logs en contexte de l'agent PHP

Si vous utilisez un framework pris en charge, vous pouvez configurer l'agent APM pour envoyer automatiquement le log et les métadonnées de liaison de votre application à New Relic. Les frameworks pris en charge pour les logs automatiques dans le contexte incluent :

• Monologue (version 2 ou 3)

  Il s'agit de l'approche la plus simple et constitue un excellent choix pour les développeurs qui n'ont peut-être pas l'accès ou l'intérêt de configurer un redirecteur de log , ou pour les comptes qui souhaitent voir la puissance des logs et autres liens métadonnées dans le contexte de leurs applications, sans beaucoup de frais généraux.

  En utilisant cette option, l'agent ajoute span.id, trace.id, hostname, entity.guid et entity.name. Renseignez-vous sur les limites du transfert de log.

  Important

  Depuis la sortie de l'agent 10.3.0, les métriques de logging et la fonctionnalité de transfert de logde l'agent sont activées par défaut.

  Il vous suffit d'installer une version d'agent avec des capacités de transfert de log (agent PHP 10.1.0 ou supérieur). Si le transfert est désactivé, vous pouvez utiliser cette configuration :

  Fichier de configuration (newrelic.ini):

  newrelic.application_logging.enabled = true
  newrelic.application_logging.metrics.enabled = true
  newrelic.application_logging.forwarding.enabled = true

  Copier

  La documentation configuration de l'agent PHP explique en détail comment configurer votre agent, mais ici nous allons passer en revue et créer un lien vers certains des aspects les plus importants de la configuration du log PHP.

  Il existe une seule option pour contrôler si la fonctionnalité de logging principale est active :

• newrelic.application_logging.enabled

  Si vous utilisez un framework de logging pris en charge, l'agent peut envoyer des métriques qui mesurent le nombre de gravité des messages de log générés par votre application. Vous pouvez activer cette fonctionnalité en utilisant la configuration newrelic.application_logging.metrics.enabled .

  Si vous utilisez un framework de logging pris en charge et que vous souhaitez utiliser l'agent pour envoyer votre log d'application à New Relic, vous pouvez contrôler cela via les paramètres INI préfixés newrelic.application_logging.forwarding. Les options disponibles sont :

• enabled

• max_samples_stored

• log_level

  Si vous utilisez la bibliothèque de logging Monolog (version 2 ou 3), vous pouvez également activer l'attribut de contexte log . Cela convertit les données de contexte de logging transmises à Monolog en attribut New Relic. Vous pouvez contrôler cette fonctionnalité via les paramètres INI préfixés newrelic.application_logging.forwarding.context_data . Les options disponibles sont :

• enabled

• include

• exclude

  Important

  Si vous disposez d'une solution de transfert de logexistante et que vous mettez à jour votre agent pour utiliser les logs automatiques dans ce contexte, assurez-vous de disable your manual log forwarder. Sinon, votre application enverra le double de données log . Selon votre compte, cela peut entraîner une double facturation. Pour plus d'informations, découvrez comment désactiver votre redirecteur de logspécifique.

Vous avez déjà un redirecteur de logqui vous plaît ? Nous sommes là pour vous ! Les agents linguistiques peuvent décorer votre log avec les liens métadonnées nécessaires pour fournir l'accès aux logs automatiques en contexte de fonctionnalité.

Cette méthode nécessite que vous installiez un redirecteur de log externe avant d'activer les logs en contexte. Si vous ne disposez pas d'un redirecteur de log , l'interface utilisateur de New Relic vous prompt d'utiliser notre agent infrastructure .

Si vous décidez d'utiliser votre solution de transfert de log existante et que vous décidez ultérieurement de mettre à jour votre agent pour utiliser les logs en contexte automatiques, assurez-vous de disable your manual log forwarder. Sinon, votre application enverra des lignes log en double. Selon votre compte, cela peut entraîner une double facturation. Pour plus d'informations, suivez les procédures pour désactiver votre redirecteur de logspécifique.

Si vous choisissez d'utiliser la décoration log pour activer les logs dans le contexte de PHP, configurez d'abord votre application PHP.

1. Assurez-vous d'avoir déjà configuré le logging dans New Relic. Cela inclut la configuration d'un redirecteur de logpris en charge qui collecte vos logs d'application et les transmet à New Relic.

2. Installez ou mettez à jour la dernière version de l'agent PHP et activez le tracing distribué. Utilisez l'agent PHP version 10.13.0.1 ou supérieure pour la prise en charge de la décoration des logs.

3. Installez Monolog version 2 ou 3.

4. Configurez la décoration des logs pour PHP à l'aide de l'extension Monolog.

   Pour activer la décoration log local :

   1. Désactiver le transfert automatique des log :

      newrelic.application_logging.forwarding.enabled = false

      Copier

   2. Activer la décoration log local par l'agent PHP :

      newrelic.application_logging.local_decorating.enabled = true

      Copier

   3. L'agent PHP va maintenant ajouter des métadonnées de liaison à chaque enregistrement log Monolog. Pour que ces informations apparaissent dans le message de log réel, il est nécessaire de définir un formateur Monolog pour chaque gestionnaire Monolog qui inclut la spécification de format %extra.NR-LINKING% à la fin du message. Il s'agit des données de liaison nécessaires pour que les logs en contexte fonctionnent.

      Par exemple:

      <?php
      use Monolog\Logger;
      use Monolog\Formatter\LineFormatter;
      use Monolog\Handler\StreamHandler;
      
      $logger = new Logger('log');
      $handler = new StreamHandler('php://stderr');
      $logfmt = "%channel%.%level_name%: %message% %extra.NR-LINKING%\n";
      $formatter = new LineFormatter($logfmt);
      $handler->setFormatter($formatter);
      $logger->pushHandler($handler);

      Copier

      Notre décorateur ajoute cinq attributs à chaque log message (texte brut) : entity.guid, entity.name, hostname, trace.id et span.id. Exemple:

      This is my log message. NR-LINKING|{entity.guid}|{hostname}|{trace.id}|{span.id}|{entity.name}|

      Copier

      Si le message de log est vide ou vierge, le message de sortie sera également vide. Exemple:

   NR-LINKING|{entity.guid}|{hostname}|{trace.id}|{span.id}|{entity.name}|.

   Copier

   Le message de sortie du log sera une chaîne vide.

5. Pour vérifier que vous avez correctement configuré l'appender log , exécutez votre application, puis vérifiez vos données de log dans New Relic à l'aide de l'opérateur de requête has:span.id has:trace.id.

   Si tout est configuré correctement et que vos données sont transmises à New Relic avec la métadonnées enrichie, votre log devrait maintenant être émistre en JSON et contenir les champs trace.id et span.id . Si vous ne voyez pas les données du log dans l'interface utilisateur, suivez les procédures de dépannage.