Configuration de la surveillance d' Node.js s via des agents

Si votre application Node.js s'exécute dans un environnement Kubernetes et Red Hat OpenShift, vous pouvez installer le collecteur Instana Node.js automatiquement ou manuellement comme suit :

• Installation automatique du collecteur (méthode recommandée) : pour installer le collecteur automatiquement, procédez comme suit :

  1. Installez le webhook Instana AutoTrace.

     Remarque : si vous prévoyez d'utiliser le SDK Instana Node.js, consultez la section « Utilisation de API avec le webhook AutoTrace ».

  2. Si votre application Node.js et l'agent Instana s'exécutent dans un cluster Kubernetes, configurez l'accès réseau pour les applications surveillées. Pour plus d'informations, consultez la page « Accès au réseau » sur Kubernetes.

• Installation manuelle du collecteur : pour installer le collecteur manuellement, consultez la section « Installation manuelle du collecteur d' Node.js s ». N'utilisez la méthode manuelle que si l'installation automatique n'est pas possible.

Sur les systèmes en lecture seule, les modules complémentaires natifs compilés pour une version prédéfinie d' Node.js peuvent entraîner des problèmes de compatibilité avec d'autres versions d' Node.js. Le collecteur ne peut pas décompresser les fichiers binaires précompilés, ce qui empêche le chargement de certains modules natifs. Par conséquent, certaines mesures, telles que les données relatives au ramasse-miettes et certaines statistiques sur la boucle d'événements, ne sont pas collectées. Toutefois, la fonction de traçage générale n'est pas affectée. Pour plus d'informations, consultez la section consacrée au dépannage.

Pour installer le collecteur Instana Node.js sur Cloud Foundry, sélectionnez l'une des options suivantes :

• Installation automatique du collecteur (recommandée) : pour Tile 1.177.0 et les versions ultérieures, installez le collecteur Node.js à l'aide du buildpack Instana afin d'automatiser la configuration des applications Node.js sur Cloud Foundry.

• Installation manuelle du collecteur : pour installer le collecteur manuellement, consultez la section « Installation manuelle du collecteur d' Node.js s ». N'utilisez la méthode manuelle que si l'installation automatique n'est pas possible.

Pour utiliser le package de collecte « Instana » ( Node.js ) avec Apigee Microgateway (également appelé edgemicro ), suivez les instructions fournies dans la section « Surveillance d'Apigee Microgateway à l'aide du collecteur « Instana » ( Node.js ) ».

Pour utiliser le collecteur Instana Node.js afin de surveiller les applications Next.js, procédez comme suit :

1. Installez le collecteur au niveau global ou local.
2. Utilisez les indicateurs de chargement pour activer le collecteur.

Pour installer le collecteur Instana Node.js, installez le paquet npm@instana/collector dans votre application en exécutant la commande suivante :

npm install --save @instana/collector@latest

Une fois le collecteur installé, activez-le pour configurer la surveillance. Pour plus d'informations, consultez la section « Activer le collecteur d' Node.js s ».

Vous pouvez également installer le collecteur « Node.js » au niveau global en suivant les étapes suivantes :

1. Installez le package @instana/collector sur le système cible:

   • Si vous utilisez npm, exécutez la commande suivante :

     npm install -g @instana/collector@latest
     

   • Si vous utilisez yarn, exécutez la commande suivante:

     yarn global add @instana/collector@latest
     

   Si vous installez le collecteur dans une application conteneurisée, vous pouvez ajouter l'instruction précédente à Dockerfile.

2. Déterminez l'emplacement où le paquet est installé. L'emplacement dépend du système d'exploitation. Pour plus d'informations sur l'emplacement où npm installe les paquets, consultez la documentation d' Node.js relative aux dossiers.

3. Vérifiez que le package @instana/collector avec toutes ses dépendances est disponible sur le système cible dans un emplacement connu, tel que /path/to/instana/node_modules/@instana/collector.

Une fois le collecteur installé, activez-le pour configurer la surveillance. Pour plus d'informations, consultez la section « Activer le collecteur d' Node.js s ».

Pour télécharger manuellement le package compressé précompilé du collecteur Instana Node.js, cliquez sur Téléchargement du collecteur Instana Node.js

Pour configurer la surveillance, activez le collecteur en suivant les instructions de la section « Activer le collecteur d' Node.js s ».

Pour les applications qui utilisent les modules d' CommonJS, activez le collecteur Node.js en suivant l'une des méthodes suivantes :

• Utilisez l'indicateur « --require load » pour l'activation.
• Vous devez inclure et initialiser le collecteur « Node.js » comme première instruction de votre application.

Ces méthodes chargent et initialisent le collecteur d' Node.js s avant le code de votre application.

Si votre application utilise ECMAScript et le @instana/collector collecteur installé en tant que dépendance, vous pouvez activer ce dernier en chargeant le collecteur Instana Node.js à l'aide des indicateurs de chargement Node.js.

Si l'application utilise des modules ECMAScript, effectuez l'une des étapes suivantes lorsque vous démarrez l'exécutable du nœud. La définition NODE_OPTIONS ou l'utilisation de --import l'argument initialise le collecteur d' Node.js s avant le code de l'application. Pour plus d'informations sur les modules ECMAScript, consultez la documentation officielle de l' Node.js.

• Définissez la NODE_OPTIONS variable avant de lancer le processus d'activation d' Node.js :

  Si vous compilez l'application avec l'option « Docker », configurez-la NODE_OPTIONS en ajoutant la ligne suivante à votre Dockerfile fichier (après la dernière FROM instruction et avant le dernier CMD « or ENTRYPOINT » qui lance le node processus) :

  • Utilisez la commande suivante pour importer le collecteur « Instana » (à partir de la version 18.19 de Node.js ) :

    ENV NODE_OPTIONS="--import /path/to/instana/node_modules/@instana/collector/esm-register.mjs"
     

• Vous pouvez également inclure le --import paramètre lors du démarrage de Node.js. Si vous démarrez votre application avec node app/index.js, ajoutez la --import commande à la fin.

  • Utilisez la commande suivante pour importer le collecteur « Instana » (à partir de la version 18.19 de Node.js ) :

    node --import /path/to/instana/node_modules/@instana/collector/esm-register.mjs app/index.js
     

  Le chargeur initialise automatiquement le collecteur Instana Node.js.

Lorsque vous pré-traitez votre application serveur Node.js avec un bundler, tel que Webpack ou Rollup, assurez-vous que vous ne bundlez que votre code et non le code de vos dépendances à partir du dossier " node_modules.

Vous devez exclure les dépendances pour les raisons suivantes:

• Le module @instana/collector ne peut pas être pré-traité avec Webpack. Entre autres problèmes, les instructions require dynamiques utilisées dans votre code ne sont pas résolues correctement.
• Pour instrumenter des bibliothèques tierces, le paquet « npm@instana/collector » intercepte le require processus de « Node.js ». Cependant, si ces bibliothèques ne sont pas chargées au moment de l'exécution, mais sont plutôt intégrées à votre propre code lors de la compilation, aucun require processus n'est exécuté et l'instrumentation n'est pas appliquée. Par conséquent, le traçage d' Instana ne fonctionne pas ou ne fonctionne que partiellement, c'est-à-dire qu'il ne fonctionne que pour les modules principaux d' Node.js, tels que [... http ], car ces modules sont exclus du regroupement par défaut.

Par conséquent, vous devez configurer votre programme de mise en bundle à l'aide du module webpack-node-externals de sorte que tout ce qui se trouve dans node_modules soit exclu de toutes les transformations de code:

// your webpack.config.js:

const nodeExternals = require('webpack-node-externals');

module.exports = {
  ...
  // externals: nodeModules,
  externals: [nodeExternals()],
  ...
};
 

Si vous utilisez l'interface CLI d' Angular, notamment avec Angular Universal ou SSR, vous devez ajouter "externalDependencies": ["@instana/collector"] (et éventuellement d'autres bibliothèques qu'il @instana/collector instrument) à votre angular.json fichier afin de les exclure du regroupement.

Si vous utilisez un transpileur, tel que TypeScript ou Babel, assurez-vous que votre transpileur produit du code CommonJS ou ECMAScript dist.

Initialiser le traceur via les drapeaux de chargement pour CommonJS et ECMAScript.

Pour plus d'informations sur l'accès au SDK dans votre code, voir les modules ECMAScript.