Hacer comprobaciones del estado

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

Consulta la documentación de Apigee Edge.

Apigee expone comprobaciones del estado en diferentes niveles, que puedes aprovechar en función del caso práctico.

  1. Comprobación del estado a nivel regional o de la instancia de Apigee: devuelve el estado general de la instancia de Apigee en una región.
  2. Comprobaciones de estado a nivel de entorno: devuelve el estado de un entorno concreto de la instancia de Apigee.
  3. Comprobación de estado personalizada a través de un proxy de API: en casos prácticos complejos, puedes configurar un proxy de API específico como endpoint de comprobación de estado personalizada.

Realizar una comprobación del estado a nivel regional

Apigee ofrece una comprobación del estado a nivel regional o de instancia de Apigee para evaluar el estado general de la instancia de Apigee en una región específica. Este patrón de comprobación del estado, que utilizan muchos balanceadores de carga, determina el estado de las instancias de Apigee y realiza conmutaciones por error regionales. Para realizar una comprobación del estado a nivel regional, crea la solicitud de la siguiente manera:

  • Ruta de comprobación del estado: /healthz/ingress
  • Añade el encabezado de solicitud: User-Agent: GoogleHC.
$ curl -H 'User-Agent: GoogleHC' https://$HOST/healthz/ingress
Apigee Ingress is healthy
 donde $HOST representa el nombre de host definido en el grupo de entornos de Apigee que sirve el balanceador de carga.

Realizar una comprobación del estado a nivel de entorno

Apigee ofrece una comprobación del estado a nivel de entorno para evaluar el estado de un entorno concreto servido por la instancia de Apigee. Este patrón de comprobación del estado es preferible cuando quieras realizar conmutaciones por error regionales en función del estado de determinados entornos críticos o selectivos. Para realizar una comprobación de estado a nivel de entorno, llama a cualquier proxy de API válido en un entorno construyendo la solicitud de la siguiente manera:

  • Añade /healthz/ al principio de la ruta base del proxy.
  • Añade el encabezado de solicitud: User-Agent: GoogleHC.

Por ejemplo, supongamos que /catalog es una ruta base de proxy válida que se ha implementado en un entorno. Para hacer una comprobación del estado, llama al proxy de esta forma: 

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

Realizar una comprobación del estado personalizada a través de un proxy de API

Si quieres realizar validaciones adicionales, puedes definir una lógica de comprobación de estado personalizada en un proxy de API implementado en un entorno. Por ejemplo, es posible que no supere la comprobación de estado cuando varios entornos estén inactivos. También puedes hacer que la comprobación de estado falle en función del estado o la latencia del destino.

En este caso, puedes realizar la comprobación del estado haciendo una llamada a la API normal a ese proxy.

Por ejemplo, supongamos que quieres comprobar el estado de un entorno llamado prod. Despliega un proxy de API en ese entorno con la ruta base /healthcheck-prod. Para comprobar el estado del entorno prod proporcionado por la instancia de Apigee, llama al proxy de esta forma: 

$ curl https://$HOST/healthcheck-prod
 donde $HOST representa el nombre de host definido en el grupo de entornos de Apigee que sirve el balanceador de carga.

Notas de uso

En el caso de las comprobaciones de estado a nivel de región y de entorno: si las realizan los balanceadores de carga de Google Cloud, el balanceador de carga define el encabezado User-Agent correcto. Si tu propio cliente consume estas llamadas a la API de comprobación del estado, debes asegurarte de que se haya definido el User-Agent correcto.

En Apigee hybrid: la función de comprobación del estado solo está disponible en la versión 1.4 y posteriores.