Realiza verificaciones de estado

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Apigee admite dos enfoques de verificación de estado. La opción adecuada para ti depende de cómo llega el tráfico del cliente a Apigee.

  • Verificación de estado activa: Para arquitecturas que enrutan el tráfico del cliente a Apigee a través de un balanceador de cargas Google Cloud respaldado por un grupo de instancias administrado (MIG). El balanceador de cargas (o tu cliente) sondea de forma activa uno de los extremos de /healthz/* para determinar el estado de la instancia o el entorno, y el balanceador de cargas conmuta por error entre las regiones. Si tu arquitectura usa MIG, sigue usando la verificación activa del estado.
  • Verificación de estado de PSC: Para arquitecturas que enrutan el tráfico de clientes a Apigee a través de Private Service Connect (PSC). Apigee supervisa las instancias regionales por ti y actualiza automáticamente el estado de cada región. No se requieren sondeos iniciados por el cliente ni por el balanceador de cargas. Si tu arquitectura usa PSC, habilita la verificación de estado de PSC.

Selecciona una pestaña para obtener más información.

Verificación de estado activa

Apigee expone verificaciones de estado activas en diferentes niveles, que puedes aprovechar según el caso de uso.

  1. Verificación de estado a nivel regional o de la instancia de Apigee: Muestra el estado general de la instancia de Apigee en una región.
  2. Verificaciones de estado a nivel del entorno: Muestran el estado de un entorno en particular en la instancia de Apigee.
  3. Verificación de estado personalizada a través de un proxy de API: Para casos de uso complejos, puedes configurar un proxy de API dedicado como extremo de verificación de estado personalizado.

Realiza una verificación de estado a nivel regional

Apigee ofrece una verificación de estado a nivel regional o de la instancia de Apigee para evaluar el estado general de la instancia de Apigee en una región específica. Este patrón de verificación de estado, que usan mucho los balanceadores de cargas, determina el estado de las instancias de Apigee y realiza conmutaciones por error regionales. Para realizar una verificación de estado a nivel regional, construye la solicitud de la siguiente manera:

  • Ruta de verificación de estado: /healthz/ingress
  • Agrega el encabezado de la solicitud: User-Agent: GoogleHC.
$ curl -H 'User-Agent: GoogleHC' https://$HOST/healthz/ingress
Apigee Ingress is healthy
, en la que $HOST representa el nombre de host definido en el grupo de entornos de Apigee que entrega el balanceador de cargas.

Realiza una verificación de estado a nivel del entorno

Apigee ofrece una verificación de estado a nivel del entorno para evaluar el estado de un entorno en particular que entrega la instancia de Apigee. Este patrón de verificación de estado es preferible cuando deseas realizar conmutaciones por error regionales en función del estado de ciertos entornos críticos o selectivos. Puedes realizar una verificación de estado a nivel del entorno llamando a cualquier proxy de API válido en un entorno si construyes la solicitud de la siguiente manera:

  • Ingresa /healthz/ a la ruta base del proxy.
  • Agrega el encabezado de la solicitud: User-Agent: GoogleHC.

Por ejemplo, supongamos que /catalog es una ruta base del proxy válida que se implementa en un entorno. Para realizar una verificación de estado, llama al proxy de la siguiente manera: 

$ curl -H 'User-Agent: GoogleHC' https://$HOST/healthz/catalog
Server Ready
, en la que $HOST representa el nombre de host definido en el grupo de entornos de Apigee que entrega el balanceador de cargas.

Realiza una verificación de estado personalizada a través de un proxy de API

Si deseas realizar validaciones adicionales, puedes definir una lógica de verificación de estado personalizada en un proxy de API implementado en un entorno. Por ejemplo, puedes fallar en la verificación de estado cuando varios entornos están inactivos. O bien, puedes fallar en la verificación de estado en función de la latencia o el estado objetivo.

En este caso, puedes realizar la verificación de estado mediante una llamada normal a la API de ese proxy.

Por ejemplo, supongamos que deseas verificar el estado de un entorno llamado prod. Implementa un proxy de API en ese entorno con la ruta base /healthcheck-prod. Para verificar el estado del entorno prod que entrega la instancia de Apigee, llama al proxy de la siguiente manera: 

$ curl https://$HOST/healthcheck-prod
, en la que $HOST representa el nombre de host definido en el grupo de entornos de Apigee que entrega el balanceador de cargas.

Notas de uso

Para las verificaciones de estado a nivel regional y del entorno: Si las realizan balanceadores de cargas de Google Cloud, el balanceador de cargas configura el encabezado User-Agent correcto. Si tu propio cliente consume estas llamadas a la API de verificación de estado, debes asegurarte de que se establezca la User-Agent correcta.

En Apigee Hybrid: la función de verificación de estado solo está disponible para la versión 1.4 y las versiones posteriores.

Verificación de estado de PSC

Apigee admite la verificación de estado con Private Service Connect (PSC), lo que permite la conmutación por error automática entre regiones para las implementaciones multirregionales. Si tienes varias instancias de Apigee en varias regiones, puedes habilitar las verificaciones de estado de PSC para que el tráfico conmute por error automáticamente a una región en buen estado cuando la instancia de Apigee en la región activa deje de estar en buen estado. No se requiere ninguna solicitud de tu cliente o balanceador de cargas para activar la verificación. Google Cloud supervisa la instancia de forma continua en tu nombre y actualiza el estado de salud automáticamente.

La función de verificación de estado de PSC está configurada en el backend de Apigee. No es necesario que implementes recursos adicionales, escribas código ni cambies tus proxies de API.

Requisitos previos

  • Tienes una organización de suscripción o de pago por uso de Apigee.
  • Tu organización tiene dos o más instancias de Apigee, cada una en una Google Cloud región diferente.
  • El tráfico de tu cliente llega a Apigee a través de Private Service Connect (PSC).
  • Cada entorno, grupo de entornos, proxy de API, flujo compartido y recurso se implementa de forma idéntica en todas las instancias de Apigee que participan en la conmutación por error. Las implementaciones incoherentes pueden provocar un comportamiento inesperado cuando el tráfico cambia entre regiones.

Cómo habilitar

La verificación de estado del PSC es una función opcional que administra Google. Para solicitar que se habilite tu organización, comunícate con tu equipo de cuentas de Apigee o con la Asistencia de Apigee. Si está habilitada, la conmutación por error regional automática estará activa para todas las instancias de tu organización. No es necesario que lo configures.

Recomendaciones para las pruebas

Dado que la verificación de estado de PSC introduce una conmutación por error regional automática e inmediata que afecta directamente el enrutamiento del tráfico, te recomendamos que pruebes la función en un entorno de Apigee que no sea de producción antes de habilitarla para tu organización de producción. Verifica que la conmutación por error y la recuperación se comporten según lo esperado para tus patrones de tráfico de la API y que tus aplicaciones cliente controlen la transición de forma transparente.

Para simular una situación de conmutación por error y validar tu configuración, comunícate con tu equipo de cuentas de Apigee o con la Asistencia de Apigee. El equipo puede ayudarte a inducir condiciones de falla en un entorno controlado para que puedas observar el comportamiento de la conmutación por error antes de habilitar la función en producción.

Cómo funciona la conmutación por error

Cuando la verificación de estado del PSC determina que la instancia de Apigee en tu región activa no está en buen estado, el tráfico del cliente se enruta de inmediato y de forma automática a una instancia de Apigee en buen estado en otra región. Cuando se recupera la instancia en mal estado, el tráfico vuelve a la región original. La conmutación por error y la recuperación se producen de forma transparente para tus aplicaciones cliente.

Limitaciones actuales

  • Actualmente, la verificación de estado de PSC solo detecta interrupciones completas de la infraestructura regional. No se activa en incidentes en los que el tráfico puede seguir fluyendo, incluso si se degrada en las tasas de error o la latencia. Se planea realizar verificaciones de estado más amplias a nivel de los componentes en una versión futura.

Verifica el estado en Cloud Logging

Puedes observar los eventos de estado por región de tus instancias de Apigee en Cloud Logging. En el Explorador de registros del proyecto Google Cloud que aloja tu organización de Apigee, ejecuta el siguiente filtro: 

resource.type="compute.googleapis.com/NetworkEndpointGroupV2"

Para obtener más información, consulta Cómo supervisar los registros de verificaciones de estado compuestas.

Para cada región, consulta el campo healthState en las entradas de registro correspondientes. Un valor de HEALTHY indica que se puede acceder a la instancia de Apigee en esa región y que está publicando tráfico. Otros valores indican que la verificación de estado de PSC no está enrutando tráfico a esa región en este momento.