echo_supervisord_conf - Online en la nube

PROGRAMA:

NOMBRE

echo_supervisord_conf - Documentación de configuración del supervisor

Supervisor es un sistema cliente / servidor que permite a sus usuarios monitorear y controlar un número
de procesos en sistemas operativos similares a UNIX.

Comparte algunos de los mismos objetivos de programas como launchd, daemontools y runit. diferente a
algunos de estos programas, no debe ejecutarse como sustituto de init como "ID de proceso
1 ". En su lugar, está destinado a controlar los procesos relacionados con un proyecto o un
cliente, y está destinado a iniciarse como cualquier otro programa en el momento del arranque.

DOCUMENTACIÓN

Creamos a Configuración Archive
Una vez que se haya completado la instalación de Supervisor, ejecute echo_supervisord_conf. Esta voluntad
imprima un archivo de configuración de supervisor "de muestra" en la salida estándar de su terminal.

Una vez que vea que el archivo se repite en su terminal, vuelva a invocar el comando como
echo_supervisord_conf > /etc/supervisord.conf. Esto no funcionará si no tiene root
acceder.

Si no tiene acceso de root, o prefiere no poner el supervisord.conf archivo en
/ etc / supervisord.conf`, puede colocarlo en el directorio actual (echo_supervisord_conf >
supervisord.conf) y empezar supervisor con el -c bandera para especificar el
ubicación del archivo de configuración.

Por ejemplo, supervisor -c supervisord.conf. Utilizando el -c la bandera en realidad es redundante en
este caso, porque supervisor busca en el directorio actual un supervisord.conf
antes de que busque otras ubicaciones para el archivo, pero funcionará.

Una vez que tenga un archivo de configuración en su sistema de archivos, puede comenzar a modificarlo a su
gusto.

Configuración Archive
El archivo de configuración del supervisor se denomina convencionalmente supervisord.conf. Es utilizado por
ambas supervisor y supervisorctl. Si alguna de las aplicaciones se inicia sin el -c
opción (la opción que se utiliza para decirle a la aplicación el nombre del archivo de configuración
explícitamente), la aplicación buscará un archivo llamado supervisord.conf en la pestaña
siguientes ubicaciones, en el orden especificado. Utilizará el primer archivo que encuentre.

1. $ CWD / supervisord.conf

2. $ CWD / etc / supervisord.conf

3. /etc/supervisord.conf

4. ../etc/supervisord.conf (Relativo al ejecutable)

5. ../supervisord.conf (Relativo al ejecutable)

NOTA:
Algunas distribuciones han empaquetado Supervisor con sus propias personalizaciones. Estas
Las versiones modificadas de Supervisor pueden cargar el archivo de configuración desde ubicaciones
que los descritos aquí. En particular, se han encontrado paquetes de Ubuntu que usan
/etc/supervisor/supervisord.conf.

Archive Formato
supervisord.conf es un archivo de estilo Windows-INI (Python ConfigParser). Tiene secciones (cada
denotado por un [encabezamiento]) y pares clave / valor dentro de las secciones. Las secciones y sus
los valores permitidos se describen a continuación.

Entorno Variables
Variables ambientales que están presentes en el ambiente en el momento en que supervisor is
iniciado se puede usar en el archivo de configuración usando la sintaxis de expresión de cadena de Python
% (ENV_X) s:

[programa: ejemplo]
comando = / usr / bin / ejemplo --loglevel =% (ENV_LOGLEVEL) s

En el ejemplo anterior, la expresión % (ENV_LOGLEVEL) s se ampliaría al valor de
la variable de entorno NIVEL DE REGISTRO.

NOTA:
En Supervisor 3.2 y posterior, % (ENV_X) s las expresiones son compatibles con todas las opciones. En
versiones anteriores, algunas opciones las admiten, pero la mayoría no. Consulte la documentación para
cada opción a continuación.

[unix_http_servidor] Sección Ajustes
El supervisord.conf el archivo contiene una sección llamada [unix_http_servidor] bajo el cual
Los parámetros de configuración para un servidor HTTP que escucha en un socket de dominio UNIX deben ser
insertado. Si el archivo de configuración no tiene [unix_http_servidor] sección, un dominio UNIX
El servidor HTTP de socket no se iniciará. Los valores de configuración permitidos son los
de la siguiente manera.

[unix_http_servidor] Sección Valores
presentar
Una ruta a un socket de dominio UNIX (p. Ej. /tmp/supervisord.sock) sobre qué supervisor
Escuche las solicitudes HTTP / XML-RPC. supervisorctl utiliza XML-RPC para comunicarse con
supervisor sobre este puerto. Esta opción puede incluir el valor % (aquí) s, que se expande
al directorio en el que supervisor Se encontró el archivo de configuración.

Predeterminado: Ninguno.

Requerido: No.

Introducido: 3.0

chmod
Cambie los bits del modo de permiso de UNIX del socket de dominio de UNIX a este valor en
puesta en marcha.

Predeterminado: 0700

Requerido: No.

Introducido: 3.0

chown
Cambie el usuario y el grupo del archivo de socket a este valor. Puede ser un nombre de usuario de UNIX
(p.ej aceite) o un nombre de usuario y un grupo de UNIX separados por dos puntos (p. ej. crisma: rueda).

Predeterminado: Utilice el nombre de usuario y el grupo del usuario que inicia supervisord.

Requerido: No.

Introducido: 3.0

nombre de usuario
El nombre de usuario requerido para la autenticación en este servidor HTTP.

Predeterminado: No se requiere nombre de usuario.

Requerido: No.

Introducido: 3.0

la contraseña
La contraseña requerida para la autenticación en este servidor HTTP. Esto puede ser un texto sin cifrar
contraseña, o se puede especificar como un hash SHA-1 si tiene como prefijo la cadena {SHA}. For
ejemplo, {SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d es la versión almacenada en SHA del
contraseña "la contraseña".

Tenga en cuenta que la contraseña hash debe estar en formato hexadecimal.

Predeterminado: No se requiere contraseña.

Requerido: No.

Introducido: 3.0

[unix_http_servidor] Sección Ejemplo
[unix_http_servidor]
archivo = /tmp/supervisor.sock
chmod = 0777
chown = nadie: nogroup
nombre de usuario = usuario
contraseña = 123

[inet_http_servidor] Sección Ajustes
El supervisord.conf el archivo contiene una sección llamada [inet_http_servidor] bajo el cual
Los parámetros de configuración para un servidor HTTP que escucha en un socket TCP (Internet) deben
ser insertado. Si el archivo de configuración no tiene [inet_http_servidor] sección, un HTTP inet
el servidor no se iniciará. Los valores de configuración permitidos son los siguientes.

[inet_http_servidor] Sección Valores
Puerto
Un host TCP: valor de puerto o (p. Ej. 127.0.0.1:9001) sobre qué supervisor escuchará
Solicitudes HTTP / XML-RPC. supervisorctl utilizará XML-RPC para comunicarse con supervisor
sobre este puerto. Para escuchar en todas las interfaces de la máquina, utilice : 9001 or *: 9001.

Predeterminado: Ningún valor predeterminado.

Requerido: Si.

Introducido: 3.0

nombre de usuario
El nombre de usuario requerido para la autenticación en este servidor HTTP.

Predeterminado: No se requiere nombre de usuario.

Requerido: No.

Introducido: 3.0

la contraseña
La contraseña requerida para la autenticación en este servidor HTTP. Esto puede ser un texto sin cifrar
contraseña, o se puede especificar como un hash SHA-1 si tiene como prefijo la cadena {SHA}. For
ejemplo, {SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d es la versión almacenada en SHA del
contraseña "la contraseña".

Tenga en cuenta que la contraseña hash debe estar en formato hexadecimal.

Predeterminado: No se requiere contraseña.

Requerido: No.

Introducido: 3.0

[inet_http_servidor] Sección Ejemplo
[inet_http_servidor]
puerto = 127.0.0.1:9001
nombre de usuario = usuario
contraseña = 123

[supervisor] Sección Ajustes
El supervisord.conf el archivo contiene una sección llamada [supervisor] en que escenarios globales
está relacionada con el supervisor debe insertarse el proceso. Estos son los siguientes.

[supervisor] Sección Valores
archivo de registro
La ruta al registro de actividad del proceso supervisor. Esta opción puede incluir el
propuesta de % (aquí) s, que se expande al directorio en el que la configuración del supervisor
se encontró el archivo.

Predeterminado: $ CWD / supervisord.log

Requerido: No.

Introducido: 3.0

archivo de registro_maxbytes
El número máximo de bytes que puede consumir el archivo de registro de actividad antes de
rotado (los multiplicadores de sufijo como "KB", "MB" y "GB" se pueden utilizar en el valor). Colocar
este valor a 0 para indicar un tamaño de registro ilimitado.

Predeterminado: 50MB

Requerido: No.

Introducido: 3.0

logfile_backups
El número de copias de seguridad que se deben conservar como resultado de la rotación del archivo de registro de actividad. Si está configurado
a 0, no se guardarán copias de seguridad.

Predeterminado: 10

Requerido: No.

Introducido: 3.0

nivel de registro
El nivel de registro, que dicta lo que se escribe en el registro de actividad del supervisor. Uno de
crítico, error, advertir, info, depurar, rastrearo decir tonterías. Tenga en cuenta que a nivel de registro depurar,
el archivo de registro de supervisor registrará la salida stderr / stdout de sus procesos secundarios
e información ampliada sobre los cambios de estado del proceso, que es útil para depurar un
proceso que no se inicia correctamente. Consulte también: activity_log_levels.

Predeterminado: información

Requerido: No.

Introducido: 3.0

archivo pid
La ubicación en la que supervisord guarda su archivo pid. Esta opción puede incluir el
propuesta de % (aquí) s, que se expande al directorio en el que la configuración del supervisor
se encontró el archivo.

Predeterminado: $ CWD / supervisord.pid

Requerido: No.

Introducido: 3.0

umask
La umask del proceso supervisor.

Predeterminado: 022

Requerido: No.

Introducido: 3.0

Nodaemon
Si es verdadero, supervisord comenzará en primer plano en lugar de demonizar.

Predeterminado: falso

Requerido: No.

Introducido: 3.0

minfds
El número mínimo de descriptores de archivos que deben estar disponibles antes de que el supervisor
empezar con éxito. Se hará una llamada a setrlimit para intentar subir el soft y
límites estrictos del proceso de supervisión para satisfacer minfds. El límite estricto solo puede ser
se genera si supervisord se ejecuta como root. El supervisor usa descriptores de archivos generosamente, y
entrará en un modo de falla cuando no se pueda obtener uno del sistema operativo, por lo que es útil estar
capaz de especificar un valor mínimo para garantizar que no se agote durante la ejecución.
Esta opción es particularmente útil en Solaris, que tiene un límite bajo de fd por proceso por
predeterminado.

Predeterminado: 1024

Requerido: No.

Introducido: 3.0

minproces
El número mínimo de descriptores de proceso que deben estar disponibles antes de que el supervisor
comenzará con éxito. Se hará una llamada a setrlimit para intentar subir el soft
y límites estrictos del proceso de supervisión para satisfacer minproces. El límite duro puede
solo se generará si supervisord se ejecuta como root. el supervisor entrará en un modo de falla
cuando el sistema operativo se queda sin descriptores de proceso, por lo que es útil asegurarse de que
los descriptores de proceso están disponibles en supervisor puesta en marcha.

Predeterminado: 200

Requerido: No.

Introducido: 3.0

no limpiar
Evite que el supervisor borre cualquier AUTO archivos de registro secundarios en el momento del inicio.
Útil para depurar.

Predeterminado: falso

Requerido: No.

Introducido: 3.0

childlogdir
El directorio utilizado para AUTO archivos de registro de niños. Esta opción puede incluir el valor
% (aquí) s, que se expande al directorio en el que supervisor archivo de configuración
fue encontrado.

Predeterminado: valor de Python tempfile.get_tempdir ()

Requerido: No.

Introducido: 3.0

usuario
Instruir supervisor para cambiar usuarios a esta cuenta de usuario de UNIX antes de realizar cualquier
procesamiento significativo. El usuario solo se puede cambiar si supervisor se inicia como el
usuario root. Si supervisor no puede cambiar de usuario, continuará pero escribirá un
mensaje de registro en el crítico nivel diciendo que no puede quitar privilegios.

Predeterminado: no cambie de usuario

Requerido: No.

Introducido: 3.0

directorio
Cuándo supervisor daemonizes, cambie a este directorio. Esta opción puede incluir el
propuesta de % (aquí) s, que se expande al directorio en el que supervisor configuración
se encontró el archivo.

Predeterminado: no cd

Requerido: No.

Introducido: 3.0

tira_ansi
Elimine todas las secuencias de escape ANSI de los archivos de registro secundarios.

Predeterminado: falso

Requerido: No.

Introducido: 3.0

entorno
Una lista de pares clave / valor en el formulario CLAVE = "val", CLAVE2 = "val2" que se colocará en el
supervisor proceso 'entorno (y como resultado en todo su proceso hijo'
entornos). Esta opción puede incluir el valor % (aquí) s, que se expande a la
directorio en el que se encontró el archivo de configuración del supervisor. Valores que contienen
los caracteres no alfanuméricos deben estar entrecomillados (p. ej. CLAVE = "val: 123", CLAVE2 = "val, 456").
De lo contrario, citar los valores es opcional pero se recomienda. Para escapar por ciento
caracteres, simplemente use dos. (p.ej URI = "/ first %% 20name") Note que los subprocesos
heredar las variables de entorno del shell utilizado para iniciar supervisor excepto por el
las anuladas aquí y dentro del programa entorno opción. Ver
subproceso_entorno.

Predeterminado: sin valores

Requerido: No.

Introducido: 3.0

identificador
La cadena de identificación para este proceso supervisor, utilizada por la interfaz RPC.

Predeterminado: supervisor

Requerido: No.

Introducido: 3.0

[supervisor] Sección Ejemplo
[supervisor]
archivo de registro = /tmp/supervisord.log
logfile_maxbytes = 50 MB
logfile_backups = 10
nivel de registro = información
archivo pid = /tmp/supervisord.pid
nodaemon = falso
minfds = 1024
procesos mínimos = 200
máscara = 022
usuario = crisma
identificador = supervisor
directorio = / Tmp
nocleanup = verdadero
directorio_hijo = / Tmp
strip_ansi = falso
entorno = CLAVE1 = "valor1", CLAVE2 = "valor2"

[supervisorctl] Sección Ajustes
El archivo de configuración puede contener ajustes para el supervisorctl shell interactivo
programa. Estas opciones se enumeran a continuación.

[supervisorctl] Sección Valores
URL del servidor
La URL que se debe utilizar para acceder al servidor supervisor, p. Ej.
http://localhost: 9001. Para sockets de dominio UNIX, utilice
unix: ///absolute/path/to/file.sock.

Predeterminado: http://localhost: 9001

Requerido: No.

Introducido: 3.0

nombre de usuario
El nombre de usuario que se debe pasar al servidor supervisor para su uso en la autenticación. Esto debería
ser igual que nombre de usuario de la configuración del servidor supervisor para el puerto o UNIX
socket de dominio al que está intentando acceder.

Predeterminado: Sin nombre de usuario

Requerido: No.

Introducido: 3.0

la contraseña
La contraseña que se debe pasar al servidor supervisor para su uso en la autenticación. Esto debería
ser la versión en texto claro de la contraseña de la configuración del servidor supervisor para el
puerto o socket de dominio UNIX al que está intentando acceder. Este valor no se puede pasar como
un hash SHA. A diferencia de otras contraseñas especificadas en este archivo, debe proporcionarse en
Borrar texto.

Predeterminado: Sin contraseña

Requerido: No.

Introducido: 3.0

puntual
Cadena utilizada como indicador de supervisorctl.

Predeterminado: supervisor

Requerido: No.

Introducido: 3.0

archivo_historial
Un camino para usar como readline archivo de historial persistente. Si habilita esta función
eligiendo una ruta, sus comandos supervisorctl se mantendrán en el archivo, y puede usar
readline (por ejemplo, flecha hacia arriba) para invocar los comandos que realizó en su último supervisorctl
de preguntas y respuestas.

Predeterminado: Ningún archivo

Requerido: No.

Introducido: 3.0a5

[supervisorctl] Sección Ejemplo
[supervisorctl]
serverurl = unix: ///tmp/supervisor.sock
nombre de usuario = chris
contraseña = 123
aviso = mi supervisor

[programa: x] Sección Ajustes
El archivo de configuración debe contener uno o más programa secciones para supervisar
para saber qué programas debe iniciar y controlar. El valor del encabezado es un valor compuesto.
Es la palabra "programa", seguida directamente por dos puntos, luego el nombre del programa. Un encabezado
valor de [programa: foo] describe un programa con el nombre de "foo". El nombre se usa
dentro de las aplicaciones cliente que controlan los procesos que se crean como resultado de este
configuración. Es un error crear un programa sección que no tiene nombre. los
El nombre no debe incluir dos puntos ni corchetes. El valor del nombre es
utilizado como el valor de la % (nombre_programa) s expansión de expresión de cadena dentro de otros valores
donde se especifique.

NOTA:
A [programa: x] En realidad, la sección representa un "grupo de procesos homogéneo" para el supervisor.
(a partir de 3.0). Los miembros del grupo se definen por la combinación de los números
y nombre del proceso parámetros en la configuración. De forma predeterminada, si numprocs y
process_name no se modifican con respecto a sus valores predeterminados, el grupo representado por
[programa: x] será nombrado x y tendrá un solo proceso llamado x en eso. Esto
proporciona un mínimo de compatibilidad con versiones anteriores de supervisor, que no
No trate las secciones del programa como definiciones de grupos de procesos homogéneos.

Pero, por ejemplo, si tienes un [programa: foo] sección con un números de 3 y un
nombre del proceso expresión de % (nombre_programa) s _% (núm_proceso) 02d, el grupo "foo"
contienen tres procesos, llamados foo_00, foo_01y foo_02. Esto hace posible
iniciar una serie de procesos muy similares utilizando un solo [programa: x] sección. Todos
Los nombres de los archivos de registro, todas las cadenas del entorno y el comando de los programas también pueden contener
expresiones de cadena de Python similares, para pasar parámetros ligeramente diferentes a cada
.

[programa: x] Sección Valores
comando
El comando que se ejecutará cuando se inicie este programa. El comando puede ser
absoluto (p. ej. / ruta / a / nombre de programa) o pariente (p. ej. nombre del programa). Si esto es
relativo, el entorno del supervisor $ RUTA se buscará el ejecutable.
Los programas pueden aceptar argumentos, p. Ej. / ruta / al / programa foo de caramelos. La línea de comando puede usar
comillas dobles para agrupar argumentos con espacios para pasar al programa, por ejemplo
/ ruta / al / programa / nombre -p "foo bar". Tenga en cuenta que el valor de comando puede incluir Python
expresiones de cadena, p. ej. / ruta / a / nombre de programa --port = 80% (núm_proceso) 02d podría expandirse
a / ruta / a / nombre de programa --port = 8000 en tiempo de ejecución. Se evalúan las expresiones de cadena
contra un diccionario que contiene las claves Nombre del grupo, nombre_nodo_host, núm_proceso,
nombre_programa, esta página (el directorio del archivo de configuración de supervisor), y todos
variables de entorno del supervisor con el prefijo ENV_. Los programas controlados deben
ellos mismos no ser demonios, ya que el supervisor asume que es responsable de demonizar sus
subprocesos (ver nondaemonizing_of_subprocesses).

Predeterminado: Ningún valor predeterminado.

Requerido: Si.

Introducido: 3.0

nombre del proceso
Una expresión de cadena de Python que se utiliza para componer el nombre del proceso supervisor para este
proceso. Por lo general, no necesita preocuparse por configurar esto a menos que cambie
números. La expresión de cadena se evalúa contra un diccionario que incluye
Nombre del grupo, nombre_nodo_host, núm_proceso, nombre_programay esta página (el directorio de la
archivo de configuración de supervisor).

Predeterminado: % (nombre_programa) s

Requerido: No.

Introducido: 3.0

números
El supervisor iniciará tantas instancias de este programa como las nombre numprocs. Nota
que si numprocs> 1, el nombre del proceso la expresión debe incluir % (núm_proceso) s (o cualquier
otra expresión de cadena de Python válida que incluya núm_proceso) dentro de ella.

Predeterminado: 1

Requerido: No.

Introducido: 3.0

numprocs_start
Un desplazamiento de entero que se utiliza para calcular el número en el que números empieza.

Predeterminado: 0

Requerido: No.

Introducido: 3.0

lista de prioridades
La prioridad relativa del programa en el orden de inicio y apagado. Más bajo
Las prioridades indican los programas que se inician primero y se cierran por última vez al inicio y cuando
Los comandos agregados se utilizan en varios clientes (por ejemplo, "iniciar todo" / "detener todo"). Más alto
las prioridades indican los programas que comienzan en último lugar y se cierran primero.

Predeterminado: 999

Requerido: No.

Introducido: 3.0

inicio automático
Si es verdadero, este programa se iniciará automáticamente cuando se inicie el supervisor.

Predeterminado: cierto

Requerido: No.

Introducido: 3.0

iniciosecs
El número total de segundos que el programa necesita para seguir ejecutándose después de un inicio para
considerar el inicio exitoso (moviendo el proceso desde el COMENZANDO estado al
RUNNING estado). Ajustado a 0 para indicar que el programa no necesita seguir ejecutándose durante
cantidad particular de tiempo.

NOTA:
Incluso si un proceso sale con un código de salida "esperado" (consulte códigos de salida), el comienzo
aún se considerará una falla si el proceso sale más rápido de lo que iniciosecs.

Predeterminado: 1

Requerido: No.

Introducido: 3.0

reintentos
El número de intentos fallidos en serie que supervisor permitirá al intentar
Inicie el programa antes de darse por vencido y poner el proceso en un FATAL estado. Ver
process_states para una explicación del FATAL estado.

Predeterminado: 3

Requerido: No.

Introducido: 3.0

reinicio automático
Especifica si supervisor debe reiniciar automáticamente un proceso si sale cuando está
existentes RUNNING estado. Puede ser uno de false, inesperadoo verdadero. Si false, el proceso
no se reiniciará automáticamente. Si inesperado, el proceso se reiniciará cuando el
El programa sale con un código de salida que no es uno de los códigos de salida asociados con este
configuración del proceso (ver códigos de salida) Si verdadero, el proceso será incondicional
reiniciado cuando sale, sin tener en cuenta su código de salida.

NOTA:
reinicio automático controla si supervisor reiniciará automáticamente un programa si sale
después de que se haya iniciado con éxito (el proceso está en el RUNNING estado).

supervisor tiene un mecanismo de reinicio diferente para cuando el proceso se está iniciando
(el proceso está en el COMENZANDO estado). Los reintentos durante el inicio del proceso son
controlado por iniciosecs y reintentos.

Predeterminado: inesperado

Requerido: No.

Introducido: 3.0

códigos de salida
La lista de códigos de salida "esperados" para este programa utilizado con reinicio automático. Si el
reinicio automático el parámetro se establece en inesperado, y el proceso finaliza de cualquier otra forma que no sea
como resultado de una solicitud de detención del supervisor, supervisor reiniciará el proceso si
sale con un código de salida que no está definido en esta lista.

Predeterminado: 0,2

Requerido: No.

Introducido: 3.0

señal de parada
La señal utilizada para matar el programa cuando se solicita una parada. Puede ser cualquiera de TERM,
HUP, INT, QUIT, KILL, USR1 o USR2.

Predeterminado: TÉRMINO

Requerido: No.

Introducido: 3.0

pararesperarsegundos
La cantidad de segundos para esperar a que el sistema operativo devuelva un SIGCHILD a supervisor después de la
Se ha enviado una señal de parada al programa. Si este número de segundos transcurre antes
supervisor recibe un SIGCHILD del proceso, supervisor intentará matarlo
con un SIGKILL final.

Predeterminado: 10

Requerido: No.

Introducido: 3.0

grupo de personas
Si es verdadero, la bandera hace que el supervisor envíe la señal de parada a todo el grupo de procesos.
e implica grupokillas es verdad. Esto es útil para programas, como Flask en depuración
modo, que no propagan señales de alto a sus hijos, dejándolos huérfanos.

Predeterminado: falso

Requerido: No.

Introducido: 3.0b1

grupokillas
Si es verdadero, al recurrir a enviar SIGKILL al programa para terminarlo, envíelo a su
en cambio, todo el grupo de proceso, cuidando a sus hijos también, útil, por ejemplo, con
Programas de Python que usan multiprocesamiento.

Predeterminado: falso

Requerido: No.

Introducido: 3.0a11

usuario
Instruir supervisor para utilizar esta cuenta de usuario de UNIX como la cuenta que ejecuta el
programa. El usuario solo se puede cambiar si supervisor se ejecuta como usuario root. Si
supervisor no puede cambiar al usuario especificado, el programa no se iniciará.

NOTA:
El usuario se cambiará usando setuid solamente. Esto no inicia un shell de inicio de sesión y
no cambia variables de entorno como USUARIO or INICIO. Vea
subprocess_environment para obtener más detalles.

Predeterminado: No cambie de usuario

Requerido: No.

Introducido: 3.0

redirigir_stderr
Si es verdadero, hace que la salida stderr del proceso se envíe de vuelta a supervisor en su salida estándar
descriptor de archivo (en términos de shell de UNIX, esto es el equivalente a ejecutar /el programa
2> y 1).

NOTA:
No ajustar redirect_stderr = true en una [escuchador de eventos: x] sección. Oyentes de eventos
utilizan el stdout y stdin para comunicarse con supervisor. Si stderr es redirigido,
salida de stderr interferirá con el protocolo eventlistener.

Predeterminado: falso

Requerido: No.

Introducido: 3.0, reemplaza a 2.0 log_stdout y log_stderr

stdout_archivo de registro
Coloque el resultado de la salida estándar del proceso en este archivo (y si redirect_stderr es verdadero, también coloque
stderr en este archivo). Si stdout_archivo de registro está desarmado o configurado en AUTO, supervisora
elegirá automáticamente una ubicación de archivo. Si esto se establece en NINGUNO, el supervisor
no cree ningún archivo de registro. AUTO Los archivos de registro y sus copias de seguridad se eliminarán cuando supervisor
reinicia. los stdout_archivo de registro El valor puede contener expresiones de cadena de Python que
evaluado contra un diccionario que contiene las claves Nombre del grupo, nombre_nodo_host,
núm_proceso, nombre_programay esta página (el directorio del archivo de configuración del supervisor).

NOTA:
No es posible que dos procesos compartan un solo archivo de registro (stdout_archivo de registro)
cuando la rotaciónstdout_logfile_maxbytes) está habilitado. Esto resultará en el archivo
siendo corrompido.

Predeterminado: AUTO

Requerido: No.

Introducido: 3.0, reemplaza a 2.0 archivo de registro

stdout_logfile_maxbytes
El número máximo de bytes que puede consumir stdout_archivo de registro antes de que se gire
(En el valor se pueden utilizar multiplicadores de sufijos como "KB", "MB" y "GB"). Establecer esto
valor a 0 para indicar un tamaño de registro ilimitado.

Predeterminado: 50MB

Requerido: No.

Introducido: 3.0, reemplaza a 2.0 archivo de registro_maxbytes

stdout_logfile_copias de seguridad
El número de stdout_archivo de registro copias de seguridad para mantener a su alrededor resultantes del proceso de registro de salida estándar
rotación de archivos. Si se establece en 0, no se guardarán copias de seguridad.

Predeterminado: 10

Requerido: No.

Introducido: 3.0, reemplaza a 2.0 logfile_backups

stdout_capture_maxbytes
Número máximo de bytes escritos para capturar FIFO cuando el proceso está en "modo de captura de salida estándar"
(ver modo_de_captura). Debe ser un número entero (multiplicadores de sufijo como "KB", "MB" y "GB"
se puede utilizar en el valor). Si este valor es 0, el modo de captura de proceso estará desactivado.

Predeterminado: 0

Requerido: No.

Introducido: 3.0, reemplaza a 2.0 logfile_backups

stdout_events_habilitado
Si es verdadero, se emitirán eventos PROCESS_LOG_STDOUT cuando el proceso escriba en su
descriptor de archivo stdout. Los eventos solo se emitirán si el descriptor de archivo no está
en modo de captura en el momento en que se reciben los datos (ver modo_de_captura).

Predeterminado: 0

Requerido: No.

Introducido: 3.0a7

stderr_archivo de registro
Coloque la salida del proceso stderr en este archivo a menos que redirigir_stderr es verdad. Acepta el
mismos tipos de valor que stdout_archivo de registro y puede contener las mismas expresiones de cadena de Python.

NOTA:
No es posible que dos procesos compartan un solo archivo de registro (stderr_archivo de registro)
cuando la rotaciónstderr_logfile_maxbytes) está habilitado. Esto resultará en el archivo
siendo corrompido.

Predeterminado: AUTO

Requerido: No.

Introducido: 3.0

stderr_logfile_maxbytes
El número máximo de bytes antes de la rotación del archivo de registro para stderr_archivo de registro. Acepta el
mismos tipos de valor que stdout_logfile_maxbytes.

Predeterminado: 50MB

Requerido: No.

Introducido: 3.0

stderr_logfile_copias de seguridad
El número de copias de seguridad que se deben conservar como resultado de la rotación del archivo de registro stderr del proceso.
Si se establece en 0, no se guardarán copias de seguridad.

Predeterminado: 10

Requerido: No.

Introducido: 3.0

stderr_capture_maxbytes
Número máximo de bytes escritos para capturar FIFO cuando el proceso está en "modo de captura estándar"
(ver modo_de_captura). Debe ser un número entero (multiplicadores de sufijo como "KB", "MB" y "GB"
se puede utilizar en el valor). Si este valor es 0, el modo de captura de proceso estará desactivado.

Predeterminado: 0

Requerido: No.

Introducido: 3.0

stderr_events_habilitado
Si es verdadero, se emitirán eventos PROCESS_LOG_STDERR cuando el proceso escriba en su
descriptor de archivo stderr. Los eventos solo se emitirán si el descriptor de archivo no está
en modo de captura en el momento en que se reciben los datos (ver modo_de_captura).

Predeterminado: falso

Requerido: No.

Introducido: 3.0a7

entorno
Una lista de pares clave / valor en el formulario CLAVE = "val", CLAVE2 = "val2" que se colocará en el
entorno del proceso hijo. La cadena de entorno puede contener una cadena de Python
expresiones que se evaluarán contra un diccionario que contiene Nombre del grupo,
nombre_nodo_host, núm_proceso, nombre_programay esta página (el directorio del supervisor
archivo de configuración). Los valores que contengan caracteres no alfanuméricos se deben citar (p. Ej.
CLAVE = "val: 123", CLAVE2 = "val, 456"). De lo contrario, citar los valores es opcional pero
recomendado. Note que el subproceso heredará las variables de entorno del
shell utilizado para iniciar "supervisor" excepto los que se anulan aquí. Ver
subproceso_entorno.

Predeterminado: Sin entorno extra

Requerido: No.

Introducido: 3.0

directorio
Una ruta de archivo que representa un directorio al que supervisor debería chdir temporalmente
antes de ejecutar al niño.

Predeterminado: No chdir (heredar supervisor)

Requerido: No.

Introducido: 3.0

umask
Un número octal (por ejemplo, 002, 022) que representa la umask del proceso.

Predeterminado: Sin umask especial (heredar del supervisor)

Requerido: No.

Introducido: 3.0

URL del servidor
La URL pasada en el entorno al proceso de subproceso como SUPERVISOR_SERVER_URL
(consulta: supervisor.childutils) para permitir que el subproceso se comunique fácilmente con el
servidor HTTP interno. Si se proporciona, debe tener la misma sintaxis y estructura que el
[supervisorctl] opción de sección del mismo nombre. Si está configurado en AUTO o no está configurado,
El supervisor construirá automáticamente una URL de servidor, dando preferencia a un servidor.
que escucha en sockets de dominio UNIX sobre uno que escucha en un socket de Internet.

Predeterminado: AUTOMÁTICO

Requerido: No.

Introducido: 3.0

[programa: x] Sección Ejemplo
[programa: gato]
comando =/ papelera / gato
nombre_proceso =% (nombre_programa) s
numprocs = 1
directorio =/ Tmp
umask = 022
prioridad = 999
inicio automático = verdadero
autorestart = inesperado
startsecs = 10
startretries = 3
códigos de salida = 0,2
StopSignal = TERM
stopwaitsecs = 10
stopasgroup = falso
killasgroup = falso
usuario = crisma
redirect_stderr = false
stdout_logfile = / a / ruta
stdout_logfile_maxbytes = 1 MB
stdout_logfile_backups = 10
stdout_capture_maxbytes = 1 MB
stdout_events_enabled = falso
stderr_logfile = / a / ruta
stderr_logfile_maxbytes = 1 MB
stderr_logfile_backups = 10
stderr_capture_maxbytes = 1 MB
stderr_events_enabled = falso
entorno = A = "1", B = "2"
serverurl = AUTO

[incluir] Sección Ajustes
El supervisord.conf el archivo puede contener una sección llamada [incluir]. Si la configuración
el archivo contiene un [incluir] sección, debe contener una única clave denominada "archivos". los
Los valores de esta clave especifican otros archivos de configuración que se incluirán en el
configuración.

[incluir] Sección Valores
archivos
Una secuencia de archivos globales separados por espacios. Cada archivo global puede ser absoluto o relativo.
Si el archivo glob es relativo, se considera relativo a la ubicación del
archivo de configuración que lo incluye. Un "glob" es un patrón de archivo que coincide con un
patrón especificado de acuerdo con las reglas utilizadas por el shell de Unix. Ninguna expansión de tilde es
hecho, pero *, ?y rangos de caracteres expresados ​​con [] se emparejará correctamente.
No se admiten las inclusiones recursivas de archivos incluidos.

Predeterminado: No predeterminado (obligatorio)

Requerido: Si.

Introducido: 3.0

[incluir] Sección Ejemplo
[incluir]
archivos = /an/absolute/filename.conf /an/absolute/*.conf foo.conf config ??. conf

[grupo: x] Sección Ajustes
A menudo es útil agrupar grupos de procesos "homogéneos" (también conocidos como "programas") en un
grupo de procesos "heterogéneo" para que puedan ser controlados como una unidad desde el supervisor
Varias interfaces de controlador.

Para colocar programas en un grupo de modo que pueda tratarlos como una unidad, defina un [grupo: x] .
en su archivo de configuración. El valor del encabezado del grupo es un compuesto. Es la palabra
"grupo", seguido directamente por dos puntos, luego el nombre del grupo. Un valor de encabezado de [grupo: foo]
describe un grupo con el nombre de "foo". El nombre se utiliza en las aplicaciones cliente.
que controlan los procesos que se crean como resultado de esta configuración. Es un
error para crear un grupo de XNUMX sección que no tiene nombre. El nombre no debe incluir un
carácter de dos puntos o un carácter de corchete.

Para una [grupo: x], debe haber uno o más [programa: x] secciones en otras partes de su
archivo de configuración, y el grupo debe referirse a ellos por su nombre en el programas .

Si los grupos de procesos "homogéneos" (representados por secciones del programa) se colocan en un
grupo "heterogéneo" a través de [grupo: x] sección programas línea, los grupos homogéneos que
están implícitos en la sección del programa no existirán en tiempo de ejecución en supervisor. En cambio, todos
Los procesos pertenecientes a cada uno de los grupos homogéneos se colocarán en el
grupo heterogéneo. Por ejemplo, dada la siguiente configuración de grupo:

[grupo: foo]
programas = bar, baz
prioridad = 999

Dado lo anterior, al inicio del supervisor, el de caramelos y baz los grupos homogéneos no
existen, y los procesos que habrían estado bajo ellos ahora se moverán al foo
grupo.

[grupo: x] Sección Valores
programas
Una lista de nombres de programas separados por comas. Los programas que se enumeran se convierten en miembros
del grupo.

Predeterminado: No predeterminado (obligatorio)

Requerido: Si.

Introducido: 3.0

lista de prioridades
Un número de prioridad análogo a un [programa: x] valor de prioridad asignado al grupo.

Predeterminado: 999

Requerido: No.

Introducido: 3.0

[grupo: x] Sección Ejemplo
[grupo: foo]
programas = bar, baz
prioridad = 999

[programa-fcgi: x] Sección Ajustes
El supervisor puede gestionar grupos de FastCGI procesos que todos escuchan en el mismo socket.
Hasta ahora, la flexibilidad de implementación de FastCGI era limitada. Para obtener el proceso completo
administración, podría usar mod_fastcgi en Apache, pero luego se quedó atascado con Apache
Modelo de concurrencia ineficiente de un proceso o subproceso por conexión. Además de
requiriendo más recursos de CPU y memoria, el proceso / subproceso por modelo de conexión puede ser
saturado rápidamente por un recurso lento, evitando que se sirvan otros recursos. En
para aprovechar los nuevos servidores web controlados por eventos, como lighttpd o nginx, que
no incluye un administrador de procesos incorporado, tenía que usar scripts como cgi-fcgi o
spawn-fcgi. Estos se pueden utilizar junto con un administrador de procesos como supervisor
o daemontools pero requieren que cada proceso hijo FastCGI se vincule a su propio socket. los
Las desventajas de esto son: configuración del servidor web innecesariamente complicada, mala
se reinicia y se reduce la tolerancia a fallos. Con menos sockets para configurar, servidor web
las configuraciones son mucho más pequeñas si los grupos de procesos FastCGI pueden compartir sockets. Compartido
Los sockets permiten reinicios elegantes porque el socket permanece vinculado por el proceso principal
mientras se reinicia cualquiera de los procesos secundarios. Finalmente, los sockets compartidos son más
tolerante a fallas porque si un proceso dado falla, otros procesos pueden continuar sirviendo
conexiones entrantes.

Con el soporte de generación de FastCGI integrado, Supervisor le ofrece lo mejor de ambos mundos.
Obtiene una gestión de procesos con todas las funciones con grupos de procesos FastCGI que comparten sockets
sin estar vinculado a un servidor web en particular. Es una clara separación de preocupaciones
permitiendo que el servidor web y el administrador de procesos hagan cada uno lo que mejor saben hacer.

NOTA:
El administrador de sockets en Supervisor se desarrolló originalmente para admitir procesos FastCGI
pero no se limita a FastCGI. También se pueden utilizar otros protocolos sin especial
configuración. Cualquier programa que pueda acceder a un socket abierto desde un descriptor de archivo (p. Ej.
socket.fromfd en Python) puede usar el administrador de sockets. El supervisor
crear automáticamente el socket, enlazar y escuchar antes de bifurcar al primer hijo en un
grupo. El conector se pasará a cada hijo en el número de descriptor de archivo 0 (cero).
Cuando salga el último niño del grupo, el supervisor cerrará el enchufe.

Todas las opciones disponibles para [programa: x] Las secciones también son respetadas por programa-fcgi
.

[programa-fcgi: x] Sección Valores
[programa-fcgi: x] las secciones tienen una sola tecla que [programa: x] secciones no tienen.

enchufe
El socket FastCGI para este programa, ya sea TCP o socket de dominio UNIX. Para sockets TCP,
use este formato: tcp: // localhost: 9002. Para sockets de dominio UNIX, utilice
unix: ///absolute/path/to/file.sock. Las expresiones de cadena se evalúan contra un
diccionario que contiene las claves "nombre_programa" y "aquí" (el directorio del
archivo de configuración de supervisor).

Predeterminado: Ningún valor predeterminado.

Requerido: Si.

Introducido: 3.0

propietario_enchufe
Para sockets de dominio UNIX, este parámetro se puede utilizar para especificar el usuario y el grupo para
el enchufe FastCGI. Puede ser un nombre de usuario de UNIX (por ejemplo, crisma) o un nombre de usuario y un grupo de UNIX
separados por dos puntos (por ejemplo, crisma: rueda).

Predeterminado: Utiliza el usuario y el grupo establecidos para el programa fcgi

Requerido: No.

Introducido: 3.0

modo_enchufe
Para sockets de dominio UNIX, este parámetro se puede utilizar para especificar el modo de permiso.

Predeterminado: 0700

Requerido: No.

Introducido: 3.0

Consulta [programa: x] Sección Ajustes para otras claves permitidas, delta las restricciones anteriores
y adiciones.

[programa-fcgi: x] Sección Ejemplo
[programa-fcgi: fcgiprogramname]
comando = / usr / bin / example.fcgi
socket = unix: /// var / run / supervisor /% (nombre_programa) s.sock
propietario_enchufe = crisma
modo_enchufe = 0700
nombre_proceso =% (nombre_programa) s _% (núm_proceso) 02d
numprocs = 5
directorio =/ Tmp
umask = 022
prioridad = 999
inicio automático = verdadero
autorestart = inesperado
startsecs = 1
startretries = 3
códigos de salida = 0,2
StopSignal = SALIR
stopasgroup = falso
killasgroup = falso
stopwaitsecs = 10
usuario = crisma
redirect_stderr = true
stdout_logfile = / a / ruta
stdout_logfile_maxbytes = 1 MB
stdout_logfile_backups = 10
stdout_events_enabled = falso
stderr_logfile = / a / ruta
stderr_logfile_maxbytes = 1 MB
stderr_logfile_backups = 10
stderr_events_enabled = falso
entorno = A = "1", B = "2"
serverurl = AUTO

[escuchador de eventos: x] Sección Ajustes
Supervisor permite que los grupos de procesos homogéneos especializados ("grupos de escucha de eventos") sean
definido dentro del archivo de configuración. Estos grupos contienen procesos destinados a
recibir y responder a las notificaciones de eventos del sistema de eventos del supervisor. Ver eventos para
una explicación de cómo funcionan los eventos y cómo implementar programas que se pueden declarar como
oyentes de eventos.

Tenga en cuenta que todas las opciones disponibles para [programa: x] las secciones son respetadas por eventlistener
(secciones) excepto para stdout_capture_maxbytes y stderr_capture_maxbytes (oyentes de eventos
no puede emitir eventos de comunicación de proceso, consulte modo_de_captura).

[escuchador de eventos: x] Sección Valores
[escuchador de eventos: x] las secciones tienen algunas teclas que [programa: x] secciones no tienen.

tamaño del búfer
Tamaño del búfer de cola de eventos del grupo de escucha de eventos. Cuando el búfer de eventos de un grupo de oyentes
está desbordado (como puede suceder cuando un grupo de oyentes de eventos no puede mantenerse al día con todos los
eventos enviados a él), el evento más antiguo en el búfer se descarta.

Eventos
Una lista separada por comas de nombres de tipos de eventos en los que este oyente está "interesado"
recibir notificaciones para (consulte event_types para obtener una lista de nombres de tipos de eventos válidos).

manejador_resultados
A paquetes_recursos entrada punto cadena que se resuelve en un Python invocable. El valor por defecto
Valor es supervisor.dispatchers: default_handler. Especificar un resultado alternativo
handler es algo muy poco común que se debe hacer y, como resultado, cómo crear uno es
no documentado.

Consulta [programa: x] Sección Ajustes para otras claves permitidas, delta las restricciones anteriores
y adiciones.

[escuchador de eventos: x] Sección Ejemplo
[eventlistener: theventlistenername]
comando = / bin / eventlistener
nombre_proceso =% (nombre_programa) s _% (núm_proceso) 02d
numprocs = 5
eventos = PROCESS_STATE
buffer_size = 10
directorio =/ Tmp
umask = 022
prioridad = -1
inicio automático = verdadero
autorestart = inesperado
startsecs = 1
startretries = 3
códigos de salida = 0,2
StopSignal = SALIR
stopwaitsecs = 10
stopasgroup = falso
killasgroup = falso
usuario = crisma
redirect_stderr = false
stdout_logfile = / a / ruta
stdout_logfile_maxbytes = 1 MB
stdout_logfile_backups = 10
stdout_events_enabled = falso
stderr_logfile = / a / ruta
stderr_logfile_maxbytes = 1 MB
stderr_logfile_backups = 10
stderr_events_enabled = falso
entorno = A = "1", B = "2"
serverurl = AUTO

[rpcinterface: x] Sección Ajustes
Adición rpcinterface: x La configuración del archivo de configuración solo es útil para las personas que
desea ampliar el supervisor con un comportamiento personalizado adicional.

En el archivo de configuración de muestra, hay una sección que se llama [rpcinterface: supervisor].
De forma predeterminada, se parece a lo siguiente.

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

El [rpcinterface: supervisor] . debe permanecer en la configuración para el estándar
configuración del supervisor para que funcione correctamente. Si no quiere que el supervisor haga nada,
no hace ya fuera de la caja, esto es todo lo que necesita saber sobre este tipo de
.

Sin embargo, si desea agregar espacios de nombres de interfaz rpc para personalizar supervisor, debe
puede agregar adicionales [rpcinterface: foo] secciones, donde "foo" representa el espacio de nombres de
la interfaz (desde la raíz web), y el valor nombrado por supervisor.rpcinterface_factory
es un invocable de fábrica que debe tener una firma de función que acepte un solo
argumento posicional supervisor y tantos argumentos de palabras clave como sea necesario para realizar
configuración. Cualquier par clave / valor adicional definido dentro del [rpcinterface: x] la sección será
pasar como argumentos de palabra clave a la fábrica.

Aquí hay un ejemplo de una función de fábrica, creada en el __init__.py archivo de Python
paquete mi paquete.

desde my.package.rpcinterface importar AnotherRPCInterface

def make_another_rpcinterface (supervisor, ** config):
reintentos = int (config.get ('reintentos', 0))
another_rpc_interface = AnotherRPCInterface (supervisor, reintentos)
devolver otra_rpc_interface

Y una sección en el archivo de configuración destinada a configurarlo.

[rpcinterface: otro]
supervisor.rpcinterface_factory = my.package: make_another_rpcinterface
reintentos = 1

[rpcinterface: x] Sección Valores
supervisor.rpcinterface_factory
paquetes_recursos "punto de entrada" nombre con puntos a la función de fábrica de su interfaz RPC.

Predeterminado: N/A

Requerido: No.

Introducido: 3.0

[rpcinterface: x] Sección Ejemplo
[rpcinterface: otro]
supervisor.rpcinterface_factory = my.package: make_another_rpcinterface
reintentos = 1

Glosario
Daemon Tools
A control te by DJ Bernstein.

lanzamiento
A control te usado by Apple como proceso 1 en Mac OS X.

ejecutarlo A control te.

superlanza
Un paquete que proporciona varias implementaciones de escucha de eventos que se conectan a
Supervisor que puede ayudar a monitorear el uso de la memoria del proceso y el estado de fallas:
http://pypi.python.org/pypi/superlance.

umask Abreviación de usuario máscara: establece la máscara de creación del modo de archivo del proceso actual.
See http://en.wikipedia.org/wiki/Umask.

Utilice echo_supervisord_conf en línea utilizando los servicios de onworks.net