Installation og konfiguration af Supervisor på Ubuntu 16.04

Supervisor er et klient/server-system, der bruges til at styre en række UNIX-processer, mere specifikt processer relateret til et projekt eller en kunde. For eksempel kan du bruge supervisor til at skabe og overvåge et vilkårligt antal arbejderkøer i din webapplikation.

Komponenterne i dette system er:

• supervisord: Serverdelen af ​​systemet.
• supervisorctl: Kommandolinjegrænsefladen, der bruges til at interagere med serveren.
• Webserver: En simpel webserver og en webbrugergrænseflade med grundlæggende funktionalitet sammenlignet med supervisorctl .
• XML-RPC-grænseflade: Den samme HTTP-server, der bruges af webklienten, serverer en XML-RPC-grænseflade, der kan bruges til at styre supervisorprogrammer.

I denne tutorial vil vi installere den mest opdaterede version af supervisor, demonstrere, hvordan man spawner og administrerer programmer gennem supervisorctlog konfigurere en webgrænseflade til at administrere vores programmer.

Installation og grundlæggende konfiguration

Vi vil installere supervisor gennem easy_install, en funktion i pythons opsætningsværktøjer.

Først skal du opdatere din lokale pakkeliste og derefter installere python setuptools.

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

Nu kan vi installere supervisor.

sudo easy_install supervisor

Når installationen er færdig, skal vi generere vores konfigurationsfil. Opret en mappe med navnet supervisorinde /etc.

sudo mkdir /etc/supervisor

Og udfør derefter følgende.

echo_supervisord_conf >  /etc/supervisor/supervisord.conf

Hvis du ikke er logget ind med rootbrugeren, kan du få en Permission deniedfejlmeddelelse (selv med sudo). Dette skyldes omdirigeringen. For at overvinde dette skal du logge ind som root.

sudo su

Så kan du køre kommandoen igen.

echo_supervisord_conf > /etc/supervisor/supervisord.conf

Du kan nu lade rootbrugeren stå med exitkommandoen. Den echo_supervisord_confKommandoen blev leveret af vores vejleder installation.

Grundlæggende konfiguration

Åbn /etc/supervisor/supervisord.conffilen og kontroller dens indhold. Du vil bemærke, at denne konfigurationsfil følger INIsyntaksen, og den er opdelt efter sektioner (repræsenteret med parenteser som i [section-name]).

For at tilføje programmer, der skal administreres af supervisor, skal vi blot oprette de relevante [program]sektioner. Men for at undgå at rode rundt med hovedkonfigurationsfilen, hver gang vi skal tilføje (eller ændre) et program, vil vi bruge [include]sektionen. Find denne sektion, fjern kommentaren og rediger den, så den ser ud som følgende.

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

Nu for hvert program, vi vil tilføje, vil vi oprette en .inifil inde i /etc/supervisor/conf.d/mappen. Lad os oprette denne mappe.

sudo mkdir /etc/supervisor/conf.d

Starter supervisorserveren

Som nævnt før er supervisor sammensat af en server og klienter, der opretter forbindelse til den. For at kunne styre og styre programmer skal vi starte serveren. For at gøre dette vil vi registrere supervisorserveren i systemd, så serveren kan startes ved systemstart.

For at gøre det skal du oprette en fil, der hedder supervisord.servicei /etc/systemd/systemmappen.

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

Tilføj følgende indhold til 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

Aktiver supervisor-tjenesten.

sudo systemctl start supervisord.service

Så længe servicefilen er placeret i /etc/systemd/systembiblioteket, vil den automatisk blive startet ved systemstart.

Du kan tjekke status for tjenesten.

systemctl status supervisord.service

Du kan også tjekke logfilerne.

sudo journalctl -u supervisord.service

Tilføjelse af programmer

Programmerne styret af supervisor er givet af forskellige [program]sektioner i konfigurationen. For hvert program, vi ønsker at administrere, vil vi oprette en selvstændig konfigurationsfil, der informerer om kommandoens eksekverbare sti, eventuelle miljøvariabler, hvordan man udfører i tilfælde af en nedlukning.

Lad os først oprette et simpelt script, der logger et tidsstempel. Opret en fil kaldet hello_supervisor.sh(hvor som helst du ønsker, vil vi henvise til den fulde sti til dette script).

touch hello_supervisor.sh

Læg nu følgende indhold ind i det

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

chmod +x hello_supervisor.sh

Rent praktisk er dette script stort set ubrugeligt. Vi kan dog bruge det til at demonstrere supervisors magt. Opret den tilsvarende konfigurationsfil ved at køre følgende.

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

Indsæt nu følgende indhold i denne fil.

[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

Bemærk: Sørg for at erstatte USERmed dit brugernavn.

Vi vil gennemgå denne konfiguration trin for trin.

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

Først begynder konfigurationen med at definere et program med navnet hello_supervisor . Den informerer også om den fulde sti til den eksekverbare fil, der skal køres.

autostart=true

Denne linje angiver, at dette program skal startes automatisk, når supervisor startes.

autorestart=true

Hvis programmet af en eller anden grund afsluttes, informerer denne linje supervisor om automatisk at genstarte processen.

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

Disse linjer definerer logfil placering for stderrog stdouthhv.

Håndtering af programmer

Nu hvor vi har installeret og konfigureret supervisor, er vi i stand til at styre vores processer.

Efter at have tilføjet et nyt program, skal vi køre følgende to kommandoer for at informere serveren om at genlæse konfigurationsfilerne og anvende eventuelle ændringer.

sudo supervisorctl reread
sudo supervisorctl update

Udfør nu supervisorctlklienten.

sudo supervisorctl

Du vil blive mødt med en liste over de registrerede processer. Du vil se en proces kaldet hello_supervisormed en RUNNINGstatus.

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

Skriv helpfor en liste over tilgængelige kommandoer.

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 en nøddeskal kan vi start, stopog restartprogrammere ved at sende programnavnet som et argument til den 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 også tage et kig på programmets output med tailkommandoen.

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

Til stderroutput kan du også bruge 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!

Ved at påkalde statuskommandoen kan du se status for alle registrerede programmer.

Når du er færdig, kan du afslutte.

supervisor> quit

Webserverklienten

For at tillade adgang til supervisor-webserveren skal du åbne supervisor-konfigurationsfilen og finde [inet_http_server]sektionen.

nano /etc/supervisor/supervisord.conf

Opdater nu denne sektions konfiguration med følgende.

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

Udskift your_usernameog your_passwordgem dine ændringer og genstart supervisord-tjenesten med dine ønskede legitimationsoplysninger.

sudo systemctl restart supervisord.service

Husk at give TCPadgang til porten 9001på din firewall og derefter adgang http://{server-ip}:9001fra din browser. Når du bliver bedt om det, skal du angive dit usernameog password. Du kan nu styre dine processer fra nettet.

Konklusion

Vi har installeret den mest opdaterede version af supervisord, lært at konfigurere den til automatisk systemstart med systemd og også gennemgået en grundlæggende brug af supervisorctl. For mere avanceret konfiguration og brugssager kan du henvise til den officielle supervisor-dokumentation .