Autocicatrización con Apigee Monit

Apigee Edge para la nube privada incluye apigee-monit, una herramienta basada en la utilidad monit de código abierto. apigee-monit sondea periódicamente los servicios de Edge. Si un servicio no está disponible, apigee-monit intenta reiniciarlo.

Para usar apigee-monit, debes instalarlo de forma manual. No forma parte de la instalación estándar.

De forma predeterminada, apigee-monit verifica el estado de los servicios de Edge cada 60 segundos.

Inicio rápido

En esta sección, se muestra cómo comenzar a usar apigee-monit con rapidez.

Si usas Amazon Linux o Oracle-Linux-7.X, primero instala monit a través de Fedora. De lo contrario, omite este paso.

sudo yum install -y https://kojipkgs.fedoraproject.org/packages/monit/5.25.1/1.el6/x86_64/monit-5.25.1-1.el6.x86_64.rpm

Para instalar apigee-monit, sigue estos pasos:

/opt/apigee/apigee-service/bin/apigee-service apigee-monit install
/opt/apigee/apigee-service/bin/apigee-service apigee-monit configure
/opt/apigee/apigee-service/bin/apigee-service apigee-monit start

/opt/apigee/apigee-service/bin/apigee-service apigee-monit unmonitor -c component_name

/opt/apigee/apigee-service/bin/apigee-service apigee-monit unmonitor -c all

/opt/apigee/apigee-service/bin/apigee-service apigee-monit monitor -c component_name

/opt/apigee/apigee-service/bin/apigee-service apigee-monit monitor -c all

/opt/apigee/apigee-service/bin/apigee-service apigee-monit report

/opt/apigee/apigee-service/bin/apigee-service apigee-monit summary

cat /opt/apigee/var/log/apigee-monit/apigee-monit.log

Cada uno de estos temas y otros se describen en detalle en las siguientes secciones.

Acerca de apigee-monit

apigee-monit ayuda a garantizar que todos los componentes de un nodo se mantengan en funcionamiento. Para ello, proporciona una variedad de servicios, incluidos los siguientes:

• Reinicia los servicios con errores
• Cómo mostrar información de resumen
• Estado de la supervisión de registros
• Envío de notificaciones
• Supervisa servicios que no son de Edge

Apigee recomienda que supervises apigee-monit para asegurarte de que se esté ejecutando. Para obtener más información, consulta Supervisa apigee-monit.

Arquitectura de apigee-monit

Durante la instalación y configuración de Apigee Edge para la nube privada, puedes instalar de forma opcional una instancia independiente de apigee-monit en cada nodo de tu clúster. Estas instancias de apigee-monit independientes funcionan de forma autónoma: no comunican el estado de sus componentes a los otros nodos ni comunican las fallas de la utilidad de supervisión a ningún servicio central.

En la siguiente imagen, se muestra la arquitectura de apigee-monit en un clúster de 5 nodos:

Configuraciones de componentes

apigee-monit usa parámetros de configuración de componentes para determinar qué componentes supervisar, qué aspectos del componente verificar y qué acción realizar en caso de que se produzca un error.

De forma predeterminada, apigee-monit supervisa todos los componentes de Edge en un nodo con sus parámetros de configuración de componentes predefinidos. Para ver la configuración predeterminada, puedes consultar los archivos de configuración de los componentes de apigee-monit. No puedes cambiar la configuración predeterminada de los componentes.

apigee-monit verifica diferentes aspectos de un componente, según el componente que esté verificando. En la siguiente tabla, se indica qué verifica apigee-monit para cada componente y se muestra dónde se encuentra la configuración de cada componente. Ten en cuenta que algunos componentes se definen en un solo archivo de configuración, mientras que otros tienen sus propias configuraciones.

En el siguiente ejemplo, se muestra la configuración predeterminada del componente edge-router:

check host edge-router with address localhost
  restart program = "/opt/apigee/apigee-service/bin/apigee-service edge-router monitrestart"
  if failed host 10.1.1.0 port 8081 and protocol http
    and request "/v1/servers/self/uuid"
    with timeout 15 seconds
    for 2 times within 3 cycles
  then restart

  if failed port 15999 and protocol http
    and request "/v1/servers/self"
    and status < 600
    with timeout 15 seconds
    for 2 times within 3 cycles
  then restart

En el siguiente ejemplo, se muestra la configuración predeterminada del componente de la nueva IU de Edge (edge-management-ui):

check process edge-management-ui
 with pidfile /opt/apigee/var/run/edge-management-ui/edge-management-ui.pid
 start program = "/opt/apigee/apigee-service/bin/apigee-service edge-management-ui start" with timeout 55 seconds
 stop program = "/opt/apigee/apigee-service/bin/apigee-service edge-management-ui stop"

No puedes cambiar los parámetros de configuración predeterminados de ningún componente de Apigee Edge para nube privada. Sin embargo, puedes agregar tus propias configuraciones de componentes para servicios externos, como tu extremo de destino o el servicio de httpd. Para obtener más información, consulta Configuraciones de componentes que no son de Apigee.

De forma predeterminada, apigee-monit supervisa todos los componentes de un nodo en el que se ejecuta. Puedes habilitarla o inhabilitarla para todos los componentes o para componentes individuales. Para obtener más información, consulte:

• Detén y reanuda la supervisión de un componente
• Cómo detener, iniciar y habilitar apigee-monit

Instala apigee-monit

apigee-monit no se instala de forma predeterminada. Puedes instalarlo manualmente después de actualizar o instalar la versión 4.19.01 o posterior de Apigee Edge para nube privada.

En esta sección, se describe cómo instalar apigee-monit.

Para obtener información sobre cómo desinstalar apigee-monit, consulta Cómo desinstalar apigee-monit.

Instala apigee-monit

En esta sección, se describe cómo instalar apigee-monit.

Para instalar apigee-monit, haz lo siguiente:

1. Instala apigee-monit con el siguiente comando:

   /opt/apigee/apigee-service/bin/apigee-service apigee-monit install

2. Configura apigee-monit con el siguiente comando:

   /opt/apigee/apigee-service/bin/apigee-service apigee-monit configure

3. Inicia apigee-monit con el siguiente comando:

   /opt/apigee/apigee-service/bin/apigee-service apigee-monit start

4. Repite este procedimiento en cada nodo del clúster.

Detén e inicia los componentes de supervisión

Cuando un servicio se detiene por cualquier motivo, apigee-monit intenta reiniciarlo.

Esto puede causar un problema si quieres detener un componente a propósito. Por ejemplo, es posible que desees detener un componente cuando necesites crear una copia de seguridad o actualizarlo. Si apigee-monit reinicia el servicio durante la copia de seguridad o la actualización, se puede interrumpir el procedimiento de mantenimiento y, posiblemente, provocar un error.

En las siguientes secciones, se muestran las opciones para detener la supervisión de los componentes.

Detén un componente y deja de supervisarlo

Para detener un componente y dejar de supervisarlo, ejecuta el siguiente comando:

/opt/apigee/apigee-service/bin/apigee-service apigee-monit stop-component -c component_name

• apigee-cassandra (Cassandra)
• apigee-openldap (OpenLDAP)
• apigee-postgresql (base de datos de PostgreSQL)
• apigee-qpidd (Qpidd)
• apigee-zookeeper (ZooKeeper)
• edge-management-server (servidor de administración)
• edge-management-ui (Nueva IU de Edge)
• edge-message-processor (Message Processor)
• edge-postgres-server (servidor de Postgres)
• edge-qpid-server (servidor de Qpid)
• edge-router (router perimetral)

Ten en cuenta que "all" no es una opción válida para stop-component. Solo puedes detener y dejar de supervisar un componente a la vez con stop-component.

Para reiniciar el componente y reanudar la supervisión, ejecuta el siguiente comando:

/opt/apigee/apigee-service/bin/apigee-service apigee-monit start-component -c component_name

Ten en cuenta que "all" no es una opción válida para start-component.

Para obtener instrucciones sobre cómo detener y dejar de supervisar todos los componentes, consulta Cómo detener y dejar de supervisar todos los componentes.

Cómo dejar de supervisar un componente (pero no detenerlo)

Para dejar de supervisar un componente (pero no detenerlo), ejecuta el siguiente comando:

/opt/apigee/apigee-service/bin/apigee-service apigee-monit unmonitor -c component_name

• apigee-cassandra (Cassandra)
• apigee-openldap (OpenLDAP)
• apigee-postgresql (base de datos de PostgreSQL)
• apigee-qpidd (Qpidd)
• apigee-zookeeper (ZooKeeper)
• edge-management-server (servidor de administración)
• edge-management-ui (Nueva IU de Edge)
• edge-message-processor (Message Processor)
• edge-postgres-server (servidor de Postgres)
• edge-qpid-server (servidor de Qpid)
• edge-router (router perimetral)

Para reanudar la supervisión del componente, ejecuta el siguiente comando:

/opt/apigee/apigee-service/bin/apigee-service apigee-monit monitor -c component_name

Deja de supervisar todos los componentes (pero no los detengas)

Para dejar de supervisar todos los componentes (pero no detenerlos), ejecuta el siguiente comando:

/opt/apigee/apigee-service/bin/apigee-service apigee-monit unmonitor -c all

Para reanudar la supervisión de todos los componentes, ejecuta el siguiente comando:

/opt/apigee/apigee-service/bin/apigee-service apigee-monit monitor -c all

Detén todos los componentes y deja de supervisarlos

Para detener todos los componentes y dejar de supervisarlos, ejecuta los siguientes comandos:

/opt/apigee/apigee-service/bin/apigee-service apigee-monit unmonitor -c all
/opt/apigee/apigee-service/bin/apigee-all stop

Para reiniciar todos los componentes y reanudar la supervisión, ejecuta los siguientes comandos:

/opt/apigee/apigee-service/bin/apigee-all start
/opt/apigee/apigee-service/bin/apigee-service apigee-monit monitor -c all

Para dejar de supervisar todos los componentes, también puedes inhabilitar apigee-monit, como se describe en Detén, inicia e inhabilita apigee-monit.

Detén, inicia e inhabilita apigee-monit

Al igual que con cualquier servicio, puedes detener e iniciar apigee-monit con el comando apigee-service. Además, apigee-monit admite el comando unmonitor, que te permite detener de forma temporal la supervisión de los componentes.

Detén apigee-monit

Para detener apigee-monit, usa el siguiente comando:

/opt/apigee/apigee-service/bin/apigee-service apigee-monit stop

Inicia apigee-monit

Para iniciar apigee-monit, usa el siguiente comando:

/opt/apigee/apigee-service/bin/apigee-service apigee-monit start

Inhabilita apigee-monit

Puedes suspender la supervisión de todos los componentes del nodo con el siguiente comando:

/opt/apigee/apigee-service/bin/apigee-service apigee-monit unmonitor -c all

Como alternativa, puedes inhabilitar apigee-monit de forma permanente desinstalándolo del nodo, como se describe en Cómo desinstalar apigee-monit.

Desinstala apigee-monit

Para desinstalar apigee-monit, haz lo siguiente:

1. Si configuraste un trabajo de cron para supervisar apigee-monit, quita el trabajo de cron antes de desinstalar apigee-monit:

   sudo rm /etc/cron.d/apigee-monit.cron

2. Detén apigee-monit con el siguiente comando:

   /opt/apigee/apigee-service/bin/apigee-service apigee-monit stop

3. Desinstala apigee-monit con el siguiente comando:

   /opt/apigee/apigee-service/bin/apigee-service apigee-monit uninstall

4. Repite este procedimiento en cada nodo del clúster.

Supervisa un componente instalado recientemente

Si instalas un componente nuevo en un nodo que ejecuta apigee-monit, puedes comenzar a supervisarlo ejecutando el comando restart de apigee-monit. Esto genera un archivo de configuración monit.conf nuevo que incluirá el componente nuevo en sus configuraciones de componentes.

En el siguiente ejemplo, se reinicia apigee-monit:

/opt/apigee/apigee-service/bin/apigee-service apigee-monit restart

Personaliza apigee-monit

Puedes personalizar varios parámetros de configuración de apigee-monit, incluidos los siguientes:

1. Configuración predeterminada del control apigee-monit
2. Parámetros de configuración global
3. Configuraciones de componentes que no son de Apigee

Configuración predeterminada de los controles de apigee-monit

Puedes personalizar la configuración predeterminada de los controles de apigee-monit, como la frecuencia de las verificaciones de estado y las ubicaciones de los archivos de apigee-monit. Para ello, edita un archivo de propiedades con la técnica de código con configuración. Los archivos de propiedades persistirán incluso después de actualizar Apigee Edge para la nube privada.

En la siguiente tabla, se describen los parámetros de configuración predeterminados del control apigee-monit que puedes personalizar:

conf_monit_httpd_allow=allow username:"password"\nallow 127.0.0.1

Para personalizar la configuración predeterminada del control apigee-monit, haz lo siguiente:

1. Edita el siguiente archivo:

   /opt/apigee/customer/application/monit.properties

   Si el archivo no existe, créalo y configura el propietario como el usuario "apigee":

   chown apigee:apigee /opt/apigee/customer/application/monit.properties

   Ten en cuenta que, si el archivo ya existe, es posible que contenga propiedades de configuración adicionales más allá de las que se enumeran en la tabla anterior. No debes modificar propiedades que no sean las mencionadas anteriormente.

2. Establece o reemplaza los valores de propiedad con tus valores nuevos.

   Por ejemplo, para cambiar la ubicación del archivo de registro a /tmp, agrega o edita la siguiente propiedad:

   conf_monit_monit_logdir=/tmp/apigee-monit.log

3. Guarda los cambios en el archivo monit.properties.
4. Vuelve a configurar apigee-monit con el siguiente comando:

   /opt/apigee/apigee-service/bin/apigee-service apigee-monit configure

5. Vuelve a cargar apigee-monit con el siguiente comando:

   /opt/apigee/apigee-service/bin/apigee-service apigee-monit reload

   Si no puedes reiniciar apigee-monit, verifica el archivo de registro para ver si hay errores, como se describe en Accede a los archivos de registro de apigee-monit.

6. Repite este procedimiento para cada nodo del clúster.

Parámetros de configuración global

Puedes definir parámetros de configuración globales para apigee-monit. Por ejemplo, puedes agregar notificaciones por correo electrónico para las alertas. Para ello, crea un archivo de configuración en el directorio /opt/apigee/data/apigee-monit y, luego, reinicia apigee-monit.

Para definir la configuración global de apigee-monit, haz lo siguiente:

1. Crea un archivo de configuración de componente nuevo en la siguiente ubicación:

   /opt/apigee/data/apigee-monit/filename.conf

   Donde filename puede ser cualquier nombre de archivo válido, excepto "monit".

2. Cambia el propietario del archivo de configuración nuevo al usuario "apigee", como se muestra en el siguiente ejemplo:

   chown apigee:apigee /opt/apigee/data/apigee-monit/my-mail-config.conf

3. Agrega los parámetros de configuración global al archivo nuevo. En el siguiente ejemplo, se configura un servidor de correo electrónico y se establecen los destinatarios de las alertas:

   SET MAILSERVER smtp.gmail.com PORT 465
     USERNAME "example-admin@gmail.com" PASSWORD "PASSWORD"
     USING SSL, WITH TIMEOUT 15 SECONDS
   
   SET MAIL-FORMAT {
     from: edge-alerts@example.com
     subject: Monit Alert -- Service: $SERVICE $EVENT on $HOST
   }
   SET ALERT fred@example.com
   SET ALERT nancy@example.com

   Para obtener una lista completa de las opciones de configuración global, consulta la documentación de monit.

4. Guarda los cambios en el archivo de configuración del componente.
5. Vuelve a cargar apigee-monit con el siguiente comando:

   /opt/apigee/apigee-service/bin/apigee-service apigee-monit reload

   Si apigee-monit no se reinicia, verifica si hay errores en el archivo de registro, como se describe en Cómo acceder a los archivos de registro de apigee-monit.

6. Repite este procedimiento para cada nodo del clúster.

Parámetros de configuración de componentes que no son de Apigee

Puedes agregar tus propias configuraciones a apigee-monit para que verifique los servicios que no forman parte de Apigee Edge para nube privada. Por ejemplo, puedes usar apigee-monit para verificar que tus APIs se estén ejecutando. Para ello, envía solicitudes a tu extremo de destino.

Para agregar una configuración de componente que no sea de Apigee, haz lo siguiente:

1. Crea un archivo de configuración de componente nuevo en la siguiente ubicación:

   /opt/apigee/data/apigee-monit/filename.conf

   Aquí, filename puede ser cualquier nombre de archivo válido, excepto "monit".

   Puedes crear tantos archivos de configuración de componentes como sea necesario. Por ejemplo, puedes crear un archivo de configuración independiente para cada componente que no sea de Apigee y que desees supervisar en el nodo.

2. Cambia el propietario del archivo de configuración nuevo al usuario "apigee", como se muestra en el siguiente ejemplo:

   chown apigee:apigee /opt/apigee/data/apigee-monit/my-config.conf

3. Agrega tus configuraciones personalizadas al nuevo archivo. En el siguiente ejemplo, se verifica el extremo de destino en el servidor local:

   CHECK HOST localhost_validate_test WITH ADDRESS localhost
     IF FAILED
       PORT 15999
       PROTOCOL http
       REQUEST "/validate__test"
       CONTENT = "Server Ready"
       FOR 2 times WITHIN 3 cycles
     THEN alert

   Para obtener una lista completa de los parámetros de configuración posibles, consulta la documentación de monit.

4. Guarda los cambios en el archivo de configuración.
5. Vuelve a cargar apigee-monit con el siguiente comando:

   /opt/apigee/apigee-service/bin/apigee-service apigee-monit reload

   Si apigee-monit no se reinicia, revisa el archivo de registro para ver si hay errores, como se describe en Cómo acceder a los archivos de registro de apigee-monit.

6. Repite este procedimiento para cada nodo del clúster.

Ten en cuenta que esto es solo para componentes que no son de Edge. No puedes personalizar la configuración de los componentes de Edge.

Accede a los archivos de registro de apigee-monit

apigee-monit registra toda la actividad, incluidos los eventos, los reinicios, los cambios de configuración y las alertas, en un archivo de registro.

La ubicación predeterminada del archivo de registro es la siguiente:

/opt/apigee/var/log/apigee-monit/apigee-monit.log

Puedes cambiar la ubicación predeterminada personalizando la configuración del control apigee-monit.

Las entradas del archivo de registro tienen el siguiente formato:

'edge-message-processor' trying to restart
[UTC Dec 14 16:20:42] info     : 'edge-message-processor' trying to restart
'edge-message-processor' restart: '/opt/apigee/apigee-service/bin/apigee-service edge-message-processor monitrestart'

No puedes personalizar el formato de las entradas del archivo de registro apigee-monit.

Visualiza el estado agregado con apigee-monit

apigee-monit incluye los siguientes comandos que te brindan información de estado agregada sobre los componentes de un nodo:

/opt/apigee/apigee-service/bin/apigee-service apigee-monit report

/opt/apigee/apigee-service/bin/apigee-service apigee-monit summary

Cada uno de estos comandos se explica con más detalle en las siguientes secciones.

informe

El comando report te proporciona un resumen de cuántos componentes están activos, inactivos, en proceso de inicialización o sin supervisión en un nodo. En el siguiente ejemplo, se invoca el comando report:

/opt/apigee/apigee-service/bin/apigee-service apigee-monit report

En el siguiente ejemplo, se muestra el resultado de report en una configuración de AIO (todo en uno):

/opt/apigee/apigee-service/bin/apigee-service apigee-monit report
up:            11 (100.0%)
down:           0 (0.0%)
initialising:   0 (0.0%)
unmonitored:    1 (8.3%)
total:         12 services

En este ejemplo, apigee-monit informa que 11 de los 12 servicios están activos. Un servicio no se está supervisando en este momento.

Es posible que recibas un error Connection refused cuando ejecutes el comando report por primera vez. En este caso, espera la duración de la propiedad conf_monit_monit_delay_time y, luego, vuelve a intentarlo.

resumen

El comando summary enumera cada componente y proporciona su estado. En el siguiente ejemplo, se invoca el comando summary:

/opt/apigee/apigee-service/bin/apigee-service apigee-monit summary

En el siguiente ejemplo, se muestra el resultado de summary en una configuración de AIO (todo en uno):

/opt/apigee/apigee-service/bin/apigee-service apigee-monit summary
Monit 5.25.1 uptime: 4h 20m
 Service Name                     Status                      Type
 host_name                        OK                          System
 apigee-zookeeper                 OK                          Process
 apigee-cassandra                 OK                          Process
 apigee-openldap                  OK                          Process
 apigee-qpidd                     OK                          Process
 apigee-postgresql                OK                          Process
 edge-management-ui               OK                          Process
 edge-qpid-server                 OK                          Remote Host
 edge-postgres-server             OK                          Remote Host
 edge-management-server           OK                          Remote Host
 edge-router                      OK                          Remote Host
 edge-message-processor           OK                          Remote Host

Si recibes un error Connection refused cuando ejecutas el comando summary por primera vez, espera la duración de la propiedad conf_monit_monit_delay_time y, luego, vuelve a intentarlo.

Supervisa apigee-monit

Es una práctica recomendada verificar periódicamente que apigee-monit se ejecute en cada nodo.

Para comprobar que apigee-monit se esté ejecutando, usa el siguiente comando:

/opt/apigee/apigee-service/bin/apigee-service apigee-monit monitor_monit

Apigee recomienda que emitas este comando de forma periódica en cada nodo que ejecute apigee-monit. Una forma de hacerlo es con una utilidad como cron, que ejecuta tareas programadas en intervalos predefinidos.

Para usar cron y supervisar apigee-monit, haz lo siguiente:

1. Para agregar compatibilidad con cron, copia el directorio apigee-monit.cron en el directorio /etc/cron.d, como se muestra en el siguiente ejemplo:

   cp /opt/apigee/apigee-monit/cron/apigee-monit.cron /etc/cron.d/

2. Abre el archivo apigee-monit.cron para editarlo.

   El archivo apigee-monit.cron define el trabajo de cron que se ejecutará, así como la frecuencia con la que se ejecutará ese trabajo. En el siguiente ejemplo, se muestran los valores predeterminados:

   # Cron entry to check if monit process is running. If not start it
   */2 * * * * root /opt/apigee/apigee-service/bin/apigee-service apigee-monit monitor_monit

   Este archivo usa la siguiente sintaxis, en la que los primeros cinco campos definen el momento en que apigee-monit ejecuta su acción:

   min hour day_of_month month day_of_week task_to_execute

   Por ejemplo, el tiempo de ejecución predeterminado es */2 * * * *, que indica a cron que verifique el proceso apigee-monit cada 2 minutos.

   No puedes ejecutar un trabajo de cron con una frecuencia superior a una vez por minuto.

   Para obtener más información sobre el uso de cron, consulta la documentación o las páginas de manual de tu SO del servidor.

3. Cambia la configuración de cron para que coincida con las políticas de tu organización. Por ejemplo, para cambiar la frecuencia de ejecución a cada 5 minutos, establece la definición del trabajo de la siguiente manera:

   */5 * * * * root /opt/apigee/apigee-service/bin/apigee-service apigee-monit monitor_monit

4. Guarda el archivo apigee-monit.cron.
5. Repite este procedimiento para cada nodo del clúster.

Si cron no comienza a mirar apigee-monit, verifica lo siguiente:

• Hay una línea en blanco después de la definición del trabajo cron.
• Solo hay un trabajo de cron definido en el archivo. (Las líneas comentadas no cuentan).

Si quieres detener o inhabilitar temporalmente apigee-monit, también debes inhabilitar este trabajo de cron; de lo contrario, cron reiniciará apigee-monit.

Para inhabilitar cron, realiza una de las siguientes acciones:

• Borra el archivo /etc/cron.d/apigee-monit.cron:

  sudo rm /etc/cron.d/apigee-monit.cron

  Tendrás que volver a copiarlo si más adelante quieres volver a habilitar cron para mirar apigee-monit.

  OR

• Edita el archivo /etc/cron.d/apigee-monit.cron y marca como comentario la definición del trabajo agregando un "#" al principio de la línea, por ejemplo:

  # 10 * * * * root /opt/apigee/apigee-service/bin/apigee-service apigee-monit monitor_monit