Outil Sosreport

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X. En savoir plus

Sosreport est un outil de diagnostic et de collecte de données système, basé sur l'Open Source logiciel SoS. Vous pouvez utiliser l'outil Sosreport pour collecter des informations qui vous aideront à résoudre les problèmes dans les nœuds où un service Apigee est en cours d'exécution. L'outil collecte et stocke les informations localement sur le système de fichiers du nœud.

L'outil Sosreport collecte les détails de configuration, les informations système informations de diagnostic de votre système et stocke les données dans une archive. Pour les composants Apigee, Sosreport collecte les éléments suivants:

  • Version du noyau en cours d'exécution
  • Modules chargés
  • Fichiers de configuration du système et des services

Sosreport exécute également des programmes externes telles que:

  • les journaux Apigee de tous les composants.
  • Diagnostics d'exécution
  • Diagnostics Cassandra collectés à l'aide des commandes nodetool.

L'outil Sosreport contient deux commandes principales:

  • sosreport: commande principale pour collecter des données et créer des rapports.
  • apigee-sosreport: outil auxiliaire utilisé pour installer sosreport et gérer les plug-ins sosreport spécifiques aux composants Apigee.

Installation

Cette section explique comment installer sosreport.

Si la version SoS de sosreport est déjà installée

Si l'original Version SoS de sosreport est déjà installé sur votre système, Ne configurez pas la version d'Apigee, car les chemins d'installation risquent d'entrer en conflit. Copiez plutôt les plug-ins spécifiques à Apigee à partir du répertoire /opt/apigee/apigee-sosreport/source/plugin vers le fichier Python approprié site-packages à l'aide d'une commande semblable à celles présentées ci-dessous. Par exemple, pour copier agigee-mgmt.py:

  • Si vous utilisez Python 2, saisissez la commande suivante: 
    sudo cp apigee-mgmt.py /usr/lib/python2.7/site-packages/sos/plugins/
  • Si vous utilisez Python 3, saisissez la commande suivante: 
    sudo cp apigee-mgmt.py /usr/local/lib/python3.6/site-packages/sos/plugins/

Pour vérifier que les plug-ins ont été installés, saisissez

sudo sosreport --list-plugins

Si vous avez des questions, contactez l'assistance Apigee.

Installation de la version Apigee de sosreport...

Si la version SoS de sosreport n'est pas déjà installé sur votre système, vous pouvez installer la version d'Apigee en saisissant les commandes suivantes sur tous les nœuds où Edge pour Private Cloud est installé: 

/opt/apigee/apigee-service/bin/apigee-service apigee-sosreport install
/opt/apigee/apigee-service/bin/apigee-service apigee-sosreport setup

Pour vérifier que sosreport est installé, vérifiez que les plug-ins liés à Apigee se trouve dans le répertoire suivant:

/usr/lib/pythonx.x/site-packages/sos/plugins

où pythonx.x est votre version installée de Python.

Vous pouvez également exécuter l'une des commandes suivantes:

  • Pour vérifier uniquement les plug-ins spécifiques à Apigee: 
    apigee-service apigee-sosreport diagnose -l

    Cette commande renvoie la liste suivante de plug-ins spécifiques à Apigee.

    sosreport (version 3.9)

The following plugins are currently enabled:

apigee-mgmt          This is the apigee plugin for edge-management-server
apigee-mp            This is the apigee plugin for edge-message-processor
apigee-rrt           This is the apigee plugin for edge-router
apigee-sample        Main diagnostics gatehring class
  • Pour vérifier tous les plug-ins: 
    apigee-service apigee-sosreport diagnose -s -l

    Cette commande renvoie la liste suivante des plug-ins disponibles avec sosreport:

    sosreport (version 3.9)

The following plugins are currently enabled:

 acpid                ACPI daemon information
 alternatives         System alternatives
 anacron              Anacron job scheduling service
 apigee-cassandra     This is the base class for sosreport plugins. Plugins should subclass
    this and set the class variables where applicable. ←truncated→
 apigee-mgmt          This is the base class for sosreport plugins. Plugins should subclass
    this and set the class variables where applicable. ←truncated→
 apigee-mp            Main diagnostics gathering class
 apigee-rrt           This is the base class for sosreport plugins. Plugins should subclass
    this and set the class variables where applicable. ←truncated→

………………………………………………….
………………………………………………….
………………………………………………….
←truncated→

Création d'un rapport

Pour créer un rapport à l'aide de l'outil Sosreport, exécutez la commande sosreport. avec l'option de plug-in requise (voir Plug-ins Apigee). La le répertoire par défaut dans lequel le rapport est stocké est tmp ou /var/tmp. Vous pouvez modifier le répertoire dans lequel le rapport est stocké en transmettant un autre répertoire à l'option tmp-dir. Par exemple, pour créer un rapport sur le serveur de gestion et enregistrez-le dans un répertoire nommé my_report-dir, saisissez l'une des valeurs suivantes:

  • Avec la version d'Apigee de sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf -o apigee-mgmt  --batch --tmp-dir=my_report-dir
  • En utilisant la version SoS de sosreport: 
    sudo sosreport -o apigee-mgmt  --batch --tmp-dir=my_report-dir

Le rapport est stocké dans un fichier .tar.xz du répertoire que vous spécifiez à l'aide de la propriété tmp-dir. L'emplacement du fichier .tar.xz et la somme de contrôle sont indiqués sur STDOUT. Exemple :

Your sosreport has been generated and saved in:
 /var/sosreport-prc-test-0-9613-2021-07-12-orwxufx.tar.xz
The checksum is: 5a8b97c6020346a688254c8b04ef86ec
For more available options for sosreport, read the man file:
sudo man sosreport

Le rapport est stocké dans un fichier .tar.xz du répertoire que vous spécifiez à l'aide de la propriété tmp-dir. L'emplacement de .tar.xz file est affiché sur STDOUT, ainsi que la somme de contrôle. Exemple :

Pour connaître les autres options disponibles pour sosreport, consultez le fichier man:

sudo man sosreport

Plug-ins Apigee

Les sections suivantes décrivent les plug-ins Apigee à l'outil Sosreport pour les composants suivants:

Serveur de gestion

Le plug-in apigee-mgmt collecte les informations suivantes à partir du Serveur de gestion:

  • nom d'hôte du serveur (par défaut)
  • cpuinfo (par défaut)
  • meminfo (par défaut)
  • Les paramètres de machine virtuelle (JVM) Java, tels que la mémoire, Djdk.tls.allowUnsafeServerCertChange, etc. (par défaut)
  • Journaux de gestion actuels (par défaut)
  • Dix sorties séquentielles "top" et "jstacks" (par défaut)
  • Tout le dossier du journal de gestion (facultatif)
  • config-files (facultatif)

Exemples :

Pour collecter tous les éléments par défaut, saisissez l'une des valeurs suivantes:

  • Avec la version d'Apigee de sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch my_report-dir
  • Avec la version SoS de sosreport: 
    sudo sosreport -o apigee-mgmt --batch my_report-dir

Pour collecter tous les éléments par défaut, ainsi que les éléments facultatifs spécifiés dans la commande, pour (par exemple, les fichiers de configuration et tous les journaux), saisissez l'un des éléments suivants:

  • Avec la version d'Apigee de sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch -k apigee-mgmt.config-files -k apigee-mgmt.all-logs
  • Avec la version SoS de sosreport: 
    sudo sosreport -o apigee-mgmt --batch -k apigee-mgmt.config-files -k apigee-mgmt.all-logs

Pour tout collecter, saisissez l'un des éléments suivants:

  • Avec la version d'Apigee de sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch -k apigee-mgmt.config-files -k apigee-mgmt.all-logs

    Vous pouvez également saisir:

    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch -a
  • Avec la version SoS de sosreport: 
    sudo sosreport -o apigee-mgmt --batch -k apigee-mgmt.config-files -k apigee-mgmt.all-logs

    Vous pouvez également saisir:

    sudo sosreport -o apigee-mgmt --batch -a

Processeur de messages

Le plug-in apigee-mp collecte les informations suivantes à partir du Processeur de gestion (MP):

  • Nom d'hôte du serveur (par défaut)
  • cpuinfo (par défaut)
  • meminfo (par défaut)
  • informations sur la compilation/la version (par défaut)
  • État de apigee-all (par défaut)
  • informations sur le serveur (par défaut)
  • Les paramètres au niveau de la JVM (par exemple, la mémoire, Djdk.tls.allowUnsafeServerCertChange) etc. (par défaut)
  • Journaux MP actuels (par défaut)
  • Sortie séquentielle : top, jstacks et métriques NIO (par défaut)
  • Tout le dossier journal du MP (facultatif)
  • Arborescence de classification (facultatif)
  • Empreinte de la mémoire (facultatif)
  • config-files (facultatif)
  • Trace de l'environnement d'exécution (facultatif et uniquement lorsque org:env:api:rev detail) est fournie). Remarque: Le plug-in attend 25 secondes pour collecter les requêtes d'exécution.

Exemples :

Pour collecter tous les éléments par défaut, saisissez l'une des valeurs suivantes:

  • Avec la version d'Apigee de sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch
  • Avec la version SoS de sosreport: 
    sudo sosreport -o apigee-mp --batch

Vous pouvez également indiquer d'autres articles facultatifs à collecter, en plus de tous les objets par défaut. Par exemple, pour spécifier l'empreinte de la mémoire, utilisez l'option -k apigee-mp.heap, saisissez l'un des éléments suivants:

  • Avec la version d'Apigee de sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -k apigee-mp.heap
  • Avec la version SoS de sosreport: 
    sudo sosreport -o apigee-mp --batch -k apigee-mp.heap

De même, vous pouvez spécifier les éléments facultatifs suivants:

-k apigee-mp.deployments
-k apigee-mp.heap
-k apigee-mp.all-logs
-k apigee-mp.config-files
-k apigee-mp.trace=gsc-cps:test:httpbin:3

Vous pouvez spécifier plusieurs options dans une seule commande. Exemple :

  • Avec la version d'Apigee de sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -k apigee-mp.deployments -k apigee-mp.all-logs
  • Avec la version SoS de sosreport: 
    sudo sosreport -o apigee-mp --batch -k apigee-mp.deployments -k apigee-mp.all-logs

Pour tout collecter à l'exception des traces, saisissez l'une des valeurs suivantes:

  • Avec la version d'Apigee de sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -a
  • Avec la version SoS de sosreport: 
    sudo sosreport -o apigee-mp --batch -a

Routeur

Le plug-in apigee-rrt collecte les informations suivantes à partir du Routeur:

  • Nom d'hôte du serveur (par défaut)
  • cpuinfo (par défaut)
  • meminfo (par défaut)
  • informations sur la compilation/la version (par défaut)
  • État de apigee-all (par défaut)
  • informations sur le serveur (par défaut)
  • sortie ps. Vous obtenez ainsi des paramètres au niveau de la JVM, par exemple mémoire, Djdk.tls.allowUnsafeServerCertChange, etc. (par défaut).
  • Journaux du routeur actuel (par défaut)
  • Liste des noms de fichiers vhost, y compris des noms de fichiers incorrects (par défaut)
  • Dossier de journaux du routeur entier (facultatif)
  • config-files (facultatif)

Exemples :

Pour collecter tous les éléments par défaut, saisissez l'une des valeurs suivantes:

  • Avec la version d'Apigee de sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch
  • Avec la version SoS de sosreport: 
    sudo sosreport -o apigee-rrt --batch

Vous pouvez également indiquer d'autres articles facultatifs à collecter, en plus de tous les objets par défaut. Par exemple, pour spécifier l'intégralité du dossier de journaux, à l'aide de l'option -k apigee-rrt.all-logs, saisissez l'un des éléments suivants:

  • Avec la version d'Apigee de sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -k apigee-rrt.all-logs
  • Avec la version SoS de sosreport: 
    sudo sosreport -o apigee-rrt --batch -k apigee-rrt.all-logs

De même, vous pouvez spécifier les éléments facultatifs suivants:

-k apigee-rrt.all-logs
-k apigee-rrt.config-files

Pour tout collecter:

  • Avec la version d'Apigee de sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -a
  • Avec la version SoS de sosreport: 
    sudo sosreport -o apigee-rrt --batch -a

Cassandra

Le plug-in apigee-cassandra collecte les informations suivantes à partir de : Nœuds Cassandra:

  • Statistiques relatives à la machine: 
    "hostname -i"
"cat /proc/cpuinfo"
"cat /proc/meminfo"
"ulimit -a"
"ps auxw"
"df -kh"
"du -sh"
"netstat -ntlpu"
"free -h"
"ifconfig -h"
"ps -ef"
  • État et version du composant Apigee version apigee-all && état de apigee-all
  • Journaux apigee-cassandra: Tous les fichiers associés à /opt/apigee/var/log/apigee-cassandra/
  • Valider le nombre de journaux
  • Résultat de la commande Top
  • Vidage de thread
  • Fichiers de configuration: cassandra-topology.properties, cassandra.yaml, cassandra-env.sh
  • Résultat Nodetool pour les paramètres suivants: version, status, ring, info, gossipinfo compactionstats -H, tpstats, netstats, cfstats, proxyhistograms

Exemple :

Pour collecter tous les éléments par défaut, saisissez l'une des valeurs suivantes:

  • Avec la version d'Apigee de sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-cassandra
  • Avec la version SoS de sosreport: 
    sudo sosreport -o apigee-cassandra