Instal·lació i configuració de Supervisor a Ubuntu 16.04

El supervisor és un sistema client/servidor utilitzat per controlar una sèrie de processos UNIX, més concretament processos relacionats amb un projecte o un client. Per exemple, podeu utilitzar el supervisor per generar i supervisar un nombre arbitrari de cues de treball de la vostra aplicació web.

Els components d'aquest sistema són:

• supervisord: la peça del servidor del sistema.
• supervisorctl: la interfície de línia d'ordres que s'utilitza per interactuar amb el servidor.
• Servidor web: un servidor web senzill i una interfície d'usuari web amb una funcionalitat bàsica en comparació amb supervisorctl .
• Interfície XML-RPC: el mateix servidor HTTP utilitzat pel client web, serveix una interfície XML-RPC que es pot utilitzar per controlar programes de supervisor.

En aquest tutorial instal·larem la versió més actualitzada del supervisor, demostrarem com generar i gestionar programes mitjançant supervisorctl, i configurar una interfície web per gestionar els nostres programes.

Instal·lació i configuració bàsica

Instal·larem el supervisor mitjançant easy_install, una característica de les eines de configuració de Python.

Primer, actualitzeu la vostra llista de paquets locals i després instal·leu python setuptools.

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

Ara podem instal·lar el supervisor.

sudo easy_install supervisor

Un cop finalitzada la instal·lació, hem de generar el nostre fitxer de configuració. Creeu una carpeta anomenada supervisordins /etc.

sudo mkdir /etc/supervisor

I després executeu el següent.

echo_supervisord_conf >  /etc/supervisor/supervisord.conf

Si no heu iniciat sessió amb l' rootusuari, és possible que rebeu un Permission deniederror (fins i tot amb sudo). Això es deu a la redirecció. Per superar-ho, inicieu sessió com a root.

sudo su

A continuació, podeu tornar a executar l'ordre.

echo_supervisord_conf > /etc/supervisor/supervisord.conf

Ara podeu deixar l' rootusuari amb l' exitordre. L' echo_supervisord_confordre l'ha proporcionat la instal·lació del nostre supervisor.

Configuració bàsica

Obriu el /etc/supervisor/supervisord.conffitxer i comproveu-ne el contingut. Notareu que aquest fitxer de configuració segueix la INIsintaxi i està dividit per seccions (representats per claudàtors com a [section-name]).

Per afegir programes per ser gestionats pel supervisor només hem de crear les [program]seccions corresponents . No obstant això, per evitar enredar amb el fitxer de configuració principal cada vegada que necessitem afegir (o canviar) un programa, utilitzarem la [include]secció. Cerqueu aquesta secció, descomenteu-la i, a continuació, editeu-la perquè sembli el següent.

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

Ara per a cada programa que volem afegir, crearem un .inifitxer dins del /etc/supervisor/conf.d/directori. Creem aquesta carpeta.

sudo mkdir /etc/supervisor/conf.d

S'està iniciant el servidor supervisor

Com s'ha indicat abans, el supervisor està format per un servidor i clients que s'hi connecten. Per poder gestionar i controlar programes, hem d'iniciar el servidor. Per fer-ho, registrarem el servidor supervisor a systemd, de manera que el servidor es pugui iniciar a l'inici del sistema.

Per fer-ho, creeu un fitxer anomenat supervisord.serviceal /etc/systemd/systemdirectori.

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

Afegiu el contingut següent al fitxer.

[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

Activa el servei de supervisió.

sudo systemctl start supervisord.service

Mentre el fitxer de servei es trobi al /etc/systemd/systemdirectori, s'iniciarà automàticament a l'inici del sistema.

Podeu consultar l'estat del servei.

systemctl status supervisord.service

A més, podeu consultar els registres.

sudo journalctl -u supervisord.service

Afegint programes

Els programes controlats pel supervisor es donen per diferents [program]apartats de la configuració. Per a cada programa que volem gestionar, crearem un fitxer de configuració autònom informant de la ruta executable de l'ordre, qualsevol variable ambiental, com actuar en cas d'aturada.

Primer, creem un script senzill que registre una marca de temps. Creeu un fitxer anomenat hello_supervisor.sh(allà on vulgueu, farem referència al camí complet d'aquest script).

touch hello_supervisor.sh

Ara, poseu-hi el contingut següent

#!/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

Ara feu-lo executable

chmod +x hello_supervisor.sh

En termes pràctics, aquest guió és pràcticament inútil. Tanmateix, podem utilitzar-lo per demostrar el poder del supervisor. Creeu el fitxer de configuració corresponent executant el següent.

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

Ara poseu el següent contingut en aquest fitxer.

[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: Assegureu-vos de substituir USERpel vostre nom d'usuari.

Revisarem aquesta configuració pas a pas.

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

Primer, la configuració comença definint un programa amb el nom hello_supervisor . També informa la ruta completa de l'executable que s'ha d'executar.

autostart=true

Aquesta línia indica que aquest programa s'ha d'iniciar automàticament quan s'inicia el supervisor.

autorestart=true

Si el programa es tanca, per qualsevol motiu, aquesta línia informa al supervisor que reiniciarà automàticament el procés.

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

Aquestes línies defineixen la ubicació del fitxer de registre de stderri stdout, respectivament.

Gestió de programes

Ara que hem instal·lat i configurat el supervisor, podem gestionar els nostres processos.

Després d'afegir un nou programa, hauríem d'executar les dues ordres següents, per informar al servidor de tornar a llegir els fitxers de configuració i d'aplicar els canvis.

sudo supervisorctl reread
sudo supervisorctl update

Ara executeu el supervisorctlclient.

sudo supervisorctl

Seràs rebut amb una llista dels processos registrats. Veureu un procés anomenat hello_supervisoramb un RUNNINGestat.

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

Escriviu helpper obtenir una llista d'ordres 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 poques paraules, podem start, stopi restartprogrames passant el nom del programa com a argument a l'ordre corresponent.

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> 

També podem fer una ullada a la sortida del programa amb l' tailordre.

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

Per a la stderrsortida, també podeu utilitzar-lo tail.

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!

En invocar l' statusordre, podeu veure l'estat de tots els programes registrats.

Un cop hagis acabat, pots sortir.

supervisor> quit

El client del servidor web

Per permetre l'accés al servidor web del supervisor, obriu el fitxer de configuració del supervisor i localitzeu la [inet_http_server]secció.

nano /etc/supervisor/supervisord.conf

Ara actualitzeu la configuració d'aquesta secció amb el següent.

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

Substituïu your_usernamei your_passwordamb les vostres credencials desitjades, deseu les vostres modificacions i reinicieu el servei supervisor.

sudo systemctl restart supervisord.service

Recordeu permetre l' TCPaccés al port 9001del vostre tallafoc i després accedir http://{server-ip}:9001des del vostre navegador. Quan se us demani, proporcioneu el vostre usernamei password. Ara podeu controlar els vostres processos des del web.

Conclusió

Hem instal·lat la versió més actualitzada de supervisord, hem après com configurar-lo per a l'inici automàtic del sistema amb systemd i també hem revisat un ús bàsic de supervisorctl. Per a una configuració i casos d'ús més avançats, podeu consultar la documentació oficial del supervisor .