Herramienta Sosreport

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

Sosreport es una herramienta de diagnóstico y recopilación de datos a nivel del sistema, basada en el software de código abierto SoS. Puedes usar la herramienta Sosreport para recopilar información que te ayude a depurar problemas en los nodos en los que se ejecuta un componente de Apigee. 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 datos 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:

  • La versión del 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 la siguiente:

  • Registros de Apigee de todos los componentes.
  • Diagnóstico del entorno de ejecución
  • Diagnósticos de Cassandra recopilados con los 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 administrar complementos de sosreport específicos de los componentes de Apigee.

Instalación

En la siguiente tabla, se detalla la disponibilidad y el método de instalación de la herramienta Sosreport en las versiones compatibles de Edge para la nube privada.

Versión de OPDK Instalación nueva Actualización in situ
4.50.00.11 a 4.52.01.00 Se requiere instalación manual Se requiere instalación manual
4.52.01.01+ Instalada de forma predeterminada Se requiere una actualización manual
Amazon Linux 2023 o versiones posteriores No compatible No compatible

La herramienta Sosreport viene instalada de forma predeterminada en todos los nodos cuando se realiza una instalación nueva de Edge para la nube privada 4.52.01.01 y versiones posteriores.

Si realizas una actualización local a Edge para Private Cloud 4.52.01.01 o una versión posterior, ejecuta el siguiente comando en cada nodo para actualizar la herramienta Sosreport:

/opt/apigee/apigee-service/bin/apigee-service apigee-sosreport update

Puedes ejecutar el siguiente comando para verificar la instalación y la versión de la herramienta Sosreport y sus complementos:

apigee-service apigee-sosreport version

Para enumerar todos los complementos que admiten la herramienta Sosreport, usa el siguiente comando:

sudo sosreport --list-plugins

Para enumerar solo los complementos específicos de Apigee, ejecuta el siguiente comando:

sudo sosreport --list-plugins | grep apigee

En las versiones de Edge para nubes privadas de la 4.50.00.11 a la 4.52.01.00, la herramienta Sosreport está disponible, pero es posible que requiera una configuración manual según tu entorno.

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

Si la versión original de 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 directorio de Python site-packages adecuado con un comando como los que se muestran a continuación. Por ejemplo, para copiar apigee-mgmt.py, haz lo siguiente:

  • 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.

En la siguiente sección, se explica cómo instalar `sosreport` para las versiones de la 4.50.00.11 a la 4.52.01.00.

Instala la versión de Apigee de sosreport

Si la versión de SoS de sosreport aún no está 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 encuentren en el siguiente directorio:

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

donde pythonx.x es la versión de Python que instalaste.

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 devuelve 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 gathering class
  • Para verificar todos los complementos, haz lo siguiente: 
    apigee-service apigee-sosreport diagnose -s -l

    Esto devuelve 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

Versiones 4.52.01.01 y posteriores de Edge para la nube privada

La herramienta Sosreport puede detectar los componentes existentes en tu nodo y generar un informe de todos los registros que necesitan los equipos de asistencia al cliente para realizar el análisis.

Para generar un informe, usa el siguiente comando:

apigee-service apigee-sosreport diagnose

Si es necesario, puedes agregar las siguientes marcas:

  • -f | --file | --config : Ruta de acceso al archivo de configuración que se usa durante la configuración. 
    Example: apigee-service apigee-sosreport diagnose -f /path/to/configuration.file
  • -o | --output : Para redireccionar el sosreport generado a un directorio o una ruta de acceso específicos 
    Example: apigee-service apigee-sosreport diagnose -o /path/to/output_directory/

Versiones de Edge para la nube privada de la 4.50.00.11 a la 4.52.01.00

Para crear un informe con la herramienta Sosreport, ejecuta el comando sosreport con la opción de complemento requerida (consulta Complementos de Apigee). 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 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, haz lo siguiente: 
    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 almacena en un archivo .tar.xz en el directorio que especifiques con la opción tmp-dir. La ubicación del archivo .tar.xz se muestra en STDOUT, así como la suma de comprobació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 almacena en un archivo .tar.xz en el directorio que especifiques con la opción tmp-dir. La ubicación del .tar.xz file se muestra en STDOUT, así como la suma de comprobación. Por ejemplo:

Para ver 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 de 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)
  • Configuración de la máquina virtual Java (JVM), como la memoria, Djdk.tls.allowUnsafeServerCertChange, etcétera (predeterminada)
  • Registros de administración actuales (predeterminados)
  • Diez resultados secuenciales de top y jstack (predeterminado)
  • Toda la carpeta de registros de administración (opcional)
  • config-files (opcional)

Ejemplos:

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

  • Usa la versión de Apigee de sosreport: 
    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 también los opcionales especificados en el comando, por ejemplo, los archivos de configuración y todos los registros, ingresa una de las siguientes opciones:

  • Usa la versión de 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
  • Cómo usar 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:

  • Usa la versión de 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

    Como alternativa, puedes ingresar lo siguiente:

    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

    Como alternativa, puedes ingresar lo siguiente:

    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)
  • buildinfo/release info (predeterminado)
  • Estado de apigee-all (predeterminado)
  • detalles del servidor (predeterminado)
  • Configuración a nivel de la JVM, por ejemplo, memoria, Djdk.tls.allowUnsafeServerCertChange, etc. (predeterminado)
  • Registros de MP actuales (predeterminados)
  • Diez resultados secuenciales de top, jstacks y métricas de NIO (predeterminado)
  • Carpeta de registro completa de MP (opcional)
  • Árbol de clasificación (opcional)
  • Volcado de montón (opcional)
  • config-files (opcional)
  • Seguimiento del entorno de ejecución (opcional y solo cuando se proporciona org:env:api:rev detail). Nota: El complemento espera 25 segundos para recopilar las solicitudes de tiempo de ejecución.

Ejemplos:

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

  • Usa la versión de Apigee de sosreport: 
    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 marca -k apigee-mp.heap, ingresa una de las siguientes opciones:

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

De manera similar, 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:

  • Usa la versión de 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
  • Cómo usar 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:

  • Usa la versión de Apigee de sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -a
  • Cómo usar 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)
  • buildinfo/release info (predeterminado)
  • Estado de apigee-all (predeterminado)
  • detalles del servidor (predeterminado)
  • Resultado de ps. Esto proporcionará la configuración a nivel de JVM, por ejemplo, memoria, Djdk.tls.allowUnsafeServerCertChange, etcétera (predeterminado).
  • Registros actuales del router (predeterminado)
  • Lista de nombres de archivos de vhost, incluidos los nombres de archivos incorrectos (predeterminado)
  • Carpeta completa de registros del router (opcional)
  • config-files (opcional)

Ejemplos:

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

  • Usa la versión de Apigee de sosreport: 
    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 la carpeta de registro completa, usa la marca -k apigee-rrt.all-logs y, luego, ingresa una de las siguientes opciones:

  • Con la versión de sosreport de Apigee, haz lo siguiente: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -k apigee-rrt.all-logs
  • Cómo usar la versión de SoS de sosreport: 
    sudo sosreport -o apigee-rrt --batch -k apigee-rrt.all-logs

De manera similar, puedes especificar los siguientes elementos opcionales:

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

Para recopilar todo, haz lo siguiente:

  • Usa la versión de Apigee de sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -a
  • Cómo usar 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 los 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 y 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 Top
  • Volcado de subprocesos
  • Archivos de configuración: cassandra-topology.properties, cassandra.yaml, cassandra-env.sh
  • Salida de Nodetool para los siguientes parámetros: version, status, ring, info, gossipinfo, compactionstats -H, tpstats, netstats, cfstats, proxyhistograms

Ejemplo:

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

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