Prácticas recomendadas para casos de ayuda de Apigee de Google Cloud

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

Estás viendo la documentación de Apigee X.
Consulta la documentación de Apigee Edge.

Proporcionar la información necesaria de forma detallada en el caso de ayuda permite que el equipo de asistencia al cliente de Apigee de Google Cloud responda con rapidez y de forma eficiente. Si a tu caso de ayuda le faltan detalles fundamentales, tendremos que pedirte más información, lo que puede generar una cadena de interacción con muchas respuestas. Esto lleva más tiempo y puede generar demoras en la resolución de problemas. Esta guía de prácticas recomendadas te permite conocer la información que necesitamos para resolver tu caso de ayuda técnica con mayor rapidez.

Describe el problema

Un problema debe contener información que explique los detalles sobre lo que sucedió en relación con lo que se esperaba que sucediera, además de cuándo y cómo ocurrió. Un buen caso de ayuda de Apigee debe contener la siguiente información clave para cada uno de los productos de Apigee:

Información de clave Descripción Apigee Edge para la nube pública Apigee Edge para la nube privada
Producto Producto específico de Apigee en el que se observa el problema, incluye la información de la versión cuando corresponda.
  • Versión
Detalles del problema Descripción clara y detallada de la descripción del problema, incluido el mensaje de error completo, si corresponde.
  • Mensaje de error
  • Resultado de la herramienta de Trace
  • Pasos para reproducir un problema
  • Solicitud a la API/comando completos
  • Mensaje de error
  • Resultado de la herramienta de Trace
  • Pasos para reproducir un problema
  • Solicitud a la API/comando completos
  • Registros de diagnóstico de componentes
Hora La marca de tiempo específica del momento en que comenzó el problema y su duración
  • Fecha, hora y zona horaria en que ocurrió el problema
  • Duración del problema
  • Fecha, hora y zona horaria en que ocurrió el problema
  • Duración del problema
Configuración Información detallada sobre el lugar en el que se observa el problema.
  • Nombre de la organización
  • Nombre del entorno
  • Nombre del proxy de API
  • Revisión
  • Topología de la red
  • Componente Edge que falla

Las siguientes secciones describen estos conceptos en mayor detalle.

Producto

Existen diferentes productos de Apigee, Apigee Edge en la nube pública y Apigee Edge en la nube privada, por lo que necesitamos información específica sobre qué producto en particular es el que tiene el problema.

En la siguiente tabla, se proporcionan algunos ejemplos que muestran información completa en la columna CORRECTO, e información incompleta en la columna INCORRECTO:

CORRECTO INCORRECTO
La implementación del proxy de API OAuth2 falló en nuestra organización de nube pública …

No se pudo implementar el proxy de API.

(Debemos conocer el producto de Apigee en el que tiene el problema).

La instalación falló con el siguiente error en nuestra Versión de nube privada Edge 4.50.00 …

La instalación falló en nuestra configuración de nube privada.

(Falta la información de la versión)

Detalles del problema

Proporciona la información precisa sobre el problema que se observa, incluido el mensaje de error (si corresponde), así como el comportamiento esperado y el real que se puede observar.

En la siguiente tabla, se proporcionan algunos ejemplos que muestran información completa en la columna CORRECTO, e información incompleta en la columna INCORRECTO:

CORRECTO INCORRECTO

El nuevo proxy edgemicro edgemicro_auth falla con el siguiente error:

{"error":"missing_authorization","error_description":"Missing Authorization header"}

El nuevo proxy edgemicro que se creó hoy no funciona

(No se conoce el nombre del proxy. No está claro si el proxy muestra un error o una respuesta inesperada).

Nuestros clientes reciben errores 500 con el siguiente mensaje de error mientras realizan solicitudes al proxy de API:

{"fault":{"faultstring":"Execution of JSReadResponse failed with error: Javascript runtime error: \"TypeError: Cannot read property \"content\" from undefined. (JSReadResponse.js:23)","detail":{"errorcode":"steps.javascript.ScriptExecutionFailed"}}}

Nuestros clientes reciben errores 500 a la vez que realizan solicitudes al proxy de API.

(Si solo indicas el error 500, no proporcionas la información adecuada para que investiguemos el problema. Necesitamos conocer el mensaje de error real y el código de error que se está observando).

Tiempo

El tiempo es un dato fundamental. Es importante que el ingeniero de asistencia sepa cuándo se detectó por primera vez este problema, cuánto tiempo duró y si el problema continúa.

Es posible que el ingeniero de asistencia que resuelva el problema no esté en tu zona horaria, por lo que las declaraciones relativas sobre el tiempo hacen que el problema sea más difícil de diagnosticar. Por lo tanto, se recomienda usar el formato ISO 8601 para las marcas de fecha y hora a fin de proporcionar la información exacta sobre la fecha en la que se observó el problema.

En la siguiente tabla, se proporcionan algunos ejemplos precisos que muestran la hora y duración en las que se produjo el problema en la columna CORRECTO y la información ambigua o poco clara sobre cuándo ocurrió el problema en la columna INCORRECTO:

CORRECTO INCORRECTO
Una gran cantidad de 503s se detectó ayer entre el 2020-11-06 17:30 PDT y el 2020-11-06 17:35 PDT…

Una gran cantidad de 503s se observó ayer a las 5:30 p.m. durante 5 minutos.

(Nos vemos obligados a usar la fecha implícita y no está claro en qué zona horaria se observó este problema).

Se observaron latencias altas en los siguientes proxies de API desde 2020-11-09 15:30 IST hasta 2020-11-09 18:10 IST …

Se observaron latencias altas en algunos proxies de API la semana pasada.

(No está claro qué día ni por cuánto tiempo se observó este problema durante la última semana).

Configuración

Necesitamos conocer los detalles sobre el lugar exacto en el que detectaste el problema. Según el producto que uses, necesitamos la siguiente información:

  • Si usas Apigee Cloud, es posible que tengas más de una organización. Por lo tanto, necesitamos conocer la organización específica y otros detalles en los que observas el problema:
    • Nombres de organizaciones y entornos
    • Nombre del proxy de API y números de revisión (para los errores de solicitudes a la API)
  • Si usas la nube privada , es posible que estés usando una de las diversas topologías de instalación compatibles. Por lo tanto, necesitamos saber qué topología estás usando, incluidos detalles, como la cantidad de centros de datos y de nodos.

En la siguiente tabla, se proporcionan algunos ejemplos que muestran información completa en la columna CORRECTO, e información incompleta en la columna INCORRECTO:

CORRECTO INCORRECTO

Los errores 401 aumentaron en la nube pública Edge desde 2020-11-06 09:30 CST.

Detalles de configuración de Edge:

Los detalles de la API con errores son los siguientes:
Nombres de la organización: myorg
Nombres de entornos: test
Nombres de proxy de API: myproxy
Números de revisión: 3

Error:

{"fault":{"faultstring":"Failed to resolve API Key variable request.header.X-APP-API_KEY","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

Los errores 401 aumentaron.

(No proporciona información sobre el producto que se usa, por el momento en que se observa el problema o cualquier detalle de configuración).

No se puede iniciar Message Processor en la nube privada Edge versión 4.19.06, después de agregar nodos de puerta de enlace adicionales.

Registros de diagnóstico:
Adjuntó los registros del Message Processor.

Topología de red:
Adjuntó el archivo network-topology.png que contiene los nodos adicionales.

No se puede iniciar Message Processor en la nube privada Edge versión 4.19.06, después de agregar nodos de puerta de enlace adicionales.

(Los registros del Message Processor y la topología de la red no se encuentran).

Artefactos útiles

Si nos proporcionas artefactos relacionados con el problema, se acelerará la resolución, ya que nos ayudará a comprender el comportamiento exacto que estás observando y podrás obtener más estadísticas.

En esta sección, se describen algunos artefactos útiles que te serán de ayuda para todos los productos de Apigee:

Artefactos comunes de todos los productos de Apigee

Los siguientes artefactos son útiles para todos los productos de Apigee: Apigee Edge en la nube pública y Apigee Edge en la nube privada:

Artefacto Descripción
Resultado de la herramienta de Trace El resultado de la herramienta de Trace contiene información detallada sobre las solicitudes a la API que fluyen a través de los productos de Apigee. Esto es útil para cualquier error de entorno de ejecución, como 4XX, 5XX y problemas de latencia.
Capturas de pantalla Las capturas de pantalla ayudan a transmitir el contexto del comportamiento o el error reales que se observan. Es útil para los errores o problemas observables, como en la IU o Analytics.
HAR (archivo Http) HAR es un archivo capturado por las herramientas de sesión HTTP para depurar cualquier problema relacionado con la IU. Puede capturarse con navegadores como Chrome, Firefox o Internet Explorer.
tcpdumps La herramienta de tcpdump captura paquetes TCP/IP transferidos o recibidos a través de la red. Esto es útil para cualquier problema relacionado con la red, como fallas del protocolo de enlace TLS, errores 502 y problemas de latencia, etcétera.

Artefactos adicionales para Apigee Edge y la nube privada

Para Apigee Edge para la nube privada, es posible que necesitemos algunos artefactos adicionales que permitan diagnosticar los problemas más rápido.

Artefacto Descripción
Topología de la red El diagrama de topología de instalación de Edge que describe tu configuración de nube privada, incluidos todos los centros de datos, nodos y componentes instalados en cada nodo.
Registros de diagnóstico de componentes de Edge Los registros de diagnóstico relacionados con el componente específico de Apigee Edge, como el procesador de mensajes, el router o Cassandra.
Archivo de configuración de instalación El archivo de configuración silencioso que se usa para instalar o actualizar Apigee Edge.

Este archivo es útil para validar si todas las opciones de configuración son correctas en los casos en que se detectan problemas de instalación o migración.

Volcado de montón Los volcados de montón son un resumen del proceso de memoria en Java. Esto es útil si se detectan errores de uso elevado de memoria o OutOfMemory en ciertos componentes de Edge.
Volcado de subprocesos Un volcado de subprocesos es un resumen de todos los subprocesos de un proceso de Java en ejecución.

Esto es útil si se observan CPU o cargas altas en ciertos componentes de Edge.

Plantillas de casos y casos de muestra

Esta sección proporciona plantillas de casos y casos de muestra para diferentes productos según las prácticas recomendadas descritas en este documento:

Apigee Edge en la nube pública

Plantilla

En esta sección, se proporciona una plantilla de muestra para Apigee Edge en la nube pública.

Problema:

<Proporcione una descripción detallada del problema o del comportamiento que se observa en su extremo. Incluya el nombre y la versión del producto cuando corresponda.>

Mensaje de error:

<Incluir el mensaje de error completo que se observa (si corresponde)>

Hora de inicio del problema (formato ISO 8601):

Hora de finalización del problema (formato ISO 8601):

Detalles de configuración de Apigee:
  Nombres de la organización:
  Nombres del entorno:
  Nombres de proxy de API:
  Números de revisión:

Pasos para reproducir:

<Proporciona los pasos necesarios para reproducir el problema cuando sea posible>

Información de diagnóstico:

<Lista de archivos adjuntos>

Caso de muestra

En esta sección, aparece un caso de muestra para Apigee Cloud (Apigee en Google Cloud/Apigee en la nube pública).

Problema:

En nuestra organización de nube pública, vemos una gran cantidad de errores 503 de servicio no disponible. ¿Puedes revisar el problema y resolverlo o ayudarnos a solucionarlo?

Mensaje de error:

{"fault":{"faultstring":"The Service is temporarily available", "detail":{"errorcode":"messaging.adaptors.http.flow.ServiceUnavailable"}}}

Hora de inicio del problema (formato ISO 8601): 2020-10-04 06:30 IST

Hora de finalización del problema (formato ISO 8601): El problema sigue ocurriendo.

Detalles de configuración de la nube de Apigee Cloud:
  Nombres de la organización: myorg
  Nombres del entorno: dev
  Nombres de proxy de API: myproxy
  Números de revisión: 3

Pasos para reproducir:

Ejecuta el siguiente comando de curl para reproducir el problema:

curl -X GET 'https://myorg-dev.apigee.net/v1/myproxy'

Información de diagnóstico:

Resultado de la herramienta Trace (trace-503.xml)

Apigee Edge para la nube privada

Plantilla

En esta sección, se proporciona una plantilla de muestra para Apigee Edge para la nube privada.

Problema:

<Proporcione una descripción detallada del problema o del comportamiento que se observa en su extremo. Incluya el nombre y la versión del producto cuando corresponda.>

Mensaje de error:

<Incluir el mensaje de error completo que se observa (si corresponde)>

Hora de inicio del problema (formato ISO 8601):

Hora de finalización del problema (formato ISO 8601):

Detalles de configuración de la nube privada de Edge:

<Conectar la topología de red que describe la configuración de tu nube privada, incluidos los centros de datos y nodos>

Pasos para reproducir:

<Proporciona los pasos necesarios para reproducir el problema cuando sea posible>

Información de diagnóstico

<Lista de archivos adjuntos>

Caso de muestra

En esta sección, se proporciona un caso de muestra de Apigee Edge para una nube privada.

Problema:

Durante la instalación de Apigee Management Server en el nodo #10 como parte de la nube privada de Edge 4.19.06 en Linux RHEL 7.6, encontramos el siguiente error.

Mensaje de error:

<snipped as the output is too long>
Checking for management-server uuid ................................................
Unable to get uuid for management-server.
Error: setup.sh: /opt/apigee/apigee-service/bin/apigee-service exited with unexpected status 1

Hora de inicio del problema (formato ISO 8601): Sucede cada vez que se instala

Hora de finalización del problema (formato ISO 8601): No aplicable

Detalles de configuración de la nube privada de Edge:

Se adjuntó el archivo network-topology.png

Pasos para reproducir:

Este es el comando que produjo el error anterior:

/opt/apigee/apigee-setup/bin/setup.sh -p ms -f /app/NonProdConfig.txt

Información de diagnóstico:

Adjunta los siguientes archivos:

  • output.txt contiene el resultado completo del comando anterior, incluido el mensaje de error
  • Registros del servidor de administración
  • Archivo de configuración NonProdConfig.txt