Herramienta Sosreport

Estás viendo la documentación de Apigee Edge.
Ve a la Documentación de Apigee X. información

Sosreport es una herramienta de recopilación de datos y diagnóstico a nivel del sistema que se basa en la SoS de software. Puedes usar la herramienta Sosreport para recopilar información que te ayude a depurar problemas en los nodos en los que un se esté ejecutando el componente. La herramienta recopila y almacena información de forma local en el sistema de archivos del nodo.

La herramienta Sosreport recopila detalles de configuración, información del sistema y información de diagnóstico de tu sistema y almacena los datos en un archivo. En el caso de los componentes de Apigee, Sosreport recopila lo siguiente:

  • Es la versión de kernel en ejecución.
  • Módulos cargados
  • Archivos de configuración del sistema y del servicio

Sosreport también ejecuta programas externos para recopilar más información, como

  • Registros de Apigee de todos los componentes.
  • Diagnóstico del entorno de ejecución
  • Diagnósticos de Cassandra recopilados mediante comandos de nodetool.

La herramienta Sosreport contiene dos comandos principales:

  • sosreport: Es el comando principal para recopilar datos y crear informes.
  • apigee-sosreport: Es una herramienta auxiliar que se usa para instalar. sosreport y administra complementos de sosreport específicos de los componentes de Apigee.

Instalación

En esta sección, se explica cómo instalar sosreport.

Si ya está instalada la versión de SoS de sosreport

Si el código original Versión SoS de sosreport ya esté instalada en tu sistema, no configures la versión de Apigee, ya que las rutas de instalación pueden entrar en conflicto. En su lugar, copia los complementos específicos de Apigee del directorio. /opt/apigee/apigee-sosreport/source/plugin al archivo de Python correspondiente site-packages con un comando como los que se muestran a continuación. Por ejemplo, para copiar agigee-mgmt.py:

  • Si usas Python 2, ingresa lo siguiente: 
    sudo cp apigee-mgmt.py /usr/lib/python2.7/site-packages/sos/plugins/
  • Si usas Python 3, ingresa lo siguiente: 
    sudo cp apigee-mgmt.py /usr/local/lib/python3.6/site-packages/sos/plugins/

Para verificar que se hayan instalado los complementos, ingresa

sudo sosreport --list-plugins

Si tienes preguntas, comunícate con el equipo de asistencia de Apigee.

Se está instalando la versión de sosreport de Apigee

Si la versión de SoS de sosreport no es instalada en tu sistema, puedes instalar la versión de Apigee ingresando los siguientes comandos en todos los nodos en los que está instalado Edge para la nube privada: 

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

Para probar que sosreport esté instalado, confirma que los complementos relacionados con Apigee se encuentran en el siguiente directorio:

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

En el ejemplo anterior, pythonx.x es la versión instalada de Python.

Como alternativa, puedes ejecutar uno de los siguientes comandos:

  • Para verificar solo los complementos específicos de Apigee, haz lo siguiente: 
    apigee-service apigee-sosreport diagnose -l

    Esto muestra la siguiente lista de complementos específicos de 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
  • Para verificar todos los complementos, haz lo siguiente: 
    apigee-service apigee-sosreport diagnose -s -l

    Esto muestra la siguiente lista de complementos disponibles con 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→

Cómo crear un informe

Para crear un informe con la herramienta Sosreport, ejecuta el comando sosreport con la opción requerida del complemento (consulta Complementos de Apigee). El El directorio predeterminado en el que se almacena el informe es tmp o /var/tmp. Para cambiar el directorio en el que se almacena el informe, pasa un directorio diferente. a la opción tmp-dir. Por ejemplo, para crear un informe sobre en el servidor de administración y guardarlo en un directorio llamado my_report-dir ingresa una de las siguientes opciones:

  • Con la versión de sosreport de Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf -o apigee-mgmt  --batch --tmp-dir=my_report-dir
  • Usa la versión de SoS de sosreport: 
    sudo sosreport -o apigee-mgmt  --batch --tmp-dir=my_report-dir

El informe se almacenará en un archivo .tar.xz en el directorio que especifiques con el comando Opción tmp-dir. La ubicación del archivo .tar.xz se muestra en STDOUT, así como la suma de verificación. Por ejemplo:

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

El informe se almacenará en un archivo .tar.xz en el directorio que especifiques con el comando Opción tmp-dir. La ubicación de .tar.xz file se muestra en STDOUT, así como el de la suma de comprobación. Por ejemplo:

Para obtener más opciones disponibles para sosreport, lee el archivo man:

sudo man sosreport

Complementos de Apigee

En las siguientes secciones, se describen los complementos de Apigee para la herramienta Sosreport para los siguientes componentes:

Servidor de administración

El complemento apigee-mgmt recopila la siguiente información del Servidor de administración:

  • nombre de host del servidor (predeterminado)
  • cpuinfo (predeterminado)
  • meminfo (predeterminado)
  • la configuración de la máquina virtual de Java (JVM), como la memoria, Djdk.tls.allowUnsafeServerCertChange, y así sucesivamente (predeterminado)
  • Registros de administración actual (predeterminado)
  • Diez salidas secuenciales de Top y jstack (predeterminado)
  • Carpeta de registro de administración completa (opcional)
  • config-files (opcional)

Ejemplos:

Para recopilar todos los elementos predeterminados, ingresa una de las siguientes opciones:

  • Con la versión de sosreport de Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch my_report-dir
  • Usa la versión de SoS de sosreport: 
    sudo sosreport -o apigee-mgmt --batch my_report-dir

Para recopilar todos los elementos predeterminados y los elementos opcionales especificados en el comando, por Por ejemplo, archivos de configuración y todos los registros, ingresa una de las siguientes opciones:

  • Con la versión de sosreport de Apigee: 
    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
  • Usa la versión de SoS de sosreport: 
    sudo sosreport -o apigee-mgmt --batch -k apigee-mgmt.config-files -k apigee-mgmt.all-logs

Para recopilar todo, ingresa una de las siguientes opciones:

  • Con la versión de sosreport de Apigee: 
    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

    También puedes ingresar:

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

    También puedes ingresar:

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

Message Processor

El complemento apigee-mp recopila la siguiente información del Procesador de administración (MP):

  • Nombre de host del servidor (predeterminado)
  • cpuinfo (predeterminado)
  • meminfo (predeterminado)
  • información de buildinfo/release (predeterminado)
  • Estado de apigee-all (predeterminado)
  • detalles del servidor (predeterminado)
  • La configuración de nivel de JVM, por ejemplo, memoria, Djdk.tls.allowUnsafeServerCertChange, etc. (predeterminado)
  • Registros MP actuales (predeterminado)
  • Diez resultados secuenciales de arriba, jstacks y NIO Metrics (predeterminado)
  • Toda la carpeta de registro de MP (opcional)
  • Árbol de clasificación (opcional)
  • Volcado de montón (opcional)
  • config-files (opcional)
  • Seguimiento del tiempo de ejecución (opcional y solo cuando org:env:api:rev detail de la aplicación). Nota: El complemento espera 25 segundos para recopilar las solicitudes del tiempo de ejecución.

Ejemplos:

Para recopilar todos los elementos predeterminados, ingresa una de las siguientes opciones:

  • Con la versión de sosreport de Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch
  • Usa la versión de SoS de sosreport: 
    sudo sosreport -o apigee-mp --batch

También puedes especificar elementos opcionales adicionales para recopilar, además de todos los elementos predeterminados. Por ejemplo, para especificar el volcado de montón con la función experimental -k apigee-mp.heap, ingresa una de las siguientes opciones:

  • Con la versión de sosreport de Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -k apigee-mp.heap
  • Usa la versión de SoS de sosreport: 
    sudo sosreport -o apigee-mp --batch -k apigee-mp.heap

Del mismo modo, puedes especificar los siguientes elementos opcionales:

-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

Puedes especificar varias opciones en un solo comando. Por ejemplo:

  • Con la versión de sosreport de Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -k apigee-mp.deployments -k apigee-mp.all-logs
  • Usa la versión de SoS de sosreport: 
    sudo sosreport -o apigee-mp --batch -k apigee-mp.deployments -k apigee-mp.all-logs

Para recopilar todo, excepto el seguimiento, ingresa una de las siguientes opciones:

  • Con la versión de sosreport de Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -a
  • Usa la versión de SoS de sosreport: 
    sudo sosreport -o apigee-mp --batch -a

Router

El complemento apigee-rrt recopila la siguiente información del Router:

  • Nombre de host del servidor (predeterminado)
  • cpuinfo (predeterminado)
  • meminfo (predeterminado)
  • información de buildinfo/release (predeterminado)
  • Estado de apigee-all (predeterminado)
  • detalles del servidor (predeterminado)
  • el resultado del archivo ps. Esto proporcionará la configuración del nivel de JVM, por ejemplo, Djdk.tls.allowUnsafeServerCertChange, etcétera (predeterminado).
  • Registros del router actuales (predeterminado)
  • Lista de nombres de archivos vhost, incluidos los nombres de archivos incorrectos (predeterminado)
  • Carpeta de registro del router completa (opcional)
  • config-files (opcional)

Ejemplos:

Para recopilar todos los elementos predeterminados, ingresa una de las siguientes opciones:

  • Con la versión de sosreport de Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch
  • Usa la versión de SoS de sosreport: 
    sudo sosreport -o apigee-rrt --batch

También puedes especificar elementos opcionales adicionales para recopilar, además de todos los elementos predeterminados. Por ejemplo, para especificar toda la carpeta de registros, usa la marca -k apigee-rrt.all-logs, ingresa una de las siguientes opciones:

  • Con la versión de sosreport de Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -k apigee-rrt.all-logs
  • Usa la versión de SoS de sosreport: 
    sudo sosreport -o apigee-rrt --batch -k apigee-rrt.all-logs

Del mismo modo, puedes especificar los siguientes elementos opcionales:

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

Para recopilar todo, sigue estos pasos:

  • Con la versión de sosreport de Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -a
  • Usa la versión de SoS de sosreport: 
    sudo sosreport -o apigee-rrt --batch -a

Cassandra

El complemento apigee-cassandra recopila la siguiente información de Nodos de Cassandra:

  • Estadísticas de la máquina: 
    "hostname -i"
"cat /proc/cpuinfo"
"cat /proc/meminfo"
"ulimit -a"
"ps auxw"
"df -kh"
"du -sh"
"netstat -ntlpu"
"free -h"
"ifconfig -h"
"ps -ef"
  • Estado y versión del componente de Apigee Versión de Apigee-all Estado de apigee-all
  • Registros de apigee-cassandra: Todos los archivos en /opt/apigee/var/log/apigee-cassandra/
  • Recuento de registros de confirmación
  • Resultado del comando en la parte superior
  • Volcado de subprocesos
  • Archivos de configuración: cassandra-topology.properties, cassandra.yaml, cassandra-env.sh
  • Nodetool salida para los siguientes parámetros: version, status, ring, info, gossipinfo, compactionstats: H, tpstats, netstats, cfstats, proxyhistogramas

Ejemplo:

Para recopilar todos los elementos predeterminados, ingresa una de las siguientes opciones:

  • Con la versión de sosreport de Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-cassandra
  • Usa la versión de SoS de sosreport: 
    sudo sosreport -o apigee-cassandra