echo_supervisord_conf - Online în cloud

PROGRAM:

NUME

echo_supervisord_conf - Documentația de configurare a supraveghetorului

Supervisor este un sistem client/server care permite utilizatorilor săi să monitorizeze și să controleze un număr
a proceselor pe sisteme de operare asemănătoare UNIX.

Împărtășește unele dintre aceleași obiective ale unor programe precum launchd, daemontools și runit. Spre deosebire de
unele dintre aceste programe, nu este menit să fie rulat ca un substitut pentru înăuntru ca „id de proces
1". În schimb, este menit să fie folosit pentru a controla procese legate de un proiect sau un
client și este menit să pornească ca orice alt program la momentul pornirii.

DOCUMENTAȚIE

Crearea a Configuraţie Fișier
Odată ce instalarea Supervisor s-a încheiat, rulați echo_supervisord_conf. Asta va
tipăriți un fișier de configurare „eșantion” a Supervisorului pe stdout-ul terminalului dumneavoastră.

Odată ce vedeți că fișierul are ecou în terminalul dvs., reinvocați comanda ca
echo_supervisord_conf > /etc/supervisord.conf. Acest lucru nu va funcționa dacă nu aveți root
acces.

Dacă nu aveți acces root, sau preferați să nu puneți supraveghetor.conf fișier în
/etc/supervisord.conf`, îl puteți plasa în directorul curent (echo_supervisord_conf >
supraveghetor.conf) și începe supraveghetor cu -c steag pentru a specifica
locația fișierului de configurare.

De exemplu, supraveghetor -c supraveghetor.conf. Folosind -c steag este de fapt redundant în
acest caz, deoarece supraveghetor caută în directorul curent a supraveghetor.conf
înainte de a căuta în alte locații fișierul, dar va funcționa.

Odată ce aveți un fișier de configurare pe sistemul dvs. de fișiere, puteți începe să îl modificați la dvs
plăcere.

Configuraţie Fișier
Fișierul de configurare Supervisor este denumit în mod convențional supraveghetor.conf. Este folosit de
atât supraveghetor și supraveghetorctl. Dacă oricare dintre aplicații este pornită fără -c
opțiunea (opțiunea care este utilizată pentru a spune aplicației numele fișierului de configurare
explicit), aplicația va căuta un fișier numit supraveghetor.conf în cadrul
următoarele locații, în ordinea specificată. Va folosi primul fișier pe care îl găsește.

1. $CWD/supervisord.conf

2. $CWD/etc/supervisord.conf

3. /etc/supervisord.conf

4. ../etc/supervisord.conf (Relativ la executabil)

5. ../supervizord.conf (Relativ la executabil)

NOTĂ:
Unele distribuții au pachet Supervisor cu propriile lor personalizări. Aceste
versiunile modificate de Supervisor pot încărca fișierul de configurare din alte locații
decât cele descrise aici. În special, s-au găsit pachete Ubuntu care folosesc
/etc/supervisor/supervisord.conf.

Fișier Format
supraveghetor.conf este un fișier în stil Windows-INI (Python ConfigParser). Are secțiuni (fiecare
notat cu a [antet]) și perechi cheie/valoare din secțiuni. Secțiunile și lor
valorile admisibile sunt descrise mai jos.

Mediu inconjurator Variabile
Variabilele de mediu care sunt prezente în mediu la momentul în care supraveghetor is
start poate fi folosit în fișierul de configurare folosind sintaxa expresiei șirului Python
%(ENV_X)s:

[program:exemplu]
command=/usr/bin/example --loglevel=%(ENV_LOGLEVEL)s

În exemplul de mai sus, expresia %(ENV_LOGLEVEL)s ar fi extins la valoarea de
variabila de mediu LOGLEVEL.

NOTĂ:
În Supervisor 3.2 și mai târziu, %(ENV_X)s expresiile sunt acceptate în toate opțiunile. În
versiunile anterioare, unele opțiuni le acceptă, dar majoritatea nu. Consultați documentația pentru
fiecare opțiune de mai jos.

[unix_http_server] Secțiune setări cont
supraveghetor.conf fișierul conține o secțiune numită [unix_http_server] sub care
parametrii de configurare pentru un server HTTP care ascultă pe un socket de domeniu UNIX ar trebui să fie
introdus. Dacă fișierul de configurare are nr [unix_http_server] secțiunea, un domeniu UNIX
Serverul socket HTTP nu va fi pornit. Valorile de configurare permise sunt ca
urmează.

[unix_http_server] Secțiune Valori
fişier
O cale către un socket de domeniu UNIX (de ex /tmp/supervisord.sock) asupra căruia supraveghetorul va
ascultați solicitările HTTP/XML-RPC. supraveghetorctl folosește XML-RPC pentru a comunica
supraveghetor peste acest port. Această opțiune poate include valoarea %(aici)s, care se extinde
la directorul în care supraveghetor a fost găsit fișierul de configurare.

Mod implicit: Nici unul.

Necesar: Nu.

introdus: 3.0

chmod
Schimbați biții modului de permisiune UNIX ai soclului de domeniu UNIX la această valoare la
pornire.

Mod implicit: 0700

Necesar: Nu.

introdus: 3.0

chown
Schimbați utilizatorul și grupul fișierului socket la această valoare. Poate fi un nume de utilizator UNIX
(de exemplu mir) sau un nume de utilizator UNIX și un grup separate prin două puncte (de ex criz: roată).

Mod implicit: Utilizați numele de utilizator și grupul utilizatorului care începe supervizarea.

Necesar: Nu.

introdus: 3.0

nume de utilizator
Numele de utilizator necesar pentru autentificarea la acest server HTTP.

Mod implicit: Nu este necesar un nume de utilizator.

Necesar: Nu.

introdus: 3.0

parola
Parola necesară pentru autentificarea la acest server HTTP. Acesta poate fi un text clar
parola sau poate fi specificat ca hash SHA-1 dacă este prefixat de șir {SHA}. Pentru
exemplu, {SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d este versiunea stocată în SHA a
parola „parola”.

Rețineți că parola hashing trebuie să fie în format hex.

Mod implicit: Nu este necesară parola.

Necesar: Nu.

introdus: 3.0

[unix_http_server] Secțiune Exemplu
[unix_http_server]
fișier = /tmp/supervisor.sock
chmod = 0777
chown= nimeni:niciun grup
username = utilizator
parola = 123

[inet_http_server] Secțiune setări cont
supraveghetor.conf fișierul conține o secțiune numită [inet_http_server] sub care
parametrii de configurare pentru un server HTTP care ascultă pe un socket TCP (internet) ar trebui
fi introdus. Dacă fișierul de configurare are nr [inet_http_server] secțiunea, un HTTP inet
serverul nu va fi pornit. Valorile de configurare permise sunt următoarele.

[inet_http_server] Secțiune Valori
port
O gazdă TCP: valoare de port sau (de ex 127.0.0.1:9001) pe care supervizorul va asculta
Solicitări HTTP/XML-RPC. supraveghetorctl va folosi XML-RPC pentru a comunica cu supraveghetor
peste acest port. Pentru a asculta pe toate interfețele din aparat, utilizați : 9001 or *:9001.

Mod implicit: Fără implicit.

Necesar: Da.

introdus: 3.0

nume de utilizator
Numele de utilizator necesar pentru autentificarea la acest server HTTP.

Mod implicit: Nu este necesar un nume de utilizator.

Necesar: Nu.

introdus: 3.0

parola
Parola necesară pentru autentificarea la acest server HTTP. Acesta poate fi un text clar
parola sau poate fi specificat ca hash SHA-1 dacă este prefixat de șir {SHA}. Pentru
exemplu, {SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d este versiunea stocată în SHA a
parola „parola”.

Rețineți că parola hashing trebuie să fie în format hex.

Mod implicit: Nu este necesară parola.

Necesar: Nu.

introdus: 3.0

[inet_http_server] Secțiune Exemplu
[inet_http_server]
port = 127.0.0.1:9001
username = utilizator
parola = 123

[supraveghetor] Secțiune setări cont
supraveghetor.conf fișierul conține o secțiune numită [supraveghetor] în care setările globale
inrudit cu supraveghetor ar trebui introdus procesul. Acestea sunt după cum urmează.

[supraveghetor] Secțiune Valori
fișier jurnal
Calea către jurnalul de activitate al procesului de supraveghere. Această opțiune poate include
valoare %(aici)s, care se extinde în directorul în care configurația supravegheată
fisierul a fost gasit.

Mod implicit: $CWD/supervisord.log

Necesar: Nu.

introdus: 3.0

logfile_maxbytes
Numărul maxim de octeți care pot fi consumați de fișierul jurnal de activitate înainte ca acesta să fie
rotit (în valoare pot fi utilizați multiplicatori de sufix precum „KB”, „MB” și „GB”. A stabilit
această valoare la 0 pentru a indica o dimensiune nelimitată a jurnalului.

Mod implicit: 50 MB

Necesar: Nu.

introdus: 3.0

logfile_backups
Numărul de copii de rezervă de păstrat rezultat din rotația fișierului jurnal de activitate. Dacă este setat
la 0, nu vor fi păstrate copii de rezervă.

Mod implicit: 10

Necesar: Nu.

introdus: 3.0

nivel de jurnal
Nivelul de înregistrare, care dictează ceea ce este scris în jurnalul de activitate supervizor. Unul dintre
critic, eroare, avertiza, info, depana, urmări, Sau trăncănesc. Rețineți că la nivel de jurnal depana,
fișierul jurnal de supraveghere va înregistra ieșirea stderr/stdout a proceselor sale fii
și informații extinse despre modificările stării procesului, care sunt utile pentru depanarea a
proces care nu începe corect. Vezi și: activity_log_levels.

Mod implicit: informatii

Necesar: Nu.

introdus: 3.0

pidfile
Locația în care supervisord își păstrează fișierul pid. Această opțiune poate include
valoare %(aici)s, care se extinde în directorul în care configurația supravegheată
fisierul a fost gasit.

Mod implicit: $CWD/supervisor.pid

Necesar: Nu.

introdus: 3.0

masca
Masca procesului de supraveghere.

Mod implicit: 022

Necesar: Nu.

introdus: 3.0

nodaemon
Dacă este adevărat, supervisord va începe în prim-plan în loc să demonizeze.

Mod implicit: fals

Necesar: Nu.

introdus: 3.0

minfds
Numărul minim de descriptori de fișiere care trebuie să fie disponibili înainte ca supraveghetorul să o facă
începe cu succes. Se va apela la setrlimit pentru a încerca să ridice softul și
limitele dure ale procesului de supraveghere de satisfăcut minfds. Limita dură poate fi doar
generat dacă supervisord este rulat ca root. supervisord folosește descriptori de fișiere în mod generos și
va intra într-un mod de eșec atunci când unul nu poate fi obținut de la sistemul de operare, așa că este util să fie
capabil să specifice o valoare minimă pentru a se asigura că nu se epuizează în timpul execuției.
Această opțiune este utilă în special pe Solaris, care are o limită scăzută de fd per proces de
Mod implicit.

Mod implicit: 1024

Necesar: Nu.

introdus: 3.0

minprocs
Numărul minim de descriptori de proces care trebuie să fie disponibili înainte de supraveghere
va începe cu succes. Se va apela la setrlimit pentru a încerca să ridice softul
și limitele stricte ale procesului de supraveghere de satisfăcut minprocs. Limita dură poate
poate fi lansat numai dacă supervisord este rulat ca root. supervizorul va intra într-un mod de eșec
atunci când sistemul de operare rămâne fără descriptori de proces, deci este util să vă asigurați suficient
descriptorii de proces sunt disponibili pe supraveghetor pornire.

Mod implicit: 200

Necesar: Nu.

introdus: 3.0

nocleanup
Împiedicați supraveghetorul să elimine orice existent AUTO fișiere jurnal copii la momentul pornirii.
Util pentru depanare.

Mod implicit: fals

Necesar: Nu.

introdus: 3.0

childlogdir
Directorul folosit pentru AUTO fișiere jurnal copii. Această opțiune poate include valoarea
%(aici)s, care se extinde în directorul în care supraveghetor Fișier de configurare
a fost găsit.

Mod implicit: valoarea lui Python tempfile.get_tempdir()

Necesar: Nu.

introdus: 3.0

utilizator
Instrui supraveghetor pentru a comuta utilizatorii la acest cont de utilizator UNIX înainte de a face orice
prelucrare semnificativă. Utilizatorul poate fi schimbat numai dacă supraveghetor este început ca
utilizator root. Dacă supraveghetor nu pot schimba utilizatorii, va continua, dar va scrie a
jurnal mesaj la critic nivel spunând că nu poate renunța la privilegii.

Mod implicit: nu schimbați utilizatorii

Necesar: Nu.

introdus: 3.0

director
Cand supraveghetor daemonizes, comutați la acest director. Această opțiune poate include
valoare %(aici)s, care se extinde în directorul în care supraveghetor configuraţie
fisierul a fost gasit.

Mod implicit: nu cd

Necesar: Nu.

introdus: 3.0

strip_ansi
Eliminați toate secvențele de evacuare ANSI din fișierele jurnal copii.

Mod implicit: fals

Necesar: Nu.

introdus: 3.0

mediu inconjurator
O listă de perechi cheie/valoare din formular KEY="val",KEY2="val2" care va fi plasat în
supraveghetor mediul procesului (și, ca rezultat, în tot procesul său copil)
medii). Această opțiune poate include valoarea %(aici)s, care se extinde la
directorul în care a fost găsit fișierul de configurare supravegheat. Valori care conțin
caracterele non-alfanumerice trebuie citate (de ex KEY="val:123",KEY2="val,456").
În caz contrar, citarea valorilor este opțională, dar recomandată. Pentru a scăpa la sută
caractere, pur și simplu utilizați două. (de exemplu URI="/first%%20name") notițe că subprocesele vor
moștenește variabilele de mediu ale shell-ului folosit pentru a porni supraveghetor cu excepția
cele anulate aici și în cadrul programului mediu inconjurator opțiune. Vedea
subproces_mediu.

Mod implicit: fără valori

Necesar: Nu.

introdus: 3.0

identificator
Șirul de identificare pentru acest proces de supraveghere, utilizat de interfața RPC.

Mod implicit: supraveghetor

Necesar: Nu.

introdus: 3.0

[supraveghetor] Secțiune Exemplu
[supraveghetor]
jurnal = /tmp/supervisord.log
logfile_maxbytes = 50MB
logfile_backups=10
loglevel = info
pidfile = /tmp/supervisord.pid
nodaemon = false
minfds = 1024
minprocs = 200
umask = 022
user = crism
identificator = supraveghetor
director = / tmp
nocleanup = adevărat
childlogdir = / tmp
strip_ansi = false
mediu = KEY1="valoare1",KEY2="valoare2"

[supervizorctl] Secțiune setări cont
Fișierul de configurare poate conține setări pentru supraveghetorctl coajă interactivă
program. Aceste opțiuni sunt enumerate mai jos.

[supervizorctl] Secțiune Valori
serverurl
Adresa URL care ar trebui utilizată pentru a accesa serverul de supraveghere, de ex
http://localhost: 9001. Pentru socketurile de domeniu UNIX, utilizați
unix:///absolute/path/to/file.sock.

Mod implicit: http://localhost: 9001

Necesar: Nu.

introdus: 3.0

nume de utilizator
Numele de utilizator care trebuie transmis serverului de supraveghere pentru a fi utilizat la autentificare. Asta ar trebui
fi la fel ca nume de utilizator din configurația serverului de supraveghere pentru port sau UNIX
soclul de domeniu pe care încercați să îl accesați.

Mod implicit: Fără nume de utilizator

Necesar: Nu.

introdus: 3.0

parola
Parola care trebuie transmisă serverului de supraveghere pentru a fi utilizată în autentificare. Asta ar trebui
fie versiunea clară a parola din configurația serverului de supervizare pentru
portul sau soclul de domeniu UNIX pe care încercați să îl accesați. Această valoare nu poate fi transmisă ca
un hash SHA. Spre deosebire de alte parole specificate în acest fișier, acesta trebuie furnizat în
text clar.

Mod implicit: Fără parolă

Necesar: Nu.

introdus: 3.0

prompt
Șir folosit ca prompt de supraveghere.

Mod implicit: supraveghetor

Necesar: Nu.

introdus: 3.0

fişier_historial
O cale de folosit ca Citeste linia fișier istoric persistent. Dacă activați această funcție de
alegând o cale, comenzile dvs. supervisorctl vor fi păstrate în fișier și le puteți utiliza
readline (de exemplu, săgeată în sus) pentru a invoca comenzile pe care le-ați efectuat în ultimul dvs. supervisorctl
sesiune.

Mod implicit: Niciun fisier

Necesar: Nu.

introdus: 3.0a5

[supervizorctl] Secțiune Exemplu
[supervizorctl]
serverurl = unix:///tmp/supervisor.sock
nume de utilizator = chris
parola = 123
prompt = mysupervisor

[program:x] Secțiune setări cont
Fișierul de configurare trebuie să conțină unul sau mai multe program secțiuni pentru a fi supravegheate
pentru a ști ce programe ar trebui să pornească și să controleze. Valoarea antetului este o valoare compusă.
Este cuvântul „program”, urmat direct de două puncte, apoi de numele programului. Un antet
Valoarea [program:foo] descrie un program cu numele de „foo”. Numele este folosit
în cadrul aplicațiilor client care controlează procesele care sunt create ca urmare a acesteia
configurație. Este o eroare crearea unui program secțiune care nu are un nume. The
numele nu trebuie să includă un caracter două puncte sau un caracter paranteză. Valoarea numelui este
folosit ca valoare pentru %(program_name)s extinderea expresiei șirurilor în cadrul altor valori
unde este specificat.

NOTĂ:
A [program:x] secțiunea reprezintă de fapt un „grup de proces omogen” pentru supervizor
(de la 3.0). Membrii grupului sunt definiți prin combinația dintre numprocs
și numele procesului parametrii din configurație. În mod implicit, dacă numprocs și
process_name sunt lăsate neschimbate față de valorile implicite, grupul reprezentat de
[program:x] va fi numit x și va avea un singur proces numit x în ea. Acest
oferă un minim de compatibilitate cu versiunile mai vechi de supervizor, ceea ce a făcut
nu tratați secțiunile programului ca definiții omogene ale grupului de procese.

Dar, de exemplu, dacă aveți un [program:foo] secțiune cu a numprocs din 3 și a
numele procesului expresie a %(program_name)s_%(process_num)02d, grupul „foo” va
conţin trei procese, numite foo_00, foo_01, și foo_02. Acest lucru face posibil să
începeți un număr de procese foarte similare folosind un singur [program:x] secțiune. Toate
Numele fișierelor de jurnal, toate șirurile de mediu și comanda programelor pot conține, de asemenea
expresii de șir Python similare, pentru a transmite parametri ușor diferiți fiecăruia
proces.

[program:x] Secțiune Valori
comandă
Comanda care va fi executată la pornirea acestui program. Comanda poate fi fie
absolut (ex /cale/la/nume program) sau rudă (de ex numele programului). Dacă este
relativ, mediul supraveghetorului $ PATH va fi căutat executabilul.
Programele pot accepta argumente, de ex /cale/la/program foo bar. Linia de comandă poate folosi
ghilimele duble pentru a grupa argumente cu spații în ele pentru a le trece în program, de ex
/cale/la/program/nume -p „foo bar". Rețineți că valoarea lui comandă poate include Python
expresii cu șir, de ex /cale/la/nume program --port=80%(process_num)02d s-ar putea extinde
la /cale/la/nume program --port=8000 în timpul rulării. Sunt evaluate expresiile șiruri
față de un dicționar care conține cheile numele Grupului, nume_nod_gazdă, proces_num,
numele programului, aici (directorul fișierului de configurare supravegheat) și toate
variabilele de mediu ale supraveghetorului prefixate cu ENV_. Programele controlate ar trebui
ei înșiși să nu fie demoni, deoarece supervizorul presupune că este responsabil pentru demonizarea acestuia
subprocese (vezi nondaemonizing_of_subprocesses).

Mod implicit: Fără implicit.

Necesar: Da.

introdus: 3.0

numele procesului
O expresie șir Python care este utilizată pentru a compune numele procesului de supervizor pentru aceasta
proces. De obicei, nu trebuie să vă faceți griji cu privire la setarea acestui lucru decât dacă schimbați
numprocs. Expresia șir este evaluată în raport cu un dicționar care include
numele Grupului, nume_nod_gazdă, proces_num, numele programului, și aici (directorul
fişier de configurare supervisord).

Mod implicit: %(program_name)s

Necesar: Nu.

introdus: 3.0

numprocs
Supervizorul va porni atâtea instanțe ale acestui program câte sunt numite de numprocs. Notă
că dacă numprocs > 1, the numele procesului expresia trebuie să includă %(process_num)s (sau oricare
altă expresie de șir Python validă care include proces_num) în cadrul acestuia.

Mod implicit: 1

Necesar: Nu.

introdus: 3.0

numprocs_start
Un decalaj întreg care este utilizat pentru a calcula numărul la care numprocs începe.

Mod implicit: 0

Necesar: Nu.

introdus: 3.0

prioritate
Prioritatea relativă a programului în comanda de pornire și oprire. Inferior
prioritățile indică programele care pornesc primul și se închid ultimul la pornire și când
comenzile agregate sunt folosite în diverși clienți (de ex. „start all”/“stop all”). Superior
prioritățile indică programele care pornesc ultimul și se închid primul.

Mod implicit: 999

Necesar: Nu.

introdus: 3.0

autostart
Dacă este adevărat, acest program va porni automat când este pornită supravegherea.

Mod implicit: Adevărat

Necesar: Nu.

introdus: 3.0

startsecs
Numărul total de secunde pentru care programul trebuie să rămână în funcțiune după o pornire
considerați începutul reușit (mutarea procesului de la PORNIRE stare la
ALERGARE stat). Setat la 0 pentru a indica faptul că programul nu trebuie să rămână în funcțiune pentru niciunul
anumită perioadă de timp.

NOTĂ:
Chiar dacă un proces se încheie cu un cod de ieșire „așteptat” (vezi coduri de ieșire), începutul
va fi considerat în continuare un eșec dacă procesul iese mai repede decât startsecs.

Mod implicit: 1

Necesar: Nu.

introdus: 3.0

încercări de pornire
Numărul de încercări de eșec în serie care supraveghetor va permite atunci când încercați
porniți programul înainte de a renunța și a pune procesul într-un FATAL stat. Vedea
proces_state pentru explicarea FATAL de stat.

Mod implicit: 3

Necesar: Nu.

introdus: 3.0

pornire automată
Specifică dacă supraveghetor ar trebui să repornească automat un proces dacă iese atunci când este
în ALERGARE stat. Poate fi unul dintre fals, neaşteptat, Sau adevărat. Dacă fals, procesul
nu va fi pornit automat. Dacă neaşteptat, procesul va fi repornit atunci când
programul se iese cu un cod de ieșire care nu este unul dintre codurile de ieșire asociate cu acesta
configurația procesului (vezi coduri de ieșire). dacă adevărat, procesul va fi necondiționat
repornit când iese, fără a ține cont de codul său de ieșire.

NOTĂ:
pornire automată controlează dacă supraveghetor va porni automat un program dacă se iese
după ce a pornit cu succes (procesul este în ALERGARE stat).

supraveghetor are un mecanism de repornire diferit pentru momentul în care procesul pornește
(procesul este în PORNIRE stat). Reîncercările în timpul pornirii procesului sunt
controlat de startsecs și încercări de pornire.

Mod implicit: neașteptat

Necesar: Nu.

introdus: 3.0

coduri de ieșire
Lista codurilor de ieșire „așteptate” pentru acest program folosit cu pornire automată. Dacă
pornire automată parametrul este setat la neaşteptat, iar procesul iese în orice alt mod decât
ca urmare a unei cereri de oprire a supraveghetorului, supraveghetor va reporni procesul dacă acesta
ieșiri cu un cod de ieșire care nu este definit în această listă.

Mod implicit: 0,2

Necesar: Nu.

introdus: 3.0

semnal de oprire
Semnalul folosit pentru a opri programul atunci când este solicitată o oprire. Acesta poate fi oricare dintre TERM,
HUP, INT, QUIT, KILL, USR1 sau USR2.

Mod implicit: TERMEN

Necesar: Nu.

introdus: 3.0

stopwaitsecs
Numărul de secunde de așteptat pentru ca sistemul de operare să returneze un SIGCHILD supraveghetor după
programului i sa trimis un semnal de oprire. Dacă acest număr de secunde se scurge înainte
supraveghetor primește un SIGCHILD din proces, supraveghetor va încerca să-l omoare
cu un SIGKILL final.

Mod implicit: 10

Necesar: Nu.

introdus: 3.0

stopasgroup
Dacă este adevărat, indicatorul determină supervizorul să trimită semnalul de oprire către întregul grup de procese
și implică killasgroup este adevarat. Acest lucru este util pentru programe, cum ar fi Flask în depanare
modul, care nu propagă semnale de oprire copiilor lor, lăsându-i orfani.

Mod implicit: fals

Necesar: Nu.

introdus: 3.0b1

killasgroup
Dacă este adevărat, atunci când recurgeți la trimiterea SIGKILL la program pentru a-l termina, trimiteți-l la acesta
întreg grupul de proces în schimb, având grijă și de copiii săi, util de ex. cu
Programe Python care folosesc multiprocesare.

Mod implicit: fals

Necesar: Nu.

introdus: 3.0a11

utilizator
Instrui supraveghetor pentru a utiliza acest cont de utilizator UNIX ca cont care rulează
program. Utilizatorul poate fi schimbat numai dacă supraveghetor este rulat ca utilizator root. Dacă
supraveghetor nu se poate comuta la utilizatorul specificat, programul nu va fi pornit.

NOTĂ:
Utilizatorul va fi schimbat folosind potriveste ora numai. Acest lucru nu pornește un shell de conectare și
nu modifică variabilele de mediu cum ar fi USER or ACASA. Vedea
subprocess_environment pentru detalii.

Mod implicit: Nu schimbați utilizatorii

Necesar: Nu.

introdus: 3.0

redirect_stderr
Dacă este adevărat, faceți ca rezultatul stderr al procesului să fie trimis înapoi la supraveghetor pe stdout-ul său
descriptor de fișier (în termenii shell UNIX, acesta este echivalentul executării /programul
2> & 1).

NOTĂ:
Nu setați redirect_stderr=adevărat într-un [eventlistener:x] secțiune. Ascultători de evenimente
utilizare stdout și stdin pentru a comunica cu supraveghetor. Dacă stderr este redirecționat,
ieșire de la stderr va interfera cu protocolul eventlistener.

Mod implicit: fals

Necesar: Nu.

introdus: 3.0, înlocuiește 2.0 log_stdout și log_stderr

stdout_logfile
Puneți rezultatul procesului stdout în acest fișier (și dacă redirect_stderr este adevărat, plasați de asemenea
ieșire stderr în acest fișier). Dacă stdout_logfile este dezactivat sau setat la AUTO, supraveghetor
va alege automat o locație a fișierului. Dacă acesta este setat la NONE, va supervizor
nu creați niciun fișier jurnal. AUTO fișierele jurnal și copiile de siguranță ale acestora vor fi șterse când supraveghetor
repornește. The stdout_logfile value poate conține expresii de șir Python care vor
evaluate pe baza unui dicționar care conține cheile numele Grupului, nume_nod_gazdă,
proces_num, numele programului, și aici (directorul fișierului de configurare supravegheat).

NOTĂ:
Nu este posibil ca două procese să partajeze un singur fișier jurnal (stdout_logfile)
la rotire (stdout_logfile_maxbytes) este activat. Acest lucru va avea ca rezultat fișierul
fiind corupt.

Mod implicit: AUTO

Necesar: Nu.

introdus: 3.0, înlocuiește 2.0 fișier jurnal

stdout_logfile_maxbytes
Numărul maxim de octeți care pot fi consumați de stdout_logfile înainte de a fi rotit
(În valoare pot fi utilizați multiplicatori de sufix precum „KB”, „MB” și „GB”. Setează asta
valoare la 0 pentru a indica o dimensiune nelimitată a jurnalului.

Mod implicit: 50 MB

Necesar: Nu.

introdus: 3.0, înlocuiește 2.0 logfile_maxbytes

stdout_logfile_backups
Numărul de stdout_logfile copii de rezervă de păstrat rezultate din jurnalul stdout al procesului
rotația fișierelor. Dacă este setată la 0, nu vor fi păstrate copii de rezervă.

Mod implicit: 10

Necesar: Nu.

introdus: 3.0, înlocuiește 2.0 logfile_backups

stdout_capture_maxbytes
Numărul maxim de octeți scriși pentru a captura FIFO atunci când procesul este în „modul de capturare stdout”
(vezi capture_mode). Ar trebui să fie un număr întreg (multiplicatori de sufix precum „KB”, „MB” și „GB”
poate fi folosit în valoare). Dacă această valoare este 0, modul de capturare a procesului va fi dezactivat.

Mod implicit: 0

Necesar: Nu.

introdus: 3.0, înlocuiește 2.0 logfile_backups

stdout_events_enabled
Dacă este adevărat, evenimentele PROCESS_LOG_STDOUT vor fi emise atunci când procesul scrie în el
descriptor de fișier stdout. Evenimentele vor fi emise numai dacă descriptorul de fișier nu este
în modul de captură în momentul în care datele sunt primite (vezi capture_mode).

Mod implicit: 0

Necesar: Nu.

introdus: 3.0a7

stderr_logfile
Puneți rezultatul procesului stderr în acest fișier, cu excepția cazului în care redirect_stderr este adevarat. Acceptă
aceleași tipuri de valori ca stdout_logfile și poate conține aceleași expresii de șir Python.

NOTĂ:
Nu este posibil ca două procese să partajeze un singur fișier jurnal (stderr_logfile)
la rotire (stderr_logfile_maxbytes) este activat. Acest lucru va avea ca rezultat fișierul
fiind corupt.

Mod implicit: AUTO

Necesar: Nu.

introdus: 3.0

stderr_logfile_maxbytes
Numărul maxim de octeți înainte de rotația fișierului jurnal pentru stderr_logfile. Acceptă
aceleași tipuri de valori ca stdout_logfile_maxbytes.

Mod implicit: 50 MB

Necesar: Nu.

introdus: 3.0

stderr_logfile_backups
Numărul de copii de rezervă de păstrat rezultat din rotația fișierului jurnal stderr proces.
Dacă este setată la 0, nu vor fi păstrate copii de rezervă.

Mod implicit: 10

Necesar: Nu.

introdus: 3.0

stderr_capture_maxbytes
Numărul maxim de octeți scriși pentru a captura FIFO atunci când procesul este în „modul de capturare stderr”
(vezi capture_mode). Ar trebui să fie un număr întreg (multiplicatori de sufix precum „KB”, „MB” și „GB”
poate fi folosit în valoare). Dacă această valoare este 0, modul de capturare a procesului va fi dezactivat.

Mod implicit: 0

Necesar: Nu.

introdus: 3.0

stderr_events_enabled
Dacă este adevărat, evenimentele PROCESS_LOG_STDERR vor fi emise atunci când procesul scrie în el
descriptor de fișier stderr. Evenimentele vor fi emise numai dacă descriptorul de fișier nu este
în modul de captură în momentul în care datele sunt primite (vezi capture_mode).

Mod implicit: fals

Necesar: Nu.

introdus: 3.0a7

mediu inconjurator
O listă de perechi cheie/valoare din formular KEY="val",KEY2="val2" care va fi plasat în
mediul procesului copilului. Șirul de mediu poate conține șir Python
expresii care vor fi evaluate în raport cu un dicționar care conține numele Grupului,
nume_nod_gazdă, proces_num, numele programului, și aici (directorul supraveghetorului
fișier de configurare). Valorile care conțin caractere non-alfanumerice trebuie citate (de ex
KEY="val:123",KEY2="val,456"). În caz contrar, citarea valorilor este opțională, dar
recomandată. notițe că subprocesul va moșteni variabilele de mediu ale
Shell obișnuia să pornească „supervizorul”, cu excepția celor suprascrise aici. Vedea
subproces_mediu.

Mod implicit: Fără mediu suplimentar

Necesar: Nu.

introdus: 3.0

director
O cale de fișier reprezentând un director către care supraveghetor ar trebui să chdir temporar
înainte de a executa copilul.

Mod implicit: Fără chdir (moștenește supervizorul)

Necesar: Nu.

introdus: 3.0

masca
Un număr octal (de ex. 002, 022) reprezentând umask-ul procesului.

Mod implicit: Fără umask special (moștenește supervizorul)

Necesar: Nu.

introdus: 3.0

serverurl
URL-ul transmis în mediu către procesul de subproces ca SUPERVISOR_SERVER_URL
(A se vedea supraveghetor.childutils) pentru a permite subprocesului să comunice ușor cu
server HTTP intern. Dacă este furnizat, ar trebui să aibă aceeași sintaxă și structură ca și
[supervizorctl] opțiunea de secțiune cu același nume. Dacă acesta este setat la AUTO sau este dezactivat,
supervizorul va construi automat o adresă URL a serverului, dând preferință unui server
care ascultă pe socket-uri de domeniu UNIX peste unul care ascultă pe un socket de internet.

Mod implicit: AUTO

Necesar: Nu.

introdus: 3.0

[program:x] Secțiune Exemplu
[program:cat]
comanda =/bin/cat
process_name=%(nume_program)s
numprocs=1
director=/ tmp
umask=022
prioritate = 999
autostart = adevărat
pornire automată=neașteptat
startsecs=10
startretry=3
coduri de ieșire=0,2
stopsignal=TERM
stopwaitsecs=10
stopasgroup=fals
killasgroup=fals
utilizator=Chrism
redirect_stderr=fals
stdout_logfile=/a/path
stdout_logfile_maxbytes=1MB
stdout_logfile_backups=10
stdout_capture_maxbytes=1MB
stdout_events_enabled=fals
stderr_logfile=/a/path
stderr_logfile_maxbytes=1MB
stderr_logfile_backups=10
stderr_capture_maxbytes=1MB
stderr_events_enabled=fals
mediu=A="1",B="2"
serverurl=AUTO

[include] Secțiune setări cont
supraveghetor.conf fișierul poate conține o secțiune numită [include]. Dacă configurația
fișierul conține un [include] secțiunea, trebuie să conțină o singură cheie numită „fișiere”. The
valorile din această cheie specifică alte fișiere de configurare care urmează să fie incluse în
configurare.

[include] Secțiune Valori
fișiere
O secvență separată de spațiu de globuri de fișiere. Fiecare glob de fișier poate fi absolut sau relativ.
Dacă fișierul glob este relativ, acesta este considerat relativ la locația fișierului
fișier de configurare care îl include. Un „glob” este un model de fișier care se potrivește cu a
model specificat conform regulilor utilizate de shell-ul Unix. Nu există expansiune tilde
gata, dar *, ?, și intervale de caractere exprimate cu [] vor fi potrivite corect.
Includerile recursive din fișierele incluse nu sunt acceptate.

Mod implicit: Fără implicit (obligatoriu)

Necesar: Da.

introdus: 3.0

[include] Secțiune Exemplu
[include]
fișiere = /an/absolute/filename.conf /an/absolute/*.conf foo.conf config??.conf

[grup:x] Secțiune setări cont
Este adesea util să grupați grupuri de procese „omogene” (alias „programe”) împreună într-un
grup de procese „eterogen”, astfel încât acestea să poată fi controlate ca o unitate de la Supervizor
diverse interfețe de controler.

Pentru a plasa programele într-un grup, astfel încât să le puteți trata ca o unitate, definiți a [grup:x] secțiune
în fișierul dvs. de configurare. Valoarea antetului grupului este compusă. Este cuvântul
„grup”, urmat direct de două puncte, apoi numele grupului. O valoare de antet de [grup:foo]
descrie un grup cu numele de „foo”. Numele este folosit în aplicațiile client
care controlează procesele care sunt create ca urmare a acestei configurații. Este un
eroare de a crea un grup secțiune care nu are un nume. Numele nu trebuie să includă a
caractere două puncte sau un caracter paranteză.

Pentru o [grup:x], trebuie să existe unul sau mai multe [program:x] secțiuni în altă parte din dvs
fișier de configurare, iar grupul trebuie să se refere la ele după nume în fișierul programe valoare.

Dacă grupurile de procese „omogene” (reprezentate prin secțiuni de program) sunt plasate în a
grup „eterogen” via [grup:x] secțiunii programe linie, grupurile omogene care
sunt implicate de secțiunea de program nu vor exista în timpul execuției în supervizor. În schimb, toate
procesele aparţinând fiecăreia dintre grupele omogene vor fi plasate în
grup eterogen. De exemplu, având în vedere următoarea configurație de grup:

[grup:foo]
programe=bar,baz
prioritate = 999

Având în vedere cele de mai sus, la pornirea supervizată, bar și Baz grupuri omogene nu vor
există, iar procesele care ar fi fost sub ele vor fi acum mutate în foo
grup.

[grup:x] Secțiune Valori
programe
O listă de nume de programe separate prin virgulă. Programele care sunt listate devin membri
a grupului.

Mod implicit: Fără implicit (obligatoriu)

Necesar: Da.

introdus: 3.0

prioritate
Un număr prioritar analog cu a [program:x] valoare prioritară atribuită grupului.

Mod implicit: 999

Necesar: Nu.

introdus: 3.0

[grup:x] Secțiune Exemplu
[grup:foo]
programe=bar,baz
prioritate = 999

[fcgi-program:x] Secțiune setări cont
Supervizorul poate gestiona grupuri de FastCGI procese care ascultă toate pe același socket.
Până acum, flexibilitatea de implementare pentru FastCGI a fost limitată. Pentru a obține procesul complet
management, ai putea folosi mod_fastcgi sub Apache, dar apoi ai rămas blocat cu Apache
model de concurență ineficient al unui proces sau fir pe conexiune. Pe lângă
necesitând mai multe resurse CPU și memorie, modelul proces/thread per conexiune poate fi
saturat rapid de o resursă lentă, împiedicând alte resurse să fie servite. În
pentru a profita de serverele web mai noi, bazate pe evenimente, cum ar fi lighttpd sau nginx care
nu includeți un manager de proces încorporat, a trebuit să utilizați scripturi precum cgi-fcgi sau
spawn-fcgi. Acestea pot fi utilizate împreună cu un manager de proces, cum ar fi supervizorul
sau daemontools, dar necesită ca fiecare proces copil FastCGI să se lege la propriul socket. The
dezavantajele acestui lucru sunt: ​​configurare inutil de complicată a serverului web, lipsită de grație
reporniri și toleranță redusă la erori. Cu mai puține prize de configurat, server web
configurațiile sunt mult mai mici dacă grupurile de procese FastCGI pot partaja socket-uri. Impartit
socket-urile permit reporniri grațioase, deoarece socket-ul rămâne legat de procesul părinte
în timp ce oricare dintre procesele copil este repornit. În cele din urmă, prizele partajate sunt mai multe
tolerant la erori, deoarece dacă un anumit proces eșuează, alte procese pot continua să funcționeze
conexiuni de intrare.

Cu suportul integrat de generare FastCGI, Supervisor vă oferă tot ce este mai bun din ambele lumi.
Obțineți un management complet al proceselor cu grupuri de procese FastCGI care partajează socket-uri
fără a fi legat de un anumit server web. Este o separare curată a preocupărilor,
permițând serverului web și managerului de proces să facă fiecare ceea ce face cel mai bine.

NOTĂ:
Managerul de socket din Supervisor a fost dezvoltat inițial pentru a sprijini procesele FastCGI
dar nu se limitează la FastCGI. Pot fi utilizate și alte protocoale fără special
configurație. Orice program care poate accesa un socket deschis dintr-un descriptor de fișier (de ex
cu socket.fromfd în Python) poate folosi managerul de socket. Supraveghetorul va
creați automat priza, legați și ascultați înainte de a bifurca primul copil dintr-un
grup. Socket-ul va fi transmis fiecărui copil pe numărul de descriptor al fișierului 0 (zero).
Când ultimul copil din grup iese, Supervizorul va închide priza.

Toate opțiunile disponibile pentru [program:x] sectiunile sunt de asemenea respectate de fcgi-program
secțiuni.

[fcgi-program:x] Secțiune Valori
[fcgi-program:x] secţiunile au o singură cheie care [program:x] secţiunile nu au.

priză
Socket-ul FastCGI pentru acest program, fie socket de domeniu TCP, fie UNIX. Pentru socket-uri TCP,
utilizați acest format: tcp://localhost:9002. Pentru socketurile de domeniu UNIX, utilizați
unix:///absolute/path/to/file.sock. Expresiile șiruri sunt evaluate în raport cu a
dicționar care conține cheile „nume_program” și „aici” (directorul
fişier de configurare supervisord).

Mod implicit: Fără implicit.

Necesar: Da.

introdus: 3.0

proprietar_socket
Pentru socketurile de domeniu UNIX, acest parametru poate fi utilizat pentru a specifica utilizatorul și grupul pentru
soclul FastCGI. Poate fi un nume de utilizator UNIX (de exemplu, chrism) sau un nume de utilizator UNIX și un grup
separate prin două puncte (ex. criz:roată).

Mod implicit: Utilizează setul de utilizator și grup pentru programul fcgi

Necesar: Nu.

introdus: 3.0

socket_mode
Pentru socketurile de domeniu UNIX, acest parametru poate fi utilizat pentru a specifica modul de permisiune.

Mod implicit: 0700

Necesar: Nu.

introdus: 3.0

Recomandare [program:x] Secțiune setări cont pentru alte chei permise, deltați constrângerile de mai sus
si adaosuri.

[fcgi-program:x] Secțiune Exemplu
[fcgi-program:fcgiprogramname]
command=/usr/bin/example.fcgi
socket=unix:///var/run/supervisor/%(nume_program)s.sock
socket_owner=Chrism
socket_mode=0700
process_name=%(program_name)s_%(process_num)02d
numprocs=5
director=/ tmp
umask=022
prioritate = 999
autostart = adevărat
pornire automată=neașteptat
startsecs=1
startretry=3
coduri de ieșire=0,2
stopsignal=ÎNSĂRĂ
stopasgroup=fals
killasgroup=fals
stopwaitsecs=10
utilizator=Chrism
redirect_stderr=adevărat
stdout_logfile=/a/path
stdout_logfile_maxbytes=1MB
stdout_logfile_backups=10
stdout_events_enabled=fals
stderr_logfile=/a/path
stderr_logfile_maxbytes=1MB
stderr_logfile_backups=10
stderr_events_enabled=fals
mediu=A="1",B="2"
serverurl=AUTO

[eventlistener:x] Secțiune setări cont
Supervizorul permite să existe grupuri de procese omogene specializate („grupuri de ascultători de evenimente”)
definite în fișierul de configurare. Aceste pool-uri conțin procese care sunt menite să
primiți și răspundeți la notificări de evenimente de la sistemul de evenimente al supervizorului. Vezi evenimente pentru
o explicație a modului în care funcționează evenimentele și a modului de implementare a programelor care pot fi declarate ca
ascultători de evenimente.

Rețineți că toate opțiunile disponibile pentru [program:x] secțiunile sunt respectate de eventlistener
secțiuni cu excepția pentru stdout_capture_maxbytes și stderr_capture_maxbytes (ascultători de evenimente
nu poate emite evenimente de comunicare de proces, vezi capture_mode).

[eventlistener:x] Secțiune Valori
[eventlistener:x] secţiunile au câteva chei care [program:x] secţiunile nu au.

dimensiunea memoriei tampon
Dimensiunea tamponului de cozi de evenimente a pool-ului de ascultători de evenimente. Când tamponul de evenimente al unui grup de ascultători
este depășit (cum se poate întâmpla atunci când un grup de ascultători de evenimente nu poate ține pasul cu toate
evenimente trimise către acesta), cel mai vechi eveniment din buffer este eliminat.

evenimente
O listă de nume de tipuri de evenimente, separate prin virgulă, de care este „interesat” acest ascultător
primirea notificărilor pentru (consultați event_types pentru o listă de nume valide de tip de eveniment).

handler_rezultat
A pkg_resources intrare punct şir care se rezolvă la un Python apelabil. Implicit
valoarea este supervisor.dispatchers:default_handler. Specificarea unui rezultat alternativ
handler-ul este un lucru foarte neobișnuit pe care trebuie să-l faci și, prin urmare, modul de a crea unul este
nedocumentat.

Recomandare [program:x] Secțiune setări cont pentru alte chei permise, deltați constrângerile de mai sus
si adaosuri.

[eventlistener:x] Secțiune Exemplu
[eventlistener:theeventlistenername]
command=/bin/eventlistener
process_name=%(program_name)s_%(process_num)02d
numprocs=5
evenimente=PROCESS_STATE
buffer_size=10
director=/ tmp
umask=022
prioritate=-1
autostart = adevărat
pornire automată=neașteptat
startsecs=1
startretry=3
coduri de ieșire=0,2
stopsignal=ÎNSĂRĂ
stopwaitsecs=10
stopasgroup=fals
killasgroup=fals
utilizator=Chrism
redirect_stderr=fals
stdout_logfile=/a/path
stdout_logfile_maxbytes=1MB
stdout_logfile_backups=10
stdout_events_enabled=fals
stderr_logfile=/a/path
stderr_logfile_maxbytes=1MB
stderr_logfile_backups=10
stderr_events_enabled=fals
mediu=A="1",B="2"
serverurl=AUTO

[rpcinterface:x] Secțiune setări cont
Adăugare rpcinterface:x setările din fișierul de configurare sunt utile numai pentru persoanele care
doresc să extindă supervizorul cu un comportament personalizat suplimentar.

În fișierul de configurare exemplu, există o secțiune care este numită [rpcinterface:supervizor].
În mod implicit, arată astfel.

[rpcinterface:supervizor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface

[rpcinterface:supervizor] secțiune trebuie sa rămâne în configurația pentru standard
configurarea supervizorului pentru a funcționa corect. Dacă nu vrei ca supervizorul să facă nimic
nu face deja din cutie, acesta este tot ce trebuie să știți despre acest tip de
secţiune.

Cu toate acestea, dacă doriți să adăugați spații de nume de interfață rpc pentru a personaliza supervizorul, dvs
poate adăuga suplimentar [rpcinterface:foo] secțiuni, unde „foo” reprezintă spațiul de nume al
interfața (de la rădăcina web) și valoarea numită de supervisor.rpcinterface_factory
este un apelabil din fabrică care ar trebui să aibă o semnătură de funcție care acceptă o singură
argument pozițional supraveghetor și atâtea argumente de cuvinte cheie câte sunt necesare
configurație. Orice pereche cheie/valoare suplimentară definită în [rpcinterface:x] secţiunea va
să fie transmise ca argumente de cuvinte cheie către fabrică.

Iată un exemplu de funcție din fabrică, creată în __init__.py fișierul Python
pachet pachetul meu.

din my.package.rpcinterface import AnotherRPCInterface

def make_another_rpcinterface(supervizor, **config):
reîncercări = int(config.get('reîncercări', 0))
another_rpc_interface = AnotherRPCInterface (supraveghere, reîncercări)
returnează another_rpc_interface

Și o secțiune din fișierul de configurare menită să-l configureze.

[rpcinterface:altul]
supervisor.rpcinterface_factory = my.package:make_another_rpcinterface
reîncercări = 1

[rpcinterface:x] Secțiune Valori
supervisor.rpcinterface_factory
pkg_resources Numele punctat „punct de intrare” în funcția din fabrică a interfeței RPC.

Mod implicit: N / A

Necesar: Nu.

introdus: 3.0

[rpcinterface:x] Secțiune Exemplu
[rpcinterface:altul]
supervisor.rpcinterface_factory = my.package:make_another_rpcinterface
reîncercări = 1

Glosar
daemontools
A proces Control sistem by DJ Bernstein.

lansatd
A proces Control sistem utilizat by Apple ca procesul 1 sub Mac OS X.

rulați-l A proces Control sistem.

Superlance
Un pachet care oferă diverse implementări de ascultător de evenimente care se conectează la
Supervizor care poate ajuta la monitorizarea procesului de utilizare a memoriei și a stării de blocare:
http://pypi.python.org/pypi/superlance.

masca Abrevierea lui utilizator masca: setează masca de creare a modului fișier a procesului curent.
Vedea http://en.wikipedia.org/wiki/Umask.

Utilizați echo_supervisord_conf online folosind serviciile onworks.net