echo_supervisord_conf - En ligne dans le Cloud

PROGRAMME:

Nom

echo_supervisord_conf - Documentation de configuration du superviseur

Supervisor est un système client/serveur qui permet à ses utilisateurs de surveiller et de contrôler un certain nombre
des processus sur des systèmes d'exploitation de type UNIX.

Il partage certains des mêmes objectifs que des programmes tels que launchd, daemontools et runit. contrairement à
certains de ces programmes, il n'est pas destiné à remplacer init comme "ID de processus
1". Au lieu de cela, il est destiné à être utilisé pour contrôler les processus liés à un projet ou un
client, et est destiné à démarrer comme n'importe quel autre programme au moment du démarrage.

DOCUMENTATION

La création a configuration Déposez votre dernière attestation
Une fois l'installation de Supervisor terminée, exécutez echo_supervisord_conf. Cette volonté
imprimez un "exemple" de fichier de configuration Supervisor sur la sortie standard de votre terminal.

Une fois que vous voyez le fichier renvoyé sur votre terminal, appelez à nouveau la commande en tant que
echo_supervisord_conf > /etc/superviseur.conf. Cela ne fonctionnera pas si vous n'avez pas root
accéder.

Si vous n'avez pas d'accès root, ou si vous préférez ne pas mettre le superviseur.conf fichier dans
/etc/superviseur.conf`, vous pouvez le placer dans le répertoire courant (echo_supervisord_conf >
superviseur.conf) et commencer superviseur les -c drapeau afin de spécifier le
emplacement du fichier de configuration.

Par exemple, superviseur -c superviseur.conf. En utilisant le -c le drapeau est en fait redondant dans
ce cas, parce que superviseur recherche dans le répertoire courant un superviseur.conf
avant de rechercher d'autres emplacements pour le fichier, mais cela fonctionnera.

Une fois que vous avez un fichier de configuration sur votre système de fichiers, vous pouvez commencer à le modifier dans votre
aimer.

configuration Déposez votre dernière attestation
Le fichier de configuration Supervisor est classiquement nommé superviseur.conf. Il est utilisé par
tous les deux superviseur ainsi que superviseur. Si l'une des applications est démarrée sans le -c
option (l'option qui est utilisée pour indiquer à l'application le nom du fichier de configuration
explicitement), l'application recherchera un fichier nommé superviseur.conf au sein du
emplacements suivants, dans l'ordre spécifié. Il utilisera le premier fichier qu'il trouvera.

1. $CWD/superviseur.conf

2. $CWD/etc/superviseur.conf

3. /etc/superviseur.conf

4. ../etc/superviseur.conf (Par rapport à l'exécutable)

5. ../superviseur.conf (Par rapport à l'exécutable)

REMARQUE:
Certaines distributions ont empaqueté Supervisor avec leurs propres personnalisations. Ces
les versions modifiées de Supervisor peuvent charger le fichier de configuration à partir d'autres emplacements
que celles décrites ici. Notamment, des packages Ubuntu ont été trouvés qui utilisent
/etc/supervisor/supervisord.conf.

Déposez votre dernière attestation Format
superviseur.conf est un fichier de style Windows-INI (Python ConfigParser). Il a des sections (chacune
désigné par un [entête]) et des paires clé/valeur dans les sections. Les sections et leurs
les valeurs admissibles sont décrites ci-dessous.

Environment Variables
Les variables d'environnement qui sont présentes dans l'environnement au moment où superviseur is
start peut être utilisé dans le fichier de configuration à l'aide de la syntaxe d'expression de chaîne Python
%(ENV_X)s:

[programme:exemple]
commande=/usr/bin/exemple --loglevel=%(ENV_LOGLEVEL)s

Dans l'exemple ci-dessus, l'expression %(ENV_LOGLEVEL)s serait étendu à la valeur de
la variable d'environnement NIVEAU DE CONNEXION.

REMARQUE:
Dans Supervisor 3.2 et versions ultérieures, %(ENV_X)s les expressions sont prises en charge dans toutes les options. Dans
versions antérieures, certaines options les prennent en charge, mais pas la plupart. Voir la documentation pour
chaque option ci-dessous.

[unix_http_serveur] Section Paramètres
La superviseur.conf le fichier contient une section nommée [unix_http_serveur] sous lequel
les paramètres de configuration d'un serveur HTTP qui écoute sur un socket de domaine UNIX doivent être
inséré. Si le fichier de configuration n'a pas [unix_http_serveur] section, un domaine UNIX
Le serveur HTTP socket ne sera pas démarré. Les valeurs de configuration autorisées sont les
suit.

[unix_http_serveur] Section Valeurs
filet
Un chemin vers un socket de domaine UNIX (par exemple /tmp/supervisord.sock) sur quel superviseur
écouter les requêtes HTTP/XML-RPC. superviseur utilise XML-RPC pour communiquer avec
superviseur sur ce port. Cette option peut inclure la valeur %(ici)s, qui s'étend
au répertoire dans lequel le superviseur fichier de configuration a été trouvé.

Réglage par défaut: Aucun.

Requis: Non

Introduit: 3.0

chmod
Remplacez les bits de mode d'autorisation UNIX du socket de domaine UNIX par cette valeur à
Commencez.

Réglage par défaut: 0700

Requis: Non

Introduit: 3.0

chown
Remplacez l'utilisateur et le groupe du fichier socket par cette valeur. Peut être un nom d'utilisateur UNIX
(par exemple chrism) ou un nom d'utilisateur et un groupe UNIX séparés par deux points (par exemple chrême:roue).

Réglage par défaut: Utilisez le nom d'utilisateur et le groupe de l'utilisateur qui démarre superviseur.

Requis: Non

Introduit: 3.0

Nom d'utilisateur
Le nom d'utilisateur requis pour l'authentification sur ce serveur HTTP.

Réglage par défaut: Aucun nom d'utilisateur requis.

Requis: Non

Introduit: 3.0

Mot de passe
Le mot de passe requis pour l'authentification sur ce serveur HTTP. Cela peut être un texte clair
mot de passe, ou peut être spécifié en tant que hachage SHA-1 s'il est préfixé par la chaîne {SHA}. For
Par exemple, {SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d est la version stockée par SHA du
mot de passe "lemot de passe".

Notez que le mot de passe haché doit être au format hexadécimal.

Réglage par défaut: Aucun mot de passe requis.

Requis: Non

Introduit: 3.0

[unix_http_serveur] Section Exemple
[unix_http_serveur]
fichier = /tmp/superviseur.sock
chmod = 0777
chown=personne:nogroup
nom d'utilisateur = utilisateur
mot de passe = 123

[inet_http_serveur] Section Paramètres
La superviseur.conf le fichier contient une section nommée [inet_http_serveur] sous lequel
les paramètres de configuration d'un serveur HTTP qui écoute sur un socket TCP (internet) doivent
être inséré. Si le fichier de configuration n'a pas [inet_http_serveur] section, un inet HTTP
le serveur ne sera pas démarré. Les valeurs de configuration autorisées sont les suivantes.

[inet_http_serveur] Section Valeurs
port
Un hôte TCP:valeur de port ou (par exemple 127.0.0.1:9001) sur lequel le superviseur écoutera
Requêtes HTTP/XML-RPC. superviseur utilisera XML-RPC pour communiquer avec superviseur
sur ce port. Pour écouter sur toutes les interfaces de la machine, utilisez : 9001 or *:9001.

Réglage par défaut: Aucun défaut.

Requis: Oui.

Introduit: 3.0

Nom d'utilisateur
Le nom d'utilisateur requis pour l'authentification sur ce serveur HTTP.

Réglage par défaut: Aucun nom d'utilisateur requis.

Requis: Non

Introduit: 3.0

Mot de passe
Le mot de passe requis pour l'authentification sur ce serveur HTTP. Cela peut être un texte clair
mot de passe, ou peut être spécifié en tant que hachage SHA-1 s'il est préfixé par la chaîne {SHA}. For
Par exemple, {SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d est la version stockée par SHA du
mot de passe "lemot de passe".

Notez que le mot de passe haché doit être au format hexadécimal.

Réglage par défaut: Aucun mot de passe requis.

Requis: Non

Introduit: 3.0

[inet_http_serveur] Section Exemple
[inet_http_serveur]
port = 127.0.0.1:9001
nom d'utilisateur = utilisateur
mot de passe = 123

[superviseur] Section Paramètres
La superviseur.conf le fichier contient une section nommée [superviseur] dans quels paramètres globaux
au niveau de la superviseur processus doit être inséré. Ce sont les suivants.

[superviseur] Section Valeurs
fichier journal
Le chemin d'accès au journal d'activité du processus supervisé. Cette option peut inclure le
Plus-value %(ici)s, qui se développe jusqu'au répertoire dans lequel la configuration supervisée
fichier a été trouvé.

Réglage par défaut: $CWD/superviseur.log

Requis: Non

Introduit: 3.0

fichier journal_maxoctets
Le nombre maximal d'octets pouvant être consommés par le fichier journal d'activité avant qu'il ne soit
tourné (des multiplicateurs de suffixe tels que "KB", "MB" et "GB" peuvent être utilisés dans la valeur). Régler
cette valeur à 0 pour indiquer une taille de journal illimitée.

Réglage par défaut: 50MB

Requis: Non

Introduit: 3.0

fichier_journal_sauvegardes
Le nombre de sauvegardes à conserver résultant de la rotation des fichiers journaux d'activité. Si défini
à 0, aucune sauvegarde ne sera conservée.

Réglage par défaut: 10

Requis: Non

Introduit: 3.0

loglevel
Le niveau de journalisation, dictant ce qui est écrit dans le journal d'activité supervisé. Un des
critique, erreur, prévenir, info, déboguer, tracerou bêtises. Notez qu'au niveau du journal déboguer,
le fichier journal supervisé enregistrera la sortie stderr/stdout de ses processus enfants
et des informations étendues sur les changements d'état du processus, ce qui est utile pour déboguer un
processus qui ne démarre pas correctement. Voir aussi : activity_log_levels.

Réglage par défaut: Info

Requis: Non

Introduit: 3.0

fichier pid
L'emplacement dans lequel superviseurd conserve son fichier pid. Cette option peut inclure le
Plus-value %(ici)s, qui se développe jusqu'au répertoire dans lequel la configuration supervisée
fichier a été trouvé.

Réglage par défaut: $CWD/superviseur.pid

Requis: Non

Introduit: 3.0

umask
L'umask du processus supervisé.

Réglage par défaut: 022

Requis: Non

Introduit: 3.0

nodémon
Si vrai, superviseurd commencera au premier plan au lieu de démoniser.

Réglage par défaut: faux

Requis: Non

Introduit: 3.0

esprit
Le nombre minimum de descripteurs de fichiers qui doivent être disponibles avant que le superviseur ne
démarrer avec succès. Un appel à setrlimit sera effectué pour tenter d'augmenter le soft et
limites strictes du processus supervisé à satisfaire esprit. La limite stricte ne peut être que
déclenché sisupervisord est exécuté en tant que root. Supervisé utilise généreusement les descripteurs de fichiers, et
entrera en mode d'échec lorsqu'il ne pourra pas être obtenu à partir du système d'exploitation, il est donc utile d'être
capable de spécifier une valeur minimale pour s'assurer qu'il n'en manque pas pendant l'exécution.
Cette option est particulièrement utile sur Solaris, qui a une faible limite fd par processus par
défaut.

Réglage par défaut: 1024

Requis: Non

Introduit: 3.0

minprocs
Le nombre minimum de descripteurs de processus qui doivent être disponibles avant le superviseur
démarrera avec succès. Un appel à setrlimit sera effectué pour tenter d'augmenter le soft
et les limites strictes du processus supervisé pour satisfaire minprocs. La limite stricte peut
être déclenché uniquement si superviseurd est exécuté en tant que root. Supervisé entrera en mode échec
lorsque le système d'exploitation manque de descripteurs de processus, il est donc utile de s'assurer que suffisamment
les descripteurs de processus sont disponibles sur superviseur Commencez.

Réglage par défaut: 200

Requis: Non

Introduit: 3.0

pas de nettoyage
Empêcher le superviseur d'effacer tout AUTO fichiers journaux enfants au démarrage.
Utile pour le débogage.

Réglage par défaut: faux

Requis: Non

Introduit: 3.0

rép du journal des enfants
Le répertoire utilisé pour AUTO fichiers journaux enfants. Cette option peut inclure la valeur
%(ici)s, qui se développe jusqu'au répertoire dans lequel le superviseur fichier de configuration
a été trouvé.

Réglage par défaut: valeur de Python fichier_temp.get_tempdir()

Requis: Non

Introduit: 3.0

utilisateur
Instruire superviseur pour basculer les utilisateurs vers ce compte utilisateur UNIX avant de faire
traitement significatif. L'utilisateur ne peut être commuté que si superviseur est démarré en tant que
utilisateur root. Si superviseur ne peut pas changer d'utilisateur, il continuera mais écrira un
message de journal au critique niveau en disant qu'il ne peut pas supprimer les privilèges.

Réglage par défaut: ne pas changer d'utilisateur

Requis: Non

Introduit: 3.0

annuaire
Quand superviseur démonise, basculez vers ce répertoire. Cette option peut inclure le
Plus-value %(ici)s, qui se développe jusqu'au répertoire dans lequel le superviseur paramétrage
fichier a été trouvé.

Réglage par défaut: ne pas cd

Requis: Non

Introduit: 3.0

strip_ansi
Supprimez toutes les séquences d'échappement ANSI des fichiers journaux enfants.

Réglage par défaut: faux

Requis: Non

Introduit: 3.0

sûr, heureux et sain
Une liste de paires clé/valeur sous la forme KEY="val", KEY2="val2" qui sera placé dans le
superviseur process' environnement (et par conséquent dans tous ses processus fils'
environnements). Cette option peut inclure la valeur %(ici)s, qui s'étend au
répertoire dans lequel le fichier de configuration supervisé a été trouvé. Valeurs contenant
les caractères non alphanumériques doivent être entre guillemets (par ex. KEY="val:123",KEY2="val,456").
Sinon, la citation des valeurs est facultative mais recommandée. Pour échapper à pour cent
caractères, utilisez simplement deux. (par exemple URI="/premier%%20nom") Notes que les sous-processus
hériter des variables d'environnement du shell utilisé pour démarrer superviseur sauf pour le
ceux annulés ici et dans le programme sûr, heureux et sain option. Voir
environnement_sous-processus.

Réglage par défaut: aucune valeur

Requis: Non

Introduit: 3.0

identifiant
La chaîne d'identifiant de ce processus superviseur, utilisée par l'interface RPC.

Réglage par défaut: superviseur

Requis: Non

Introduit: 3.0

[superviseur] Section Exemple
[superviseur]
fichier journal = /tmp/supervisord.log
logfile_maxbytes = 50 Mo
fichier_journal_backups=10
niveau de journalisation = info
pidfile = /tmp/supervisord.pid
nodemon = faux
minfd = 1024
minprocs = 200
masque = 022
utilisateur = chrême
identifiant = superviseur
répertoire = / Tmp
nocleanup = vrai
enfantlogdir = / Tmp
strip_ansi = faux
environnement = KEY1="valeur1",KEY2="valeur2"

[superviseur] Section Paramètres
Le fichier de configuration peut contenir des paramètres pour le superviseur shell interactif
programme. Ces options sont répertoriées ci-dessous.

[superviseur] Section Valeurs
URL du serveur
L'URL qui doit être utilisée pour accéder au serveur supervisé, par exemple
http://localhost: 9001. Pour les sockets de domaine UNIX, utilisez
unix:///absolute/chemin/vers/fichier.sock.

Réglage par défaut: http://localhost: 9001

Requis: Non

Introduit: 3.0

Nom d'utilisateur
Le nom d'utilisateur à transmettre au serveur supervisé pour une utilisation dans l'authentification. Ceci devrait
être le même que Nom d'utilisateur depuis la configuration du serveur supervisé pour le port ou UNIX
socket de domaine auquel vous essayez d'accéder.

Réglage par défaut: pas de nom d'utilisateur

Requis: Non

Introduit: 3.0

Mot de passe
Le mot de passe à transmettre au serveur supervisé pour l'authentification. Ceci devrait
être la version en clair de Mot de passe à partir de la configuration du serveur supervisé pour le
port ou socket de domaine UNIX auquel vous essayez d'accéder. Cette valeur ne peut pas être transmise comme
un hachage SHA. Contrairement aux autres mots de passe spécifiés dans ce fichier, il doit être fourni dans
effacer le texte.

Réglage par défaut: Pas de mot de passe

Requis: Non

Introduit: 3.0

rapide
Chaîne utilisée comme invite de superviseurctl.

Réglage par défaut: superviseur

Requis: Non

Introduit: 3.0

fichier_historique
Un chemin à utiliser comme readline fichier historique persistant. Si vous activez cette fonctionnalité en
en choisissant un chemin, vos commandes superviseurctl seront conservées dans le fichier, et vous pourrez utiliser
readline (par exemple, flèche vers le haut) pour appeler les commandes que vous avez effectuées dans votre dernier superviseurctl
session.

Réglage par défaut: Pas de fichier

Requis: Non

Introduit: 3.0a5

[superviseur] Section Exemple
[superviseur]
URL du serveur = unix:///tmp/supervisor.sock
nom d'utilisateur = chris
mot de passe = 123
invite = monsuperviseur

[programme : x] Section Paramètres
Le fichier de configuration doit contenir un ou plusieurs Danse sections afin d'être supervisé
pour savoir quels programmes il doit démarrer et contrôler. La valeur d'en-tête est une valeur composite.
Il s'agit du mot "programme", suivi directement de deux points, puis du nom du programme. Un en-tête
valeur de [programme:toto] décrit un programme avec le nom de "foo". Le nom est utilisé
dans les applications clientes qui contrôlent les processus créés à la suite de cette
configuration. C'est une erreur de créer un Danse section qui n'a pas de nom. Les
le nom ne doit pas inclure de caractère deux-points ou de crochet. La valeur du nom est
utilisé comme valeur pour le %(nom_programme)s expansion d'expression de chaîne dans d'autres valeurs
où spécifié.

REMARQUE:
A [programme : x] La section représente en fait un « groupe de processus homogène » pour le superviseur
(à partir de 3.0). Les membres du groupe sont définis par la combinaison des nombres
ainsi que nom du processus paramètres dans la configuration. Par défaut, si numprocs et
process_name restent inchangés par rapport à leurs valeurs par défaut, le groupe représenté par
[programme : x] sera nommé x et aura un seul processus nommé x dedans. Cette
fournit un minimum de rétrocompatibilité avec les anciennes versions de superviseur, ce qui
ne pas traiter les sections de programme comme des définitions de groupes de processus homogènes.

Mais par exemple, si vous avez un [programme:toto] partie avec un nombres de 3 et un
nom du processus expression de %(nom_programme)s_%(numéro_processus)02d, le groupe "foo"
contiennent trois processus, nommés foo_00, foo_01et foo_02. Cela permet de
démarrer un certain nombre de processus très similaires en utilisant un seul [programme : x] section. Tous
les noms des fichiers journaux, toutes les chaînes d'environnement et la commande des programmes peuvent également contenir
expressions de chaîne Python similaires, pour passer des paramètres légèrement différents à chacun
processus.

[programme : x] Section Valeurs
commander
La commande qui sera exécutée au démarrage de ce programme. La commande peut être soit
absolu (par exemple /chemin/vers/nom_programme) ou un parent (par exemple nom du programme). Si c'est
parent, l'environnement du surveillant $ CHEMIN sera recherché pour l'exécutable.
Les programmes peuvent accepter des arguments, par exemple /chemin/vers/programme foo barre. La ligne de commande peut utiliser
guillemets doubles pour regrouper les arguments contenant des espaces à transmettre au programme, par exemple
/chemin/vers/programme/nom -p "toto bar". Notez que la valeur de commander peut inclure Python
expressions de chaîne, par exemple /chemin/vers/nom_programme --port=80%(num_processus)02d pourrait s'étendre
à /chemin/vers/nom_programme --port=8000 à l'exécution. Les expressions de chaîne sont évaluées
contre un dictionnaire contenant les clés nom de groupe, nom_noeud_hôte, num_processus,
nom du programme, ici (le répertoire du fichier de configuration supervisé), et tous
les variables d'environnement de superviseur préfixées par ENV_. Les programmes contrôlés devraient
ne sont pas eux-mêmes des démons, car Supervisord suppose qu'il est responsable de la démonisation de ses
sous-processus (voir nondaemonizing_of_subprocesses).

Réglage par défaut: Aucun défaut.

Requis: Oui.

Introduit: 3.0

nom du processus
Une expression de chaîne Python qui est utilisée pour composer le nom du processus superviseur pour ce
traiter. Vous n'avez généralement pas à vous soucier de la configuration à moins que vous ne modifiiez
nombres. L'expression de chaîne est évaluée par rapport à un dictionnaire qui inclut
nom de groupe, nom_noeud_hôte, num_processus, nom du programmeet ici (l'annuaire du
fichier de configuration supervisé).

Réglage par défaut: %(nom_programme)s

Requis: Non

Introduit: 3.0

nombres
Supervisor démarrera autant d'instances de ce programme que nommé par numprocs. Noter
que si numprocs > 1, le nom du processus l'expression doit inclure %(process_num)s (ou tout
autre expression de chaîne Python valide qui inclut num_processus) à l'intérieur.

Réglage par défaut: 1

Requis: Non

Introduit: 3.0

numprocs_start
Un décalage entier utilisé pour calculer le nombre auquel nombres départs.

Réglage par défaut: 0

Requis: Non

Introduit: 3.0

priorité
La priorité relative du programme dans l'ordre de démarrage et d'arrêt. Inférieur
les priorités indiquent les programmes qui démarrent en premier et s'arrêtent en dernier au démarrage et quand
Les commandes agrégées sont utilisées dans divers clients (par exemple, "tout démarrer"/"tout arrêter"). Plus haut
les priorités indiquent les programmes qui démarrent en dernier et s'arrêtent en premier.

Réglage par défaut: 999

Requis: Non

Introduit: 3.0

Autostart
Si vrai, ce programme démarrera automatiquement au démarrage de Supervisord.

Réglage par défaut: vrai

Requis: Non

Introduit: 3.0

démarre les secondes
Le nombre total de secondes dont le programme a besoin pour rester en cours d'exécution après un démarrage pour
considérer le démarrage comme réussi (déplacer le processus du DÉPART état à la
RUNNING Etat). Mis à 0 pour indiquer que le programme n'a pas besoin de rester en cours d'exécution pendant
quantité de temps particulière.

REMARQUE:
Même si un processus se termine avec un code de sortie « attendu » (voir codes de sortie), le début
sera toujours considéré comme un échec si le processus se termine plus rapidement que démarre les secondes.

Réglage par défaut: 1

Requis: Non

Introduit: 3.0

tentatives de démarrage
Le nombre de tentatives d'échec en série qui superviseur permettra en essayant de
démarrer le programme avant d'abandonner et de mettre le processus dans un MORTEL Etat. Voir
process_states pour l'explication du MORTEL Etat.

Réglage par défaut: 3

Requis: Non

Introduit: 3.0

redémarrage automatique
Spécifie si superviseur devrait redémarrer automatiquement un processus s'il se termine lorsqu'il est
dans l' RUNNING Etat. Peut être l'un des non, inattenduou oui. Si non, le processus
ne sera pas redémarré automatiquement. Si inattendu, le processus sera redémarré lorsque le
le programme se termine avec un code de sortie qui n'est pas l'un des codes de sortie associés à ce
configuration du processus (voir codes de sortie). Si oui, le processus sera inconditionnellement
redémarré à sa sortie, sans tenir compte de son code de sortie.

REMARQUE:
redémarrage automatique contrôle si superviseur redémarrera automatiquement un programme s'il se termine
après avoir démarré avec succès (le processus est dans le RUNNING Etat).

superviseur a un mécanisme de redémarrage différent pour le démarrage du processus
(le processus est dans le DÉPART Etat). Les nouvelles tentatives lors du démarrage du processus sont
controlé par démarre les secondes ainsi que tentatives de démarrage.

Réglage par défaut: inattendu

Requis: Non

Introduit: 3.0

codes de sortie
La liste des codes de sortie « attendus » pour ce programme utilisé avec redémarrage automatique. Si l'
redémarrage automatique paramètre est défini sur inattendu, et le processus se termine autrement que
à la suite d'une demande d'arrêt du superviseur, superviseur redémarrera le processus s'il
sort avec un code de sortie qui n'est pas défini dans cette liste.

Réglage par défaut: 0,2

Requis: Non

Introduit: 3.0

stop
Le signal utilisé pour tuer le programme lorsqu'un arrêt est demandé. Cela peut être n'importe quel TERME,
HUP, INT, QUIT, KILL, USR1 ou USR2.

Réglage par défaut: TERME

Requis: Non

Introduit: 3.0

secondes d'attente
Le nombre de secondes à attendre pour que le système d'exploitation renvoie un SIGCHILD à superviseur après le
programme a reçu un signal d'arrêt. Si ce nombre de secondes s'écoule avant
superviseur reçoit un SIGCHILD du processus, superviseur tentera de le tuer
avec un SIGKILL final.

Réglage par défaut: 10

Requis: Non

Introduit: 3.0

groupe d'arrêt
Si vrai, l'indicateur oblige le superviseur à envoyer le signal d'arrêt à l'ensemble du groupe de processus
et implique groupe killas est vrai. Ceci est utile pour les programmes, tels que Flask en débogage
mode, qui ne propagent pas les signaux d'arrêt à leurs enfants, les laissant orphelins.

Réglage par défaut: faux

Requis: Non

Introduit: 3.0b1

groupe killas
Si vrai, lorsque vous recourez à envoyer SIGKILL au programme pour le terminer, envoyez-le à son
l'ensemble du groupe de processus à la place, en prenant également soin de ses enfants, utile par exemple avec
programmes Python utilisant multitraitement.

Réglage par défaut: faux

Requis: Non

Introduit: 3.0a11

utilisateur
Instruire superviseur d'utiliser ce compte utilisateur UNIX comme compte qui exécute le
programme. L'utilisateur ne peut être commuté que si superviseur est exécuté en tant qu'utilisateur root. Si
superviseur ne peut pas basculer vers l'utilisateur spécifié, le programme ne sera pas démarré.

REMARQUE:
L'utilisateur sera modifié en utilisant tranquille seul. Cela ne démarre pas un shell de connexion et
ne modifie pas les variables d'environnement comme UTILISATEUR or ACCUEIL. Voir
subprocess_environment pour plus de détails.

Réglage par défaut: Ne changez pas d'utilisateur

Requis: Non

Introduit: 3.0

redirect_stderr
Si vrai, renvoie la sortie stderr du processus à superviseur sur son stdout
descripteur de fichier (en termes de shell UNIX, cela équivaut à exécuter /le programme
2> et 1).

REMARQUE:
Ne pas fixer redirect_stderr = vrai dans un [écouteur d'événement : x] section. Auditeurs d'événements
utilisé Stdout ainsi que Stdin communiquer avec superviseur. Si stderr est redirigé,
sortie de stderr interférera avec le protocole d'écoute d'événement.

Réglage par défaut: faux

Requis: Non

Introduit: 3.0, remplace les 2.0 log_stdout ainsi que log_stderr

fichier_journal_stdout
Mettez la sortie stdout du processus dans ce fichier (et si redirect_stderr est vrai, placez également
sortie stderr dans ce fichier). Si fichier_journal_stdout est désactivé ou réglé sur AUTO, superviseur
choisira automatiquement un emplacement de fichier. S'il est défini sur NONE, sera supervisé
créer aucun fichier journal. AUTO les fichiers journaux et leurs sauvegardes seront supprimés lorsque superviseur
redémarre. Les fichier_journal_stdout value peut contenir des expressions de chaîne Python qui
évalué par rapport à un dictionnaire qui contient les clés nom de groupe, nom_noeud_hôte,
num_processus, nom du programmeet ici (le répertoire du fichier de configuration supervisé).

REMARQUE:
Il n'est pas possible que deux processus partagent un même fichier journal (fichier_journal_stdout)
lors de la rotation (stdout_logfile_maxbytes) est autorisé. Cela se traduira par le fichier
être corrompu.

Réglage par défaut: AUTO

Requis: Non

Introduit: 3.0, remplace les 2.0 fichier journal

stdout_logfile_maxbytes
Le nombre maximal d'octets pouvant être consommés par fichier_journal_stdout avant qu'il ne soit tourné
(des multiplicateurs de suffixe tels que "KB", "MB" et "GB" peuvent être utilisés dans la valeur). Réglez ceci
valeur à 0 pour indiquer une taille de journal illimitée.

Réglage par défaut: 50MB

Requis: Non

Introduit: 3.0, remplace les 2.0 fichier journal_maxoctets

stdout_logfile_backups
Le nombre de fichier_journal_stdout sauvegardes à conserver résultant du journal stdout du processus
rotation des fichiers. S'il est défini sur 0, aucune sauvegarde ne sera conservée.

Réglage par défaut: 10

Requis: Non

Introduit: 3.0, remplace les 2.0 fichier_journal_sauvegardes

stdout_capture_maxbytes
Nombre maximum d'octets écrits pour capturer FIFO lorsque le processus est en "mode de capture stdout"
(voir capture_mode). Doit être un entier (suffixe multiplicateurs comme "KB", "MB" et "GB"
peut être utilisé dans la valeur). Si cette valeur est 0, le mode de capture de processus sera désactivé.

Réglage par défaut: 0

Requis: Non

Introduit: 3.0, remplace les 2.0 fichier_journal_sauvegardes

stdout_events_enabled
Si vrai, les événements PROCESS_LOG_STDOUT seront émis lorsque le processus écrit dans son
descripteur de fichier stdout. Les événements ne seront émis que si le descripteur de fichier n'est pas
en mode capture au moment de la réception des données (voir capture_mode).

Réglage par défaut: 0

Requis: Non

Introduit: 3.0a7

fichier_journal stderr
Mettez la sortie du processus stderr dans ce fichier à moins que redirect_stderr est vrai. Accepte le
mêmes types de valeur que fichier_journal_stdout et peut contenir les mêmes expressions de chaîne Python.

REMARQUE:
Il n'est pas possible que deux processus partagent un même fichier journal (fichier_journal stderr)
lors de la rotation (stderr_logfile_maxbytes) est autorisé. Cela se traduira par le fichier
être corrompu.

Réglage par défaut: AUTO

Requis: Non

Introduit: 3.0

stderr_logfile_maxbytes
Le nombre maximal d'octets avant la rotation du fichier journal pour fichier_journal stderr. Accepte le
mêmes types de valeur que stdout_logfile_maxbytes.

Réglage par défaut: 50MB

Requis: Non

Introduit: 3.0

stderr_logfile_backups
Le nombre de sauvegardes à conserver résultant de la rotation du fichier journal stderr du processus.
S'il est défini sur 0, aucune sauvegarde ne sera conservée.

Réglage par défaut: 10

Requis: Non

Introduit: 3.0

stderr_capture_maxbytes
Nombre maximum d'octets écrits pour capturer FIFO lorsque le processus est en "mode de capture stderr"
(voir capture_mode). Doit être un entier (suffixe multiplicateurs comme "KB", "MB" et "GB"
peut être utilisé dans la valeur). Si cette valeur est 0, le mode de capture de processus sera désactivé.

Réglage par défaut: 0

Requis: Non

Introduit: 3.0

stderr_events_enabled
Si vrai, les événements PROCESS_LOG_STDERR seront émis lorsque le processus écrit dans son
descripteur de fichier stderr. Les événements ne seront émis que si le descripteur de fichier n'est pas
en mode capture au moment de la réception des données (voir capture_mode).

Réglage par défaut: faux

Requis: Non

Introduit: 3.0a7

sûr, heureux et sain
Une liste de paires clé/valeur sous la forme KEY="val", KEY2="val2" qui sera placé dans le
l'environnement du processus enfant. La chaîne d'environnement peut contenir une chaîne Python
expressions qui seront évaluées par rapport à un dictionnaire contenant nom de groupe,
nom_noeud_hôte, num_processus, nom du programmeet ici (l'annuaire du superviseur
fichier de configuration). Les valeurs contenant des caractères non alphanumériques doivent être entre guillemets (par ex.
KEY="val:123",KEY2="val,456"). Sinon, la citation des valeurs est facultative mais
recommandé. Notes que le sous-processus héritera des variables d'environnement du
shell utilisé pour démarrer "supervisord" à l'exception de ceux remplacés ici. Voir
environnement_sous-processus.

Réglage par défaut: Pas d'environnement supplémentaire

Requis: Non

Introduit: 3.0

annuaire
Un chemin de fichier représentant un répertoire auquel superviseur devrait temporairement chdir
avant d'exécuter l'enfant.

Réglage par défaut: Pas de chdir (hériter du superviseur)

Requis: Non

Introduit: 3.0

umask
Un nombre octal (par exemple 002, 022) représentant l'umask du processus.

Réglage par défaut: Pas d'umask spécial (hériter du superviseur)

Requis: Non

Introduit: 3.0

URL du serveur
L'URL transmise dans l'environnement au processus de sous-processus en tant que SUPERVISOR_SERVER_URL
(voir superviseur.childutils) pour permettre au sous-processus de communiquer facilement avec le
serveur HTTP interne. S'il est fourni, il doit avoir la même syntaxe et la même structure que le
[superviseur] option de section du même nom. S'il est réglé sur AUTO ou n'est pas réglé,
le superviseur construira automatiquement une URL de serveur, en privilégiant un serveur
qui écoute sur les sockets du domaine UNIX plutôt que sur celui qui écoute sur une socket Internet.

Réglage par défaut: AUTOMATIQUE

Requis: Non

Introduit: 3.0

[programme : x] Section Exemple
[programme:chat]
commande =/bin/chat
nom_processus=%(nom_programme)s
nombreprocs=1
répertoire=/ Tmp
masque=022
priorité = 999
démarrage automatique = vrai
redémarrage automatique=inattendu
secondes de démarrage=10
tentatives de démarrage=3
codes de sortie=0,2
signal d'arrêt=TERME
stopwaitsecs=10
stopasgroup = faux
killasgroup=faux
utilisateur=chrême
redirect_stderr = faux
stdout_logfile=/a/chemin
stdout_logfile_maxbytes=1 Mo
stdout_logfile_backups=10
stdout_capture_maxbytes=1 Mo
stdout_events_enabled=false
stderr_logfile=/un/chemin
stderr_logfile_maxbytes=1 Mo
stderr_logfile_backups=10
stderr_capture_maxbytes=1 Mo
stderr_events_enabled = faux
environnement=A="1",B="2"
URLserveur=AUTO

[comprendre] Section Paramètres
La superviseur.conf le fichier peut contenir une section nommée [comprendre]. Si la configuration
le fichier contient un [comprendre] section, il doit contenir une seule clé nommée "files". Les
les valeurs de cette clé spécifient d'autres fichiers de configuration à inclure dans le
configuration.

[comprendre] Section Valeurs
fichiers
Une séquence de globs de fichiers séparés par des espaces. Chaque glob de fichier peut être absolu ou relatif.
Si le fichier glob est relatif, il est considéré comme relatif à l'emplacement du
fichier de configuration qui l'inclut. Un "glob" est un modèle de fichier qui correspond à un
modèle spécifié selon les règles utilisées par le shell Unix. Aucune extension de tilde n'est
fait, mais *, ?, et les plages de caractères exprimées avec [] sera correctement mis en correspondance.
Les inclusions récursives des fichiers inclus ne sont pas prises en charge.

Réglage par défaut: Pas de valeur par défaut (obligatoire)

Requis: Oui.

Introduit: 3.0

[comprendre] Section Exemple
[comprendre]
files = /an/absolute/filename.conf /an/absolute/*.conf foo.conf config??.conf

[groupe : x] Section Paramètres
Il est souvent utile de regrouper des groupes de processus « homogènes » (alias « programmes ») dans un
groupe de processus « hétérogène » afin qu'ils puissent être contrôlés comme une unité à partir du superviseur
diverses interfaces de contrôleur.

Pour placer des programmes dans un groupe afin de pouvoir les traiter comme une unité, définissez un [groupe : x]
dans votre fichier de configuration. La valeur d'en-tête de groupe est un composite. c'est le mot
"group", suivi directement de deux points, puis du nom du groupe. Une valeur d'en-tête de [groupe:toto]
décrit un groupe avec le nom de "foo". Le nom est utilisé dans les applications clientes
qui contrôlent les processus créés à la suite de cette configuration. C'est un
erreur pour créer un groupe section qui n'a pas de nom. Le nom ne doit pas comporter de
caractère deux-points ou un caractère crochet.

Pour une [groupe : x], il doit y avoir un ou plusieurs [programme : x] sections ailleurs dans votre
fichier de configuration, et le groupe doit s'y référer par leur nom dans le programmes valeur.

Si des groupes de processus "homogènes" (représentés par des sections de programme) sont placés dans un
groupe « hétérogène » via [groupe : x] sections programmes droite, les groupes homogènes qui
sont impliqués par la section de programme n'existeront pas au moment de l'exécution dans le superviseur. Au lieu de cela, tout
les processus appartenant à chacun des groupes homogènes seront placés dans le
groupe hétérogène. Par exemple, étant donné la configuration de groupe suivante :

[groupe:toto]
programmes=bar,baz
priorité = 999

Compte tenu de ce qui précède, au démarrage supervisé, le barre ainsi que baz des groupes homogènes ne
existent, et les processus qui auraient été sous eux seront maintenant déplacés dans le foo
groupe.

[groupe : x] Section Valeurs
programmes
Une liste de noms de programmes séparés par des virgules. Les programmes qui sont répertoriés deviennent membres
du groupe.

Réglage par défaut: Pas de valeur par défaut (obligatoire)

Requis: Oui.

Introduit: 3.0

priorité
Un numéro de priorité analogue à un [programme : x] valeur prioritaire attribuée au groupe.

Réglage par défaut: 999

Requis: Non

Introduit: 3.0

[groupe : x] Section Exemple
[groupe:toto]
programmes=bar,baz
priorité = 999

[fcgi-programme:x] Section Paramètres
Le superviseur peut gérer des groupes de FastCGI processus qui écoutent tous sur le même socket.
Jusqu'à présent, la flexibilité de déploiement de FastCGI était limitée. Pour obtenir le processus complet
gestion, vous pouviez utiliser mod_fastcgi sous Apache mais vous étiez alors bloqué avec Apache
modèle de concurrence inefficace d'un processus ou d'un thread par connexion. En plus de
nécessitant plus de ressources CPU et mémoire, le processus/thread par modèle de connexion peut être
rapidement saturé par une ressource lente, empêchant d'autres ressources d'être servies. Dans
afin de tirer parti des nouveaux serveurs Web événementiels tels que lighttpd ou nginx qui
n'incluez pas de gestionnaire de processus intégré, vous deviez utiliser des scripts comme cgi-fcgi ou
spawn-fcgi. Ceux-ci peuvent être utilisés en conjonction avec un gestionnaire de processus tel que Supervisord
ou daemontools, mais nécessite que chaque processus enfant FastCGI se lie à son propre socket. Les
les inconvénients de ceci sont : une configuration de serveur Web inutilement compliquée, peu gracieuse
redémarrages et une tolérance aux pannes réduite. Avec moins de sockets à configurer, le serveur Web
les configurations sont beaucoup plus petites si des groupes de processus FastCGI peuvent partager des sockets. partagé
les sockets permettent des redémarrages en douceur car le socket reste lié par le processus parent
pendant le redémarrage de l'un des processus enfants. Enfin, les sockets partagés sont plus
tolérant aux pannes car si un processus donné échoue, d'autres processus peuvent continuer à servir
connexions entrantes.

Avec la prise en charge intégrée de la génération FastCGI, Supervisor vous offre le meilleur des deux mondes.
Vous obtenez une gestion complète des processus avec des groupes de processus FastCGI partageant des sockets
sans être lié à un serveur Web particulier. C'est une séparation nette des préoccupations,
permettant au serveur Web et au gestionnaire de processus de faire chacun ce qu'ils font le mieux.

REMARQUE:
Le gestionnaire de sockets dans Supervisor a été développé à l'origine pour prendre en charge les processus FastCGI
mais il n'est pas limité à FastCGI. D'autres protocoles peuvent également être utilisés sans
configuration. Tout programme qui peut accéder à un socket ouvert à partir d'un descripteur de fichier (par exemple
avec socket.fromfd en Python) peut utiliser le gestionnaire de sockets. Le superviseur
créer automatiquement le socket, lier et écouter avant de forker le premier enfant dans un
grouper. Le socket sera passé à chaque enfant sur le numéro de descripteur de fichier 0 (zéro).
Lorsque le dernier enfant du groupe sort, Supervisor ferme le socket.

Toutes les options disponibles pour [programme : x] les sections sont également respectées par programme-fcgi
sections.

[fcgi-programme:x] Section Valeurs
[fcgi-programme:x] sections ont une seule clé qui [programme : x] les sections n'ont pas.

douille
Le socket FastCGI pour ce programme, soit le socket de domaine TCP ou UNIX. Pour les sockets TCP,
utilisez ce format : tcp://localhost:9002. Pour les sockets de domaine UNIX, utilisez
unix:///absolute/chemin/vers/fichier.sock. Les expressions de chaîne sont évaluées par rapport à un
dictionnaire contenant les clés "nom_programme" et "ici" (le répertoire du
fichier de configuration supervisé).

Réglage par défaut: Aucun défaut.

Requis: Oui.

Introduit: 3.0

propriétaire_de_socket
Pour les sockets de domaine UNIX, ce paramètre peut être utilisé pour spécifier l'utilisateur et le groupe pour
le socket FastCGI. Peut être un nom d'utilisateur UNIX (par exemple chrism) ou un nom d'utilisateur et un groupe UNIX
séparés par deux points (par exemple chrism:wheel).

Réglage par défaut: Utilise l'utilisateur et le groupe définis pour le programme fcgi

Requis: Non

Introduit: 3.0

mode_socket
Pour les sockets de domaine UNIX, ce paramètre peut être utilisé pour spécifier le mode d'autorisation.

Réglage par défaut: 0700

Requis: Non

Introduit: 3.0

Consultation [programme : x] Section Paramètres pour les autres clés autorisées, delta les contraintes ci-dessus
et des ajouts.

[fcgi-programme:x] Section Exemple
[programme-fcgi : nom du programme fcgi]
command=/usr/bin/exemple.fcgi
socket=unix:///var/run/supervisor/%(nom_programme)s.sock
socket_owner=chrême
socket_mode=0700
nom_processus=%(nom_programme)s_%(numéro_processus)02d
nombreprocs=5
répertoire=/ Tmp
masque=022
priorité = 999
démarrage automatique = vrai
redémarrage automatique=inattendu
secondes de démarrage=1
tentatives de démarrage=3
codes de sortie=0,2
stopsignal=QUITTER
stopasgroup = faux
killasgroup=faux
stopwaitsecs=10
utilisateur=chrême
redirect_stderr = vrai
stdout_logfile=/a/chemin
stdout_logfile_maxbytes=1 Mo
stdout_logfile_backups=10
stdout_events_enabled=false
stderr_logfile=/un/chemin
stderr_logfile_maxbytes=1 Mo
stderr_logfile_backups=10
stderr_events_enabled = faux
environnement=A="1",B="2"
URLserveur=AUTO

[écouteur d'événement : x] Section Paramètres
Supervisor permet à des groupes de processus homogènes spécialisés (« pools d'écouteurs d'événements ») d'être
défini dans le fichier de configuration. Ces pools contiennent des processus destinés à
recevoir et répondre aux notifications d'événements du système d'événements du superviseur. Voir les événements pour
une explication du fonctionnement des événements et de la mise en œuvre de programmes pouvant être déclarés comme
auditeurs d'événements.

Notez que toutes les options disponibles pour [programme : x] les sections sont respectées par eventlistener
les sections sauf en stdout_capture_maxbytes ainsi que stderr_capture_maxbytes (auditeurs d'événements
ne peut pas émettre d'événements de communication de processus, voir capture_mode).

[écouteur d'événement : x] Section Valeurs
[écouteur d'événement : x] sections ont quelques clés qui [programme : x] les sections n'ont pas.

taille_tampon
Taille de la mémoire tampon de la file d'attente d'événements du pool d'écouteurs d'événements. Lorsque le tampon d'événements d'un pool d'écouteurs
est débordé (comme cela peut arriver lorsqu'un pool d'écouteurs d'événements ne peut pas suivre tous les
événements qui lui sont envoyés), l'événement le plus ancien dans la mémoire tampon est rejeté.

événements
Une liste séparée par des virgules des noms de types d'événements auxquels cet écouteur est « intéressé »
recevoir des notifications pour (voir event_types pour une liste des noms de type d'événement valides).

gestionnaire_résultat
A pkg_ressources entrée point un magnifique qui se résout en un appelable Python. Le défaut
valeur est superviseur.dispatchers:default_handler. Spécification d'un résultat alternatif
gestionnaire est une chose très rare à faire, et par conséquent, comment en créer un est
non documenté.

Consultation [programme : x] Section Paramètres pour les autres clés autorisées, delta les contraintes ci-dessus
et des ajouts.

[écouteur d'événement : x] Section Exemple
[écouteur d'événements : nom de l'écouteur d'événements]
commande=/bin/eventlistener
nom_processus=%(nom_programme)s_%(numéro_processus)02d
nombreprocs=5
événements=PROCESS_STATE
taille_tampon=10
répertoire=/ Tmp
masque=022
priorité=-1
démarrage automatique = vrai
redémarrage automatique=inattendu
secondes de démarrage=1
tentatives de démarrage=3
codes de sortie=0,2
stopsignal=QUITTER
stopwaitsecs=10
stopasgroup = faux
killasgroup=faux
utilisateur=chrême
redirect_stderr = faux
stdout_logfile=/a/chemin
stdout_logfile_maxbytes=1 Mo
stdout_logfile_backups=10
stdout_events_enabled=false
stderr_logfile=/un/chemin
stderr_logfile_maxbytes=1 Mo
stderr_logfile_backups=10
stderr_events_enabled = faux
environnement=A="1",B="2"
URLserveur=AUTO

[interface rpc : x] Section Paramètres
L'ajout de interface rpc:x paramètres dans le fichier de configuration n'est utile que pour les personnes qui
souhaitez étendre le superviseur avec un comportement personnalisé supplémentaire.

Dans l'exemple de fichier de configuration, il y a une section qui est nommée [rpcinterface:superviseur].
Par défaut, cela ressemble à ce qui suit.

[rpcinterface:superviseur]
superviseur.rpcinterface_factory = superviseur.rpcinterface:make_main_rpcinterface

La [rpcinterface:superviseur] must rester dans la configuration pour la norme
configuration du superviseur pour qu'il fonctionne correctement. Si vous ne voulez pas que le superviseur fasse quoi que ce soit, il
ne fait pas déjà hors de la boîte, c'est tout ce que vous devez savoir sur ce type de
.

Cependant, si vous souhaitez ajouter des espaces de noms d'interface rpc afin de personnaliser le superviseur, vous
peut ajouter d'autres [interface rpc:foo] sections, où "foo" représente l'espace de noms de
l'interface (depuis la racine Web), et la valeur nommée par superviseur.rpcinterface_factory
est une usine appelable qui devrait avoir une signature de fonction qui accepte un seul
argument de position superviseur et autant d'arguments de mot-clé que nécessaire pour effectuer
configuration. Toute paire clé/valeur supplémentaire définie dans le [interface rpc : x] section sera
être passé en tant qu'arguments mot-clé à la fabrique.

Voici un exemple de fonction d'usine, créée dans le __init__.py fichier du Python
paquet mon colis.

à partir de my.package.rpcinterface importer AnotherRPCInterface

def make_another_rpcinterface(superviseur, **config):
tentatives = int(config.get('retries', 0))
other_rpc_interface = AnotherRPCInterface(supervisord, réessaye)
retourner une autre_rpc_interface

Et une section dans le fichier de configuration destinée à le configurer.

[rpcinterface:un autre]
superviseur.rpcinterface_factory = my.package:make_another_rpcinterface
tentatives = 1

[interface rpc : x] Section Valeurs
superviseur.rpcinterface_factory
pkg_ressources "point d'entrée" nom en pointillé de la fonction d'usine de votre interface RPC.

Réglage par défaut: N / A

Requis: Non

Introduit: 3.0

[interface rpc : x] Section Exemple
[rpcinterface:un autre]
superviseur.rpcinterface_factory = my.package:make_another_rpcinterface
tentatives = 1

Glossaire
Daemon Tools
A processus des bactéries combustion propre by DJ Bernstein.

lancé
A processus des bactéries combustion propre d'utiliser by Apple comme processus 1 sous Mac OS X.

exécuter A processus des bactéries combustion propre.

Superlance
Un package qui fournit diverses implémentations d'écouteurs d'événements qui se connectent à
Supervisor qui peut aider à surveiller l'utilisation de la mémoire du processus et l'état du plantage :
http://pypi.python.org/pypi/superlance.

umask Abréviation de utilisateur masque: définit le masque de création de mode fichier du processus en cours.
See http://en.wikipedia.org/wiki/Umask.

Utilisez echo_supervisord_conf en ligne à l'aide des services onworks.net