Logs en contexte de l'agent Node.js

Avec notre agent Node.js APM, vous pouvez obtenir des logs en contexte, ce qui vous permet de voir le log de votre application dans le contexte de vos autres données New Relic. Pour des informations générales sur cette fonctionnalité, consultez Logs en contexte APM.

Conseil

Vous avez beaucoup de logs Node.js ? Consultez notre tutoriel pour savoir comment les optimiser et les gérer.

Options de logs en contexte automatiques

Avec le logging des applications, votre agent APM collecte et contextualise automatiquement votre log.

Si vous utilisez un framework pris en charge, vous disposez de trois options pour configurer les logs APM afin d'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 :

Winston 3.0.0 ou supérieur.
Pino 7.0.0 ou supérieur.
Bunyan 1.8.12 ou supérieur (depuis la version de l'agent 9.3.0)

Si vous n'utilisez pas de framework pris en charge, vous pouvez utiliser à la place la méthode API de transfert de logde l'agent pour effectuer votre propre instrumentation. Pour plus de détails, consultez la documentation de l'API de l'agent Node.js

Important

Agent sortie 8.16.0 et versions ultérieures ont cette fonctionnalité activée dans le fichier configuration de l'agent par défaut.

L'agent de transfert de logentraînera une augmentation de la consommation de données lorsqu'un framework pris en charge est détecté. Le montant dépend de l'application et de la quantité de logs produits. Cette fonctionnalité peut être désactivée. Consultez Désactiver le logging automatique pour plus d’informations sur vos options.

Si vous disposez déjà d'une solution de transfert de log , vous devez désactiver cette fonctionnalité.

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 signale l'intégralité de votre log et ajoute nos attributs span.id, trace.id, hostname, entity.guid et entity.name. Ces attributs lient votre log aux étendues, aux traces et à d'autres télémétries, ce qui facilite le dépannage.

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

newrelic.js:

application_logging: {
  forwarding: {
    enabled: true
  }
}

Variable d'environnement :

NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED=true

Cette option est activée par défaut depuis la version 8.16.0 de l'agent.

Optional adjustments:

Une fois cette option activée, vous avez également le contrôle sur le nombre maximum de logs envoyés à New Relic chaque minute. La valeur par défaut est 10 000. Si plus de 10 000 logs sont reçus dans une fenêtre de 60 secondes, votre log commencera à être échantillonné.

Réglez-le sur un nombre plus élevé pour recevoir plus de logs. Réglez-le sur un nombre inférieur pour recevoir moins de logs. Tout entier jusqu'à 100 000 est valide. L'augmentation de cette valeur peut augmenter l'utilisation du processeur et de la RAM par l'agent.

newrelic.js:

application_logging: {
  forwarding: {
    max_samples_stored: 10000
  }
}

Variable d'environnement :

NEW_RELIC_APPLICATION_LOGGING_FORWARDING_MAX_SAMPLES_STORED: 10000

Si vous disposez déjà d'une solution de transfert de loget 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 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.

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 option ne doit pas être utilisée avec le transfert interne à l'agent. L'utilisation d'un redirecteur de logexterne pour envoyer le log à New Relic alors que le transfert interne à l'agent est activé entraînera l'envoi de votre log deux fois à New Relic. Selon votre compte, cela peut entraîner une double facturation.

Cette option ne doit pas non plus être utilisée avec le formateur de décoration log manuel. Si vous avez des références au formateur manuel dans votre base de code, veuillez les supprimer avant d'activer cette option.

Si vous souhaitez utiliser cette option, assurez-vous que l’option de configuration de transfert dans l’agent est désactivée.
newrelic.js:
```
application_logging: {
  forwarding: {
    enabled: false
  }
}
```
Activez la décoration log dans votre configuration, puis relancez l'agent pour commencer à décorer votre log.
newrelic.js:
```
application_logging: {
  local_decorating: {
    enabled: true
  }
}
```
Variable d'environnement :
```
NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED=true
```
Notre décorateur ajoute cinq attributs à chaque message de log: 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}|
```
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}|.
```
Le message de sortie du log sera une chaîne vide.
Certains attributs peuvent être vides si le log s'est produit en dehors d'une transaction ou s'ils ne sont pas applicables au contexte de votre application.
Nous recommandons cette option plutôt que d’utiliser manuellement l’un de nos enrichisseurs log .

Avant que les agents linguistiques framework log n'aient la possibilité de transmettre et de décorer les logs, vous pouviez activer les logs en contexte en mettant à jour votre application pour utiliser un enrichisseur spécifique . Cette option est toujours prise en charge, mais n'est plus encouragée. Pour obtenir des instructions sur l'utilisation de cette approche, consultez l'option logs en contexte manuels.

De plus, cette méthode nécessite que vous installiez un redirecteur de logavant d'activer les logs dans ce 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.

Ce document vous a-t-il aidé lors de votre installation ?

Sécurisez vos données

Votre log peut inclure des informations sensibles protégées par la loi HIPAA ou d’autres protocoles de conformité. Par défaut, nous masquons les modèles de numéros qui semblent correspondre à des éléments tels que des cartes de crédit ou des numéros de sécurité sociale, mais vous devrez peut-être hacher ou masquer des informations supplémentaires.

Pour plus d'informations, consultez notre documentation sur l'expression d'obfuscation et les règles. Vous pouvez hacher ou masquer vos données log en utilisant l'interface utilisateur de New Relic ou en utilisant NerdGraph, notre API GraphQL .

Explorez vos données

Pour tirer le meilleur parti de vos données de logging :

Sur la page APM Summary , cliquez sur votre graphique Web transaction time pour afficher le log associé à un moment précis.
Vérifiez Errors inbox de votre application pour afficher le log associé à vos erreurs.
Utilisez le tracing distribué pour voir le log associé à une trace individuelle.
Explorez davantage de données de logging sur votre plateforme avec notre interface utilisateur de logs.
Configurez des alertes en fonction de la sortie log et de la gravité.
Interrogez vos données à l'aide de notre interface utilisateur spécialisée pour les données de log et créez des dashboards avec les résultats.

Conseils de dépannage

En règle générale, votre log commencera à apparaître moins d'une minute après avoir activé logs dans ce contexte. Vérifiez la section Triage > Logs de votre application. Vous commencerez également à voir log patterns liés à l’erreur.

Si vous ne voyez aucun log d'erreurs ou de trace, il se peut qu'il n'y en ait pas pour votre application. Essayez d'actualiser la page de l'interface utilisateur ou de modifier la période sélectionnée.

Désactiver le logging automatique

Les logs APM dans le contexte transmettent automatiquement les données log de l'agent APM. Il est activé par défaut. Si vous activez le logging des applications, cela peut avoir un impact négatif sur votre sécurité, votre conformité, votre facturation ou les performances de votre système. Pour plus d'informations, ou si vous devez ajuster le paramètre par défaut, suivez les procédures pour désactiver le logging automatique.

Option logs en contexte manuels

Pour activer les logs en contexte pour apps monitorer par Node.js, vous pouvez utiliser notre option d'installation manuelle.

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 votre log d'application et étend les métadonnées qui sont transmises à New Relic.
Installez ou mettez à jour vers la dernière version de l'agent Node.js et activez le tracing distribué. Utilisez l'agent Node.js version 6.2.0 ou supérieure pour les logs en contexte.
Installez un framework pris en charge pour enrichir vos données log , ou utilisez directement l'API de transfert de logde l'agent.
Dans la configuration de votre agent, définissez application_logging.enabled sur false. (Sinon, l'agent instrumente automatiquement votre enregistreur et appeler vous-même ces enrichisseurs ne fera rien.)
Configurez les logs en contexte pour Node.js en utilisant l'extension log appropriée.
Pour installer l'enrichisseur log Winston, entrez la commande suivante dans votre terminal ou interface de ligne de commande :
bash
$npm install @newrelic/winston-enricher
Dans votre code d'application, mettez à jour votre configuration de logging pour ajouter le newrelicFormatter:
// index.js require('newrelic') const winston = require('winston') const newrelicFormatter = require('@newrelic/winston-enricher')(winston)
Le formateur New Relic peut être utilisé individuellement ou combiné avec d'autres formateurs comme format final.
format: winston.format.combine( winston.format.label({label: 'test'}), newrelicFormatter() )
Pour installer l'enrichisseur log Pino, entrez la commande suivante dans votre terminal ou interface de ligne de commande :
bash
$npm install @newrelic/pino-enricher
Dans le code de votre application, mettez à jour votre configuration de logging pour ajouter le plugin New Relic Pino :
// index.js require('newrelic') const nrPino = require('@newrelic/pino-enricher') const pino = require('pino') const logger = pino(nrPino())
Le formateur New Relic peut être utilisé individuellement ou combiné avec d'autres formateurs comme format final.
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. Si vous souhaitez voir un exemple fonctionnel de logs en contexte, jetez un œil à notre exemple d'application.

Quelle est la prochaine étape ?

Après avoir configuré logs dans le contexte, tirez le meilleur parti de vos données de logging :

Explorez les données de logging sur votre plateforme avec notre interface utilisateur de logs.
Consultez vos logs en contexte des performances de votre application dans l' interface utilisateur APM. Résolvez les erreurs avec le tracing distribué, le suivi des appels, le log d'application et bien plus encore.
Obtenez une visibilité plus approfondie sur les données de performances de votre application et de votre plateforme en transmettant vos logs à notre agent d'infrastructure. Consultez vos logs d’infrastructure dans l’interface utilisateur.
Configurer des alertes.
interrogez vos données et créez un dashboard.

Cette traduction automatique est fournie pour votre commodité.

Conseil

Options de logs en contexte automatiques

Important

Option 1 (la plus simple) : Laissez l'agent décorer et transmettre votre log.

Option 2 : Laissez l'agent décorer votre log.

Option 3 : Utilisez le processus manuel pour transférer et décorer le log.

Ce document vous a-t-il aidé lors de votre installation ?

Sécurisez vos données

Explorez vos données

Conseils de dépannage

Désactiver le logging automatique

Option logs en contexte manuels

Node.js configuration avec Winston

Node.js configuration avec Pino

Quelle est la prochaine étape ?

Cette traduction automatique est fournie pour votre commodité.

Logs en contexte de l'agent Node.js

Conseil

Options de logs en contexte automatiques .css-21sua1{background:none;border:none;width:0;padding:0;}

Important

Option 2 : Laissez l'agent décorer votre log.

Option 3 : Utilisez le processus manuel pour transférer et décorer le log.

Ce document vous a-t-il aidé lors de votre installation ?

Sécurisez vos données

Explorez vos données

Conseils de dépannage

Désactiver le logging automatique

Option logs en contexte manuels

Node.js configuration avec Winston

Node.js configuration avec Pino

Quelle est la prochaine étape ?

Options de logs en contexte automatiques