Installer l'agent Node.js

Pour terminer une installation d'agent Node.js de base, vous pouvez utiliser notre installation guidée pour une installation automatisée (choisissez UE si vous êtes dans l'UE) ou suivre les instructions de ce document. Dans tous les cas, vous avez besoin d'un compte New Relic si vous n'en avez pas déjà un. (C'est gratuit, pour toujours !)

Notre Node.js agent est disponible publiquement sur le référentiel Node gestionnaire de paquets (npm) ainsi que sur GitHub.

Installer l'agent Node.js

Pour installer l’agent Node.js :

1. Créez un compte New Relic. Vous n'en avez pas ? Inscrivez-vous gratuitement ! Aucune carte de crédit requise.

2. Assurez-vous de répondre à l' exigence système. Assurez-vous notamment d’utiliser une version de Node.js prise en charge.

3. Utilisez la commande npm install newrelic pour chaque application que vous souhaitez monitorer. Si votre application utilise l'un de ces modules Apollo Server, installez notre plugin Apollo avec npm install @newrelic/apollo-server-plugin. Vous trouverez plus de détails sur l'utilisation @newrelic/apollo-server-plugin ici.

   Important

   Si vous utilisez Next.js, voir cet exemple d'une application Next.js

4. Depuis node_modules/newrelic, copiez newrelic.js dans le répertoire racine de votre application.

5. Configurer l'agent via le fichier newrelic.js ou via la variable d'environnement:

   • Personnalisez le paramètre license_key avec clé de licence.
   • Personnalisez le paramètre app_name avec un ou plusieurs noms d’application significatifs.

6. Ajoutez -r newrelic au script de démarrage de votre application. Par exemple, si le point d'entrée de votre application est ./dist/server.js, vous utiliserez l'indicateur require comme suit :

   bash

   Copier

   $
   node -r newrelic ./dist/server.js

   Un exemple de commande Docker :

   CMD ["node", "-r", "newrelic", "server.js"]

   Copier

   Important

   Pour une application Next.js, chargez notre agent via NODE_OPTIONS:

   CMD ["NODE_OPTIONS='-r newrelic'", "next", "start"]

   Copier

   Si vous utilisez Nest.JS et la commande nest start pour démarrer l'application, modifiez son binaire de démarrage pour charger l'agent New Relic : nest start --exec 'node -r newrelic'. Voici un exemple d'application Nest.js

   Plus d'informations sur l' option de ligne de commande Node.js -r ici.

   Important

   Si vous ne parvenez pas à utiliser l'indicateur requis -r vous pouvez également utiliser require('newrelic') comme première ligne du module principal de votre application. Note Si vous utilisez Babel ou un transpileur similaire, require('newrelic') entraînera des problèmes d'instrumentation.

   Si aucune de ces options ne fonctionne pour vous (par exemple, le chargement asynchrone API clé à partir d'un emplacement distant pendant le démarrage application ), vous pouvez également ajouter instrumentation standard à un module pris en charge déjà chargé en utilisant newrelic.instrumentLoadedModule:

   // module loaded before newrelic
   const expressModule = require('express');
   
   // load the agent
   const newrelic = require('newrelic');
   
   // instrument express after the agent has been loaded
   newrelic.instrumentLoadedModule(
     'express',    // the module's name, as a string
     expressModule // the module instance
   );

   Copier

7. Facultatif : pour obtenir des statistiques supplémentaires au niveau de l'exécution de Node.js, assurez-vous que le package@newrelic/native-metrics est installé.

8. Générez du trafic, puis attendez quelques minutes que les données apparaissent dans l'UI APM.

Vous pouvez personnaliser davantage le comportement de votre agent via newrelic.js ou une variable d'environnement. Pour conserver la configuration de l'agent séparée de votre application, modifiez la variable d'environnementNEW_RELIC_HOME .

Pour plus d'informations, consultez notre documentation API.

Afficher les logs de vos données APM et infrastructure

Vous pouvez également rassembler vos données de log et d' application pour rendre le dépannage plus facile et plus rapide. Avec les logs en contexte, vous pouvez voir les messages de log liés à vos erreurs et les tracer directement dans UI de votre application. Vous pouvez également voir les logs en contexte de vos données infrastructure , telles que le cluster Kubernetes. Pas besoin de passer à une autre page UI .

Maintenez votre agent Node.js à jour

Pour vous assurer que vous disposez de la version la plus récente de New Relic, reportez-vous aux notes de sortieNode.js Le cas échéant, les notes de sortie incluent un lien de téléchargement avec des instructions sur la façon de mettre à jour l'Node.js agent

Dépannage

Après avoir mis à jour l'agent, générez du trafic et attendez quelques minutes. Si aucune donnée n'apparaît dans l'UI New Relic, consultez les procédures de dépannage.