Traitement des incidents liés à Ruby

Pour résoudre ce problème, procédez comme suit

1. Vérifiez que votre environnement est pris en charge et que vous utilisez une version prise en charge d' Ruby.

   Avant de passer trop de temps à diagnostiquer un problème, assurez-vous d'abord que le composant et l'environnement concernés sont pris en charge. Vous trouverez la liste de tous les composants pris en charge dans la section « Versions prises en charge » du site Ruby.

2. Consultez les étapes d'installation.

   Vérifiez que les étapes d'installation ont été correctement suivies.

3. Vérifiez que le gem Instana Ruby est bien installé dans le bundle de l'application.

   Vous pouvez vérifier cela en consultant gem "instana" dans l'application Gemfile et en recherchant les mentions de instana dans le Gemfile.lock fichier. Sinon, à partir du répertoire d'application Ruby, vous pouvez exécuter la commande bundle exec gem list. Cette commande répertorie tous les gemmes d' Ruby s contenus dans le bundle de l'application. Vérifiez que le gem Instana Ruby figure dans cette liste.

4. Assurez-vous que le gem « Instana » est bien à jour.

   La dernière version disponible se trouve sur RubyGems. Dans le fichier Gemfile.lock, vous devez voir la dernière version du gem « Instana » Ruby indiquée à côté du nom, par exemple instana (x.x.x).

5. Vérifiez que la chaîne « Instana » apparaît dans le journal des événements de l'application.

   Les journaux d'application ou de conteneur doivent toujours comporter un message de démarrage similaire à Stan is on the scene. Starting Instana instrumentation version x.x.x

6. Activez la sortie de débogage et vérifiez à nouveau les journaux de l'application ou du conteneur.

   Définissez la variable d'environnement INSTANA_DEBUG=true pour le processus Ruby et vérifiez à nouveau les journaux d'application ou de conteneur (voir l'étape 3). Vérifiez tout particulièrement s'il y a des messages d'erreur liés à Instana.

7. Vérifiez les journaux de l'agent hôte d' Instana. pour voir s'il y a des messages liés à ce processus Ruby.

8. Essayez de lancer l'application « Ruby » en mode détaillé depuis une console.

   Pour en savoir plus, consultez la section « Tests dans votre application ». Vérifiez tout particulièrement si des messages d'erreur liés à l' Instana apparaissent dans la sortie de l'application Ruby.

9. Créez un ticket d'assistance.

   Si vous avez vérifié toutes les étapes précédentes et que le processus « Ruby » n'apparaît toujours pas dans le tableau de bord Instana, ouvrez un ticket d'assistance pour une analyse plus approfondie.

   La demande d'assistance doit comporter :

   1. Détails de l'environnement : plateforme, version d' Ruby, et frameworks utilisés
   2. Résumé de toutes les validations précédentes.

Si votre application Instana Ruby figure dans votre tableau de bord Instana mais qu'aucune trace ne semble provenir de cette application, procédez comme suit :

1. Vérifiez si votre framework d'application est pris en charge.

   Vérifiez que les composants utilisés dans votre application Ruby sont pris en charge.

2. Vérifiez si le ::Instana::Rack middleware est actif.

   Si vous utilisez un framework basé sur Rack, tel qu' Ruby -on-Rails, assurez-vous que le ::Instana::Rack middleware est correctement installé en tant que middleware. Dans des circonstances normales, ce middleware est installé automatiquement pour différentes infrastructures.

   Pour effectuer une validation dans « Ruby » sur Rails, vous pouvez exécuter la commande suivante :

   bundle exec rake middleware
   

   Vous devriez voir une entrée pour ::Instana::Rack. Si vous devez l'installer, vous pouvez le faire manuellement.

3. Vérifiez si vous avez chargé le gem « require => falseInstana » trop tard dans le Gemfile.

   Le chargement tardif du gem Instana Ruby est déconseillé car les processus d'amorçage dans les différentes piles sont souvent stricts et doivent s'effectuer dans un certain ordre. L'un des symptômes courants d'un chargement tardif est l'absence du ::Instana::Rack middleware Rack, qui est chargé de lancer le traçage des requêtes entrantes.

   Si, pour une raison quelconque, vous préférez tout de même charger le gem Instana Ruby en différé, veillez à suivre les instructions du manuel (si nécessaire) concernant l'installation du middleware Rack Instana.

4. Activez la sortie de débogage et vérifiez à nouveau les journaux de l'application ou du conteneur.

   Définissez la variable d'environnement INSTANA_DEBUG=true pour le processus Ruby et vérifiez à nouveau les journaux d'application ou de conteneur (voir l'étape 3). Vérifiez tout particulièrement si des messages d'erreur liés à Instana s'affichent.

5. Depuis une console d'application, générez une trace personnalisée.

   Si tout le reste échoue, vous pouvez ouvrir une console d'application et exécuter la commande suivante pour générer une trace personnalisée :

   require "instana"
   
   Instana.tracer.in_span(:my_custom_trace) do
     sleep 1
   end
   

   Si l'opération aboutit et que la sortie de débogage est activée (comme décrit à l'étape précédente), la ligne suivante doit apparaître dans les journaux de l'application :

   Instana:: Reporting 1 spans
   

   Ensuite, consultez votre tableau de bord Instana (sous « Query Analyze » pour un call.span_type de SDK). Vous devriez voir une trace nommée « my_custom_trace ».

6. Vérifiez les journaux de l'agent hôte d' Instana. pour voir s'il y a des messages liés à ce processus Ruby.

7. Créez un ticket d'assistance.

   Si vous avez vérifié toutes les étapes et que les traces d' Ruby s ne s'affichent toujours pas dans le tableau de bord d' Instana, veuillez ouvrir un ticket d'assistance afin que nous puissions approfondir l'analyse.

   La demande d'assistance doit comporter :

   1. Détails de l'environnement : plateforme, version d' Ruby, et frameworks utilisés
   2. Résumé de toutes les validations précédentes.

Dans les environnements conteneurisés utilisant des processus de type « Ruby », qui recourent à fork comme primitive de concurrence, l'agent peut être surchargé en essayant de suivre les processus nouvellement créés.

1. Assurez-vous que l'agent dispose de ressources suffisantes pour traiter les demandes

   Si vous avez pris des mesures pour limiter la quantité de CPU et de mémoire requise par l'agent, assurez-vous que les limites définies fournissent suffisamment de ressources pour que l'agent puisse mener à bien toutes les tâches qui lui sont confiées.

2. Désactiver la recherche de processus

   Vous pouvez également désactiver un « fast path » pour l'agent en ajoutant ce qui suit à la configuration de l'agent. Cette configuration permet de réduire la consommation de ressources de l'agent, mais peut entraîner la perte de traces si le processus se termine avant d'avoir pu envoyer des données à l'agent. Ce problème se pose généralement dans les applications qui utilisent fork comme primitive de concurrence avec des processus enfants de courte durée.

   com.instana.processlookup:
     enabled: false