Instalación y configuración de Supervisor en Ubuntu 16.04

• Instalación y configuración básica.
• Inicio del servidor supervisor
• Agregar programas
• Gestionar programas
• El cliente del servidor web
• Conclusión

Supervisor es un sistema cliente / servidor utilizado para controlar una serie de procesos UNIX, más específicamente procesos relacionados con un proyecto o un cliente. Por ejemplo, podría usar el supervisor para generar y monitorear un número arbitrario de colas de trabajadores de su aplicación web.

Los componentes de este sistema son:

• supervisor: la pieza del servidor del sistema.
• supervisorctl: la interfaz de línea de comandos utilizada para interactuar con el servidor.
• Servidor web: un servidor web simple y una interfaz de usuario web con funcionalidad básica en comparación con supervisorctl .
• Interfaz XML-RPC: el mismo servidor HTTP utilizado por el cliente web sirve una interfaz XML-RPC que se puede usar para controlar los programas de supervisión.

En este tutorial instalaremos la versión más actualizada del supervisor, demostraremos cómo generar y administrar programas supervisorctly configuraremos una interfaz web para administrar nuestros programas.

Instalación y configuración básica.

easy_installInstalaremos supervisor a través de , una característica de las herramientas de configuración de Python.

Primero, actualice su lista de paquetes locales y luego instale python setuptools.

sudo apt-get update && sudo apt-get install python-setuptools

Ahora podemos instalar supervisor.

sudo easy_install supervisor

Una vez que se completa la instalación, tenemos que generar nuestro archivo de configuración. Crea una carpeta con nombre supervisordentro /etc.

sudo mkdir /etc/supervisor

Y luego ejecute lo siguiente.

echo_supervisord_conf >  /etc/supervisor/supervisord.conf

Si no ha iniciado sesión con el rootusuario, puede recibir un Permission deniederror (incluso con sudo). Esto se debe a la redirección. Para superar esto, inicie sesión como root.

sudo su

Luego puede ejecutar el comando nuevamente.

echo_supervisord_conf > /etc/supervisor/supervisord.conf

Ahora puede dejar al rootusuario con el exitcomando. El echo_supervisord_confcomando fue proporcionado por nuestro supervisor de instalación.

Configuracion basica

Abra el /etc/supervisor/supervisord.confarchivo y verifique su contenido. Notará que este archivo de configuración sigue la INIsintaxis y está dividido por secciones (representadas por paréntesis como en [section-name]).

Para agregar programas a ser administrados por el supervisor, solo necesitamos crear las [program]secciones apropiadas . Sin embargo, para evitar meterse con el archivo de configuración principal cada vez que necesitemos agregar (o cambiar) un programa, usaremos la [include]sección. Busque esta sección, descomente y luego edítela para que tenga el siguiente aspecto.

[include]
files=conf.d/*.conf

Ahora para cada programa que queremos agregar, crearemos un .iniarchivo dentro del /etc/supervisor/conf.d/directorio. Vamos a crear esta carpeta.

sudo mkdir /etc/supervisor/conf.d

Inicio del servidor supervisor

Como se señaló anteriormente, el supervisor está compuesto por un servidor y clientes que se conectan a él. Para poder administrar y controlar programas, necesitamos iniciar el servidor. Para hacerlo, registraremos el servidor supervisor en systemd, para que el servidor pueda iniciarse al inicio del sistema.

Para hacerlo, cree un archivo llamado supervisord.serviceen el /etc/systemd/systemdirectorio.

sudo touch /etc/systemd/system/supervisord.service

Agregue los siguientes contenidos al archivo.

[Unit]
Description=Supervisor daemon
Documentation=http://supervisord.org
After=network.target

[Service]
ExecStart=/usr/local/bin/supervisord -n -c /etc/supervisor/supervisord.conf
ExecStop=/usr/local/bin/supervisorctl $OPTIONS shutdown
ExecReload=/usr/local/bin/supervisorctl $OPTIONS reload
KillMode=process
Restart=on-failure
RestartSec=42s

[Install]
WantedBy=multi-user.target
Alias=supervisord.service

Activar el servicio de supervisión.

sudo systemctl start supervisord.service

Mientras el archivo de servicio se encuentre en el /etc/systemd/systemdirectorio, se iniciará automáticamente al iniciar el sistema.

Puede verificar el estado del servicio.

systemctl status supervisord.service

Además, puede consultar los registros.

sudo journalctl -u supervisord.service

Agregar programas

Los programas controlados por el supervisor están dados por diferentes [program]secciones en la configuración. Para cada programa que queramos administrar, crearemos un archivo de configuración independiente que informe la ruta ejecutable del comando, cualquier variable ambiental, cómo realizarla en caso de apagado.

Primero, creemos un script simple que registre una marca de tiempo. Cree un archivo llamado hello_supervisor.sh(en cualquier lugar que desee, haremos referencia a la ruta completa de este script).

touch hello_supervisor.sh

Ahora, pon los siguientes contenidos en él

#!/bin/bash
while true
do 
    # Echo current timestamp to stdout
    echo Hello Supervisor: `date`
    # Echo 'error!' to stderr
    echo An error ocurred at `date`! >&2
    sleep 1
done

Ahora hazlo ejecutable

chmod +x hello_supervisor.sh

En términos prácticos, este script es prácticamente inútil. Sin embargo, podemos usarlo para demostrar el poder del supervisor. Cree el archivo de configuración correspondiente ejecutando lo siguiente.

sudo touch /etc/supervisor/conf.d/hello_supervisor.conf

Ahora ponga los siguientes contenidos en este archivo.

[program:hello_supervisor]
command=/home/USER/hello_supervisor.sh
autostart=true
autorestart=true
stderr_logfile=/var/log/hello_supervisor.err.log
stdout_logfile=/var/log/hello_supervisor.out.log

Nota: Asegúrese de reemplazar USERcon su nombre de usuario.

Revisaremos esta configuración paso a paso.

[program:hello_supervisor]
command=/home/USER/hello_supervisor.sh

Primero, la configuración comienza definiendo un programa de nombre hello_supervisor . También informa la ruta completa del ejecutable que se ejecutará.

autostart=true

Esta línea establece que este programa debe iniciarse automáticamente cuando se inicia el supervisor.

autorestart=true

Si el programa se cierra, por cualquier motivo, esta línea informa al supervisor para reiniciar automáticamente el proceso.

stderr_logfile=/var/log/hello_supervisor.err.log
stdout_logfile=/var/log/hello_supervisor.out.log

Estas líneas definen la ubicación del archivo de registro para stderry stdout, respectivamente.

Gestionar programas

Ahora que hemos instalado y configurado el supervisor, podemos administrar nuestros procesos.

Después de agregar un nuevo programa, debemos ejecutar los siguientes dos comandos, para informar al servidor que vuelva a leer los archivos de configuración y aplique los cambios.

sudo supervisorctl reread
sudo supervisorctl update

Ahora ejecuta al supervisorctlcliente.

sudo supervisorctl

Será recibido con una lista de los procesos registrados. Verá un proceso llamado hello_supervisorcon un RUNNINGestado.

hello_supervisor                 RUNNING   pid 6853, uptime 0:22:30
supervisor>

Escriba helppara obtener una lista de los comandos disponibles.

supervisor> help

default commands (type help <topic>):
=====================================
add    exit      open  reload  restart   start   tail   
avail  fg        pid   remove  shutdown  status  update 
clear  maintail  quit  reread  signal    stop    version

En pocas palabras, lo que podamos start, stopy restartprogramas por los que pasa el nombre del programa como un argumento para el comando correspondiente.

supervisor> stop hello_supervisor 
hello_supervisor: stopped
supervisor> start hello_supervisor 
hello_supervisor: started
supervisor> restart hello_supervisor 
hello_supervisor: stopped
hello_supervisor: started
supervisor> 

También podemos echar un vistazo a la salida del programa con el tailcomando.

supervisor> tail hello_supervisor 
Hello Supervisor: Mon Sep 25 19:27:29 UTC 2017
Hello Supervisor: Mon Sep 25 19:27:30 UTC 2017
Hello Supervisor: Mon Sep 25 19:27:31 UTC 2017

Para la stderrsalida, puede usar tailtambién.

supervisor> tail hello_supervisor stderr
An error ocurred at Mon Sep 25 19:31:12 UTC 2017!
An error ocurred at Mon Sep 25 19:31:13 UTC 2017!
An error ocurred at Mon Sep 25 19:31:14 UTC 2017!

Al invocar el statuscomando, puede ver el estado de todos los programas registrados.

Una vez que haya terminado, puede dejar de fumar.

supervisor> quit

El cliente del servidor web

Para permitir el acceso al servidor web del supervisor, abra el archivo de configuración del supervisor y localice la [inet_http_server]sección.

nano /etc/supervisor/supervisord.conf

Ahora actualice la configuración de esta sección con lo siguiente.

[inet_http_server]
port=*:9001
username=your_username
password=your_password

Reemplace your_usernamey your_passwordcon sus credenciales deseadas, guarde sus modificaciones y reinicie el servicio de supervisión.

sudo systemctl restart supervisord.service

Recuerde permitir el TCPacceso al puerto 9001en su firewall y luego acceder http://{server-ip}:9001desde su navegador. Cuando se le solicite, proporcione su usernamey password. Ahora puede controlar sus procesos desde la web.

Conclusión

Hemos instalado la versión más actualizada de supervisor, aprendimos cómo configurarlo para el inicio automático del sistema con systemd y también revisamos un uso básico de supervisorctl. Para una configuración más avanzada y casos de uso, puede consultar la documentación oficial del supervisor .