Installera och konfigurera Supervisor på Ubuntu 16.04

Supervisor är ett klient/serversystem som används för att styra ett antal UNIX-processer, mer specifikt processer relaterade till ett projekt eller en kund. Till exempel kan du använda supervisor för att skapa och övervaka ett godtyckligt antal arbetsköer i din webbapplikation.

Komponenterna i detta system är:

• supervisord: Serverdelen av systemet.
• supervisorctl: Kommandoradsgränssnittet som används för att interagera med servern.
• Webbserver: En enkel webbserver och ett webbanvändargränssnitt med grundläggande funktionalitet jämfört med supervisorctl .
• XML-RPC-gränssnitt: Samma HTTP-server som används av webbklienten, tjänar ett XML-RPC-gränssnitt som kan användas för att styra övervakarprogram.

I den här handledningen kommer vi att installera den senaste versionen av supervisor, demonstrera hur man skapar och hanterar program genom supervisorctloch konfigurerar ett webbgränssnitt för att hantera våra program.

Installation och grundkonfiguration

Vi kommer att installera supervisor genom easy_install, en funktion i pythons installationsverktyg.

Uppdatera först din lokala paketlista och installera sedan python setuptools.

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

Nu kan vi installera supervisor.

sudo easy_install supervisor

När installationen är klar måste vi skapa vår konfigurationsfil. Skapa en mapp med namnet supervisorinuti /etc.

sudo mkdir /etc/supervisor

Och utför sedan följande.

echo_supervisord_conf >  /etc/supervisor/supervisord.conf

Om du inte är inloggad med rootanvändaren kan du få ett Permission deniedfelmeddelande (även med sudo). Detta beror på omdirigeringen. För att övervinna detta, logga in som root.

sudo su

Sedan kan du köra kommandot igen.

echo_supervisord_conf > /etc/supervisor/supervisord.conf

Du kan nu lämna rootanvändaren med exitkommandot. Den echo_supervisord_confkommandot från vår handledare installation.

Grundläggande konfiguration

Öppna /etc/supervisor/supervisord.conffilen och kontrollera dess innehåll. Du kommer att notera att den här konfigurationsfilen följer INIsyntaxen, och den är uppdelad av sektioner (representeras av parentes som i [section-name]).

För att lägga till program som ska hanteras av handledaren behöver vi bara skapa lämpliga [program]sektioner. Men för att undvika att krångla med huvudkonfigurationsfilen varje gång vi behöver lägga till (eller ändra) ett program kommer vi att använda [include]avsnittet. Hitta det här avsnittet, avkommentera det och redigera det så att det ser ut så här.

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

Nu för varje program vi vill lägga till kommer vi att skapa en .inifil i /etc/supervisor/conf.d/katalogen. Låt oss skapa den här mappen.

sudo mkdir /etc/supervisor/conf.d

Startar supervisorservern

Som nämnts tidigare består supervisor av en server och klienter som ansluter till den. För att kunna hantera och styra program behöver vi starta servern. För att göra det kommer vi att registrera supervisorservern i systemd, så att servern kan startas vid systemstart.

För att göra det, skapa en fil som heter supervisord.servicei /etc/systemd/systemkatalogen.

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

Lägg till följande innehåll i filen.

[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

Aktivera tillsynstjänsten.

sudo systemctl start supervisord.service

Så länge servicefilen finns i /etc/systemd/systemkatalogen kommer den att startas automatiskt vid systemstart.

Du kan kontrollera tjänstens status.

systemctl status supervisord.service

Du kan också kolla in loggarna.

sudo journalctl -u supervisord.service

Lägger till program

De program som styrs av handledaren ges av olika [program]sektioner i konfigurationen. För varje program vi vill hantera kommer vi att skapa en fristående konfigurationsfil som informerar om kommandots körbara sökväg, eventuella miljövariabler, hur man utför i händelse av avstängning.

Låt oss först skapa ett enkelt skript som loggar en tidsstämpel. Skapa en fil som heter hello_supervisor.sh(var du än vill, vi kommer att referera till hela sökvägen för detta skript).

touch hello_supervisor.sh

Lägg nu in följande innehåll i den

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

Gör det nu körbart

chmod +x hello_supervisor.sh

I praktiska termer är detta skript ganska värdelöst. Däremot kan vi använda det för att visa handledarens makt. Skapa motsvarande konfigurationsfil genom att köra följande.

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

Lägg nu följande innehåll i den här filen.

[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

Obs: Se till att ersätta USERmed ditt användarnamn.

Vi kommer att granska denna konfiguration steg för steg.

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

Först börjar konfigurationen med att definiera ett program med namnet hello_supervisor . Den informerar också om hela sökvägen för den körbara filen som ska köras.

autostart=true

Denna rad anger att detta program ska startas automatiskt när supervisor startas.

autorestart=true

Om programmet avslutas, av någon anledning, informerar den här raden handledaren om att automatiskt starta om processen.

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

Dessa linjer definierar loggfil plats för stderroch stdoutrespektive.

Hantera program

Nu när vi har installerat och konfigurerat supervisor kan vi hantera våra processer.

Efter att ha lagt till ett nytt program bör vi köra följande två kommandon, för att informera servern att läsa om konfigurationsfilerna och att tillämpa eventuella ändringar.

sudo supervisorctl reread
sudo supervisorctl update

Kör nu supervisorctlklienten.

sudo supervisorctl

Du kommer att hälsas med en lista över de registrerade processerna. Du kommer att se en process som anropas hello_supervisormed en RUNNINGstatus.

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

Skriv helpför en lista över tillgängliga kommandon.

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

I ett nötskal kan vi start, stopoch restartprogrammera genom att skicka programnamnet som ett argument till respektive kommando.

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> 

Vi kan också ta en titt på programmets utdata med tailkommandot.

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

För stderrutgången kan du också använda 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!

Genom att anropa statuskommandot kan du se status för alla registrerade program.

När du är klar kan du sluta.

supervisor> quit

Webserverklienten

För att tillåta åtkomst till supervisor-webservern, öppna supervisor-konfigurationsfilen och leta upp [inet_http_server]avsnittet.

nano /etc/supervisor/supervisord.conf

Uppdatera nu detta avsnitts konfiguration med följande.

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

Byt ut your_usernameoch your_passwordmed dina önskade referenser, spara dina ändringar och omstarta supervisord-tjänsten.

sudo systemctl restart supervisord.service

Kom ihåg att tillåta TCPåtkomst till porten 9001på din brandvägg och sedan åtkomst http://{server-ip}:9001från din webbläsare. Ange ditt usernameoch password. Du kan nu styra dina processer från webben.

Slutsats

Vi har installerat den senaste versionen av supervisord, lärt oss hur man konfigurerar den för automatisk start av systemet med systemd och även granskat en grundläggande användning av supervisorctl. För mer avancerad konfiguration och användningsfall kan du hänvisa till den officiella handledaredokumentationen .