echo_supervisord_conf - Online na nuvem

PROGRAMA:

NOME

echo_supervisord_conf - Documentação de configuração do supervisor

Supervisor é um sistema cliente / servidor que permite aos seus usuários monitorar e controlar um número
de processos em sistemas operacionais semelhantes ao UNIX.

Ele compartilha alguns dos mesmos objetivos de programas como launchd, daemontools e runit. diferente
alguns desses programas, não se destina a ser executado como um substituto para o init como "id de processo
1 ". Em vez disso, deve ser usado para controlar processos relacionados a um projeto ou
cliente e deve ser iniciado como qualquer outro programa no momento da inicialização.

DOCUMENTAÇÃO

Criar a Configuração Envie o
Assim que a instalação do Supervisor for concluída, execute echo_supervisord_conf. Isso vai
imprima uma "amostra" do arquivo de configuração do Supervisor no stdout do seu terminal.

Depois de ver o arquivo ecoado em seu terminal, invoque novamente o comando como
echo_supervisord_conf > /etc/supervisord.conf. Isso não funcionará se você não tiver root
acesso.

Se você não tem acesso root, ou prefere não colocar o supervisord.conf arquivo em
/etc/supervisord.conf`, você pode colocá-lo no diretório atual (echo_supervisord_conf >
supervisord.conf) e começar Supervisor com o -c bandeira a fim de especificar o
localização do arquivo de configuração.

Por exemplo, Supervisor -c supervisord.conf. Usando o -c sinalizador na verdade é redundante em
neste caso, porque Supervisor procura o diretório atual por um supervisord.conf
antes de procurar qualquer outro local para o arquivo, mas funcionará.

Depois de ter um arquivo de configuração em seu sistema de arquivos, você pode começar a modificá-lo para o seu
gosto.

Configuração Envie o
O arquivo de configuração do Supervisor é convencionalmente denominado supervisord.conf. É usado por
ambos Supervisor e supervisorctl. Se qualquer um dos aplicativos for iniciado sem o -c
opção (a opção queéusada para indicar à aplicação o nome do ficheiro de configuração
explicitamente), o aplicativo irá procurar um arquivo chamado supervisord.conf dentro do
seguintes locais, na ordem especificada. Ele usará o primeiro arquivo que encontrar.

1. $ CWD / supervisord.conf

2. $ CWD / etc / supervisord.conf

3. /etc/supervisord.conf

4. ../etc/supervisord.conf (Relativo ao executável)

5. ../supervisord.conf (Relativo ao executável)

NOTA:
Algumas distribuições empacotaram o Supervisor com suas próprias personalizações. Esses
versões modificadas do Supervisor podem carregar o arquivo de configuração de outros locais
do que aqueles descritos aqui. Notavelmente, foram encontrados pacotes do Ubuntu que usam
/etc/supervisor/supervisord.conf.

Envie o Formato
supervisord.conf é um arquivo do estilo Windows-INI (Python ConfigParser). Tem seções (cada
denotado por um [cabeçalho]) e pares de chave / valor dentro das seções. As seções e seus
os valores permitidos são descritos abaixo.

Meio Ambiente Variáveis
Variáveis ​​de ambiente que estão presentes no ambiente no momento em que Supervisor is
iniciado pode ser usado no arquivo de configuração usando a sintaxe de expressão de string do Python
% (ENV_X) s:

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

No exemplo acima, a expressão % (ENV_LOGLEVEL) s seria expandido para o valor de
a variável de ambiente NÍVEL DE LOG.

NOTA:
No Supervisor 3.2 e posterior, % (ENV_X) s expressões são suportadas em todas as opções. No
versões anteriores, algumas opções os suportam, mas a maioria não. Veja a documentação para
cada opção abaixo.

[unix_http_servidor] Seção Configurações
A supervisord.conf arquivo contém uma seção chamada [unix_http_servidor] sob as quais
os parâmetros de configuração para um servidor HTTP que escuta em um soquete de domínio UNIX devem ser
inserido. Se o arquivo de configuração não tiver [unix_http_servidor] seção, um domínio UNIX
O servidor HTTP socket não será iniciado. Os valores de configuração permitidos são como
Segue.

[unix_http_servidor] Seção Valores
lima
Um caminho para um soquete de domínio UNIX (por exemplo /tmp/supervisord.sock) no qual o supervisor irá
escute as solicitações HTTP / XML-RPC. supervisorctl usa XML-RPC para se comunicar com
Supervisor sobre esta porta. Esta opção pode incluir o valor % (aqui) s, que expande
para o diretório no qual o Supervisor arquivo de configuração foi encontrado.

Padrão: Nenhum.

Exigido: Não.

Introduzido 3.0

chmod
Altere os bits do modo de permissão UNIX do soquete de domínio UNIX para este valor em
startup

Padrão: 0700

Exigido: Não.

Introduzido 3.0

chown
Altere o usuário e o grupo do arquivo de soquete para este valor. Pode ser um nome de usuário UNIX
(por exemplo: crisma) ou um nome de usuário e grupo UNIX separados por dois pontos (por exemplo, crisma: roda).

Padrão: Use o nome de usuário e o grupo do usuário que inicia o supervisord.

Exigido: Não.

Introduzido 3.0

nome de usuário
O nome de usuário necessário para autenticação neste servidor HTTP.

Padrão: Não é necessário nome de usuário.

Exigido: Não.

Introduzido 3.0

senha
A senha necessária para autenticação neste servidor HTTP. Este pode ser um texto claro
senha, ou pode ser especificado como um hash SHA-1 se prefixado pela string {SHA}. Para
exemplo, {SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d é a versão armazenada em SHA do
senha "thepassword".

Observe que a senha com hash deve estar no formato hexadecimal.

Padrão: Não é necessária senha.

Exigido: Não.

Introduzido 3.0

[unix_http_servidor] Seção Exemplo
[unix_http_servidor]
arquivo = /tmp/supervisor.sock
chmod = 0777
chown = nobody: nogroup
nome de usuário = usuário
senha = 123

[inet_http_servidor] Seção Configurações
A supervisord.conf arquivo contém uma seção chamada [inet_http_servidor] sob as quais
os parâmetros de configuração para um servidor HTTP que escuta em um soquete TCP (internet) devem
ser inserido. Se o arquivo de configuração não tiver [inet_http_servidor] seção, um inet HTTP
o servidor não será iniciado. Os valores de configuração permitidos são os seguintes.

[inet_http_servidor] Seção Valores
porta
Um host TCP: valor da porta ou (por exemplo 127.0.0.1:9001) no qual o supervisor ouvirá
Solicitações HTTP / XML-RPC. supervisorctl usará XML-RPC para se comunicar com Supervisor
sobre esta porta. Para ouvir em todas as interfaces da máquina, use : 9001 or *: 9001.

Padrão: Nenhum padrão.

Exigido: Sim.

Introduzido 3.0

nome de usuário
O nome de usuário necessário para autenticação neste servidor HTTP.

Padrão: Não é necessário nome de usuário.

Exigido: Não.

Introduzido 3.0

senha
A senha necessária para autenticação neste servidor HTTP. Este pode ser um texto claro
senha, ou pode ser especificado como um hash SHA-1 se prefixado pela string {SHA}. Para
exemplo, {SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d é a versão armazenada em SHA do
senha "thepassword".

Observe que a senha com hash deve estar no formato hexadecimal.

Padrão: Não é necessária senha.

Exigido: Não.

Introduzido 3.0

[inet_http_servidor] Seção Exemplo
[inet_http_servidor]
porta = 127.0.0.1:9001
nome de usuário = usuário
senha = 123

[supervisor] Seção Configurações
A supervisord.conf arquivo contém uma seção chamada [supervisor] em quais configurações globais
relacionado ao Supervisor processo deve ser inserido. Estes são os seguintes.

[supervisor] Seção Valores
arquivo de log
O caminho para o log de atividades do processo supervisord. Esta opção pode incluir o
valor % (aqui) s, que se expande para o diretório no qual a configuração do supervisord
arquivo foi encontrado.

Padrão: $ CWD / supervisord.log

Exigido: Não.

Introduzido 3.0

logfile_maxbytes
O número máximo de bytes que podem ser consumidos pelo arquivo de registro de atividades antes de ser
girado (multiplicadores de sufixo como "KB", "MB" e "GB" podem ser usados ​​no valor). Definir
este valor é 0 para indicar um tamanho de log ilimitado.

Padrão: 50MB

Exigido: Não.

Introduzido 3.0

logfile_backups
O número de backups a serem mantidos resultantes da rotação do arquivo de log de atividades. Se definido
para 0, nenhum backup será mantido.

Padrão 10

Exigido: Não.

Introduzido 3.0

nível de log
O nível de registro, ditando o que é gravado no registro de atividades do supervisord. Um de
crítico, erro, avisar, info, depurar, traçarou falar mal. Observe que no nível de registro depurar,
o arquivo de log do supervisord gravará a saída stderr / stdout de seus processos filho
e informações estendidas sobre as mudanças de estado do processo, que são úteis para depurar um
processo que não está iniciando corretamente. Veja também: activity_log_levels.

Padrão: informações

Exigido: Não.

Introduzido 3.0

arquivo pid
O local em que supervisord mantém seu arquivo pid. Esta opção pode incluir o
valor % (aqui) s, que se expande para o diretório no qual a configuração do supervisord
arquivo foi encontrado.

Padrão: $ CWD / supervisord.pid

Exigido: Não.

Introduzido 3.0

umask
O umask do processo supervisord.

Padrão: 022

Exigido: Não.

Introduzido 3.0

nodaemon
Se verdadeiro, o supervisord iniciará em primeiro plano em vez de daemonizar.

Padrão: falso

Exigido: Não.

Introduzido 3.0

atenção
O número mínimo de descritores de arquivo que devem estar disponíveis antes que o supervisord
começar com sucesso. Uma chamada para setrlimit será feita para tentar aumentar o soft e
limites rígidos do processo de supervisão para satisfazer atenção. O limite rígido pode ser apenas
gerado se supervisord for executado como root. supervisord usa descritores de arquivo liberalmente, e
entrará em um modo de falha quando não puder ser obtido no sistema operacional, por isso é útil ser
capaz de especificar um valor mínimo para garantir que não os esgote durante a execução.
Esta opção é particularmente útil no Solaris, que tem um baixo limite de fd por processo por
padrão.

Padrão 1024

Exigido: Não.

Introduzido 3.0

minprocs
O número mínimo de descritores de processo que devem estar disponíveis antes do supervisord
vai começar com sucesso. Uma chamada para setrlimit será feita para tentar aumentar o soft
e limites rígidos do processo de supervisão para satisfazer minprocs. O limite rígido pode
somente será gerado se supervisord for executado como root. supervisord entrará em modo de falha
quando o sistema operacional fica sem descritores de processo, por isso é útil garantir que o suficiente
descritores de processo estão disponíveis mediante Supervisor startup

Padrão 200

Exigido: Não.

Introduzido 3.0

sem limpeza
Impedir supervisord de limpar qualquer AUTO arquivos de log filho no momento da inicialização.
Útil para depuração.

Padrão: falso

Exigido: Não.

Introduzido 3.0

childlogdir
O diretório usado para AUTO arquivos de log filho. Esta opção pode incluir o valor
% (aqui) s, que se expande para o diretório no qual o Supervisor arquivo de configuração
foi encontrado.

Padrão: valor de Python's tempfile.get_tempdir ()

Exigido: Não.

Introduzido 3.0

usuário
Instruir Supervisor para mudar os usuários para esta conta de usuário UNIX antes de fazer qualquer
processamento significativo. O usuário só pode ser trocado se Supervisor é iniciado como o
usuário root. Se Supervisor não pode mudar de usuário, ainda continuará, mas escreverá um
mensagem de registro no crítico nível dizendo que não pode perder privilégios.

Padrão: não troque de usuário

Exigido: Não.

Introduzido 3.0

anuário
Quando Supervisor daemonizes, mude para este diretório. Esta opção pode incluir o
valor % (aqui) s, que se expande para o diretório no qual o Supervisor • Configuração
arquivo foi encontrado.

Padrão: não cd

Exigido: Não.

Introduzido 3.0

strip_ansi
Retire todas as sequências de escape ANSI dos arquivos de log filho.

Padrão: falso

Exigido: Não.

Introduzido 3.0

meio Ambiente
Uma lista de pares de chave / valor no formulário KEY = "val", KEY2 = "val2" que será colocado no
Supervisor processo 'ambiente (e como resultado em todo o seu processo filho'
ambientes). Esta opção pode incluir o valor % (aqui) s, que se expande para o
diretório no qual o arquivo de configuração supervisord foi encontrado. Valores contendo
caracteres não alfanuméricos devem ser colocados entre aspas (por exemplo KEY = "val: 123", KEY2 = "val, 456").
Caso contrário, citar os valores é opcional, mas recomendado. Para escapar por cento
caracteres, basta usar dois. (por exemplo: URI = "/ primeiro %% 20nome") Note que os subprocessos irão
herdar as variáveis ​​de ambiente do shell usado para iniciar Supervisor exceto para o
aqueles substituídos aqui e dentro do programa meio Ambiente opção. Ver
subprocesso_ambiente.

Padrão: sem valores

Exigido: Não.

Introduzido 3.0

identificador
A string identificadora para este processo de supervisor, usada pela interface RPC.

Padrão: Supervisor

Exigido: Não.

Introduzido 3.0

[supervisor] Seção Exemplo
[supervisor]
arquivo de log = /tmp/supervisord.log
logfile_maxbytes = 50 MB
logfile_backups = 10
nível de log = informações
arquivopid = /tmp/supervisord.pid
nodaemon = falso
minfds = 1024
minprocs = 200
umask = 022
usuário = crisma
identificador = supervisor
diretório = / Tmp
nocleanup = verdadeiro
filhologdir = / Tmp
strip_ansi = falso
ambiente = KEY1 = "valor1", KEY2 = "valor2"

[supervisorctl] Seção Configurações
O arquivo de configuração pode conter configurações para o supervisorctl escudo interativo
programa. Essas opções estão listadas abaixo.

[supervisorctl] Seção Valores
URL do servidor
O URL que deve ser usado para acessar o servidor supervisord, por exemplo
http://localhost: 9001. Para soquetes de domínio UNIX, use
unix: ///absolute/path/to/file.sock.

Padrão: http://localhost: 9001

Exigido: Não.

Introduzido 3.0

nome de usuário
O nome de usuário a ser passado ao servidor supervisord para uso na autenticação. Isto deveria
ser o mesmo que nome de usuário da configuração do servidor supervisord para a porta ou UNIX
soquete de domínio que você está tentando acessar.

Padrão: Sem nome de usuário

Exigido: Não.

Introduzido 3.0

senha
A senha a ser passada ao servidor supervisord para uso na autenticação. Isto deveria
seja a versão em texto claro de senha da configuração do servidor supervisord para o
porta ou soquete de domínio UNIX que você está tentando acessar. Este valor não pode ser passado como
um hash SHA. Ao contrário de outras senhas especificadas neste arquivo, deve ser fornecido em
Texto claro.

Padrão: Nenhuma senha

Exigido: Não.

Introduzido 3.0

pronto
String usada como prompt supervisorctl.

Padrão: supervisor

Exigido: Não.

Introduzido 3.0

arquivo_histórico
Um caminho para usar como readline arquivo de histórico persistente. Se você habilitar este recurso por
escolher um caminho, seus comandos supervisorctl serão mantidos no arquivo, e você pode usar
readline (por exemplo, seta para cima) para invocar comandos que você executou em seu último supervisorctl
sessão.

Padrão: Nenhum arquivo

Exigido: Não.

Introduzido: 3.0a5

[supervisorctl] Seção Exemplo
[supervisorctl]
serverurl = unix: ///tmp/supervisor.sock
nome de usuário = cris
senha = 123
prompt = meu supervisor

[programa: x] Seção Configurações
O arquivo de configuração deve conter um ou mais programa seções em ordem para supervisord
para saber quais programas ele deve iniciar e controlar. O valor do cabeçalho é um valor composto.
É a palavra "programa", seguida diretamente por dois pontos e, em seguida, o nome do programa. Um cabeçalho
valor de [programa: foo] descreve um programa com o nome de "foo". O nome é usado
dentro de aplicativos clientes que controlam os processos que são criados como resultado deste
configuração. É um erro criar um programa seção que não tem um nome. o
O nome não deve incluir dois-pontos ou colchetes. O valor do nome é
usado como o valor para o % (program_name) s expansão da expressão de string dentro de outros valores
onde especificado.

NOTA:
A [programa: x] seção realmente representa um "grupo de processo homogêneo" para o supervisor
(a partir de 3.0). Os membros do grupo são definidos pela combinação do numprocs
e nome do processo parâmetros na configuração. Por padrão, se numprocs e
process_name são deixados inalterados de seus padrões, o grupo representado por
[programa: x] será nomeado x e terá um único processo denominado x iniciar. Esta
fornece um mínimo de compatibilidade com versões anteriores de versões mais antigas do supervisor, o que
não tratar as seções do programa como definições homogêneas de grupos de processos.

Mas, por exemplo, se você tiver um [programa: foo] seção com um numprocs de 3 e um
nome do processo expressão de % (program_name) s _% (process_num) 02d, o grupo "foo" irá
contém três processos, chamados foo_00, foo_01 e foo_02. Isto torna possível
iniciar uma série de processos muito semelhantes usando um único [programa: x] seção. Tudo
nomes de arquivos de log, todas as strings de ambiente e o comando de programas também podem conter
expressões de string Python semelhantes, para passar parâmetros ligeiramente diferentes para cada
processo.

[programa: x] Seção Valores
comando
O comando que será executado quando este programa for iniciado. O comando pode ser qualquer
absoluto (por exemplo / caminho / para / nome do programa) ou parente (por exemplo nome do programa) Se for
relativo, o ambiente do supervisord $ PATH será pesquisado para o executável.
Os programas podem aceitar argumentos, por exemplo / caminho / para / programa Foo Barra. A linha de comando pode usar
aspas duplas para agrupar argumentos com espaços para passar para o programa, por exemplo
/ caminho / para / programa / nome -p "foo Barra". Observe que o valor de comando pode incluir Python
expressões de string, por exemplo / caminho / para / nome do programa --port = 80% (process_num) 02d pode expandir
para / caminho / para / nome do programa --port = 8000 em tempo de execução. Expressões de string são avaliadas
contra um dicionário contendo as chaves nome do grupo, host_node_name, núm_processo,
nome do programa, SUA PARTICIPAÇÃO FAZ A DIFERENÇA (o diretório do arquivo de configuração supervisord), e todos
variáveis ​​de ambiente do supervisord prefixadas com ENV_. Programas controlados devem
eles próprios não são daemons, já que o supervisord assume que é responsável por daemonizar seu
subprocessos (consulte nondaemonizing_of_subprocesses).

Padrão: Nenhum padrão.

Exigido: Sim.

Introduzido 3.0

nome do processo
Uma expressão de string Python que é usada para compor o nome do processo do supervisor para este
processo. Normalmente você não precisa se preocupar em definir isso, a menos que mude
numprocs. A expressão de string é avaliada em relação a um dicionário que inclui
nome do grupo, host_node_name, núm_processo, nome do programa e SUA PARTICIPAÇÃO FAZ A DIFERENÇA (o diretório do
arquivo de configuração supervisord).

Padrão: % (program_name) s

Exigido: Não.

Introduzido 3.0

numprocs
O Supervisor iniciará tantas instâncias deste programa quantas forem nomeadas por numprocs. Observação
que se numprocs> 1, o nome do processo a expressão deve incluir % (process_num) s (ou qualquer
outra expressão de string Python válida que inclui núm_processo) dentro dele.

Padrão 1

Exigido: Não.

Introduzido 3.0

numprocs_start
Um deslocamento inteiro usado para calcular o número no qual numprocs Começa.

Padrão 0

Exigido: Não.

Introduzido 3.0

prioridade
A prioridade relativa do programa na ordem de início e encerramento. Diminuir
as prioridades indicam os programas que começam primeiro e desligam por último na inicialização e quando
comandos agregados são usados ​​em vários clientes (por exemplo, "start all" / "stop all"). Superior
as prioridades indicam os programas que começam por último e são encerrados primeiro.

Padrão 999

Exigido: Não.

Introduzido 3.0

começo automático
Se verdadeiro, este programa iniciará automaticamente quando o supervisord for iniciado.

Padrão: verdade

Exigido: Não.

Introduzido 3.0

startecs
O número total de segundos que o programa precisa para permanecer em execução após uma inicialização para
considere o início bem-sucedido (movendo o processo do INICIANDO estado para o
CORRENDO Estado). Definido como 0 para indicar que o programa não precisa ficar em execução por nenhum
determinado período de tempo.

NOTA:
Mesmo se um processo sair com um código de saída "esperado" (ver códigos de saída), o começo
ainda será considerado uma falha se o processo sair mais rápido do que startecs.

Padrão 1

Exigido: Não.

Introduzido 3.0

estelares
O número de tentativas de falha de série que Supervisor permitirá ao tentar
iniciar o programa antes de desistir e colocar o processo em um FATAL Estado. Ver
process_states para explicação do FATAL Estado.

Padrão 3

Exigido: Não.

Introduzido 3.0

reinício automático
Especifica se Supervisor deve reiniciar automaticamente um processo se ele sair quando estiver
no CORRENDO Estado. Pode ser um dos falso, inesperadoou verdadeiro. Se falso, o processo
não será reiniciado automaticamente. Se inesperado, o processo será reiniciado quando o
o programa sai com um código de saída que não é um dos códigos de saída associados a este
configuração do processo (ver códigos de saída). Se verdadeiro, o processo será incondicionalmente
reiniciado ao sair, sem levar em consideração seu código de saída.

NOTA:
reinício automático controla se Supervisor irá reiniciar um programa se ele sair
depois de ter iniciado com sucesso (o processo está no CORRENDO Estado).

Supervisor tem um mecanismo de reinicialização diferente para quando o processo está inicializando
(o processo está no INICIANDO Estado). As tentativas durante a inicialização do processo são
controlado por startecs e estelares.

Padrão: inesperado

Exigido: Não.

Introduzido 3.0

códigos de saída
A lista de códigos de saída "esperados" para este programa usado com reinício automático. Se o
reinício automático parâmetro está definido como inesperado, e o processo sai de qualquer outra forma que não
como resultado de uma solicitação de parada do supervisor, Supervisor irá reiniciar o processo se
sai com um código de saída que não está definido nesta lista.

Padrão 0,2

Exigido: Não.

Introduzido 3.0

sinal de parada
O sinal usado para encerrar o programa quando uma parada é solicitada. Pode ser qualquer um de TERM,
HUP, INT, QUIT, KILL, USR1 ou USR2.

Padrão: PRAZO

Exigido: Não.

Introduzido 3.0

segundos de espera
O número de segundos de espera para o sistema operacional retornar um SIGCHILD para Supervisor depois de
programa foi enviado um sinal de parada. Se este número de segundos decorrer antes
Supervisor recebe um SIGCHILD do processo, Supervisor vai tentar matá-lo
com um SIGKILL final.

Padrão 10

Exigido: Não.

Introduzido 3.0

grupo de parada
Se verdadeiro, o sinalizador faz com que o supervisor envie o sinal de parada para todo o grupo de processo
e implica grupo killas é verdade. Isso é útil para programas, como Flask em depuração
modo, que não propagam sinais de parada para seus filhos, deixando-os órfãos.

Padrão: falso

Exigido: Não.

Introduzido: 3.0b1

grupo killas
Se verdadeiro, ao recorrer a enviar SIGKILL ao programa para encerrá-lo, envie-o para seu
todo o grupo de processo em vez disso, cuidando de seus filhos também, útil, por exemplo, com
Programas Python usando multiprocessamento.

Padrão: falso

Exigido: Não.

Introduzido: 3.0a11

usuário
Instruir Supervisor para usar esta conta de usuário UNIX como a conta que executa o
programa. O usuário só pode ser trocado se Supervisor é executado como usuário root. Se
Supervisor não pode mudar para o usuário especificado, o programa não será iniciado.

NOTA:
O usuário será alterado usando definir tempo só. Isso não inicia um shell de login e
não muda as variáveis ​​de ambiente como USUÁRIO or EMPRESA. Ver
subprocess_environment para obter detalhes.

Padrão: Não troque de usuário

Exigido: Não.

Introduzido 3.0

redirecionar_stderr
Se verdadeiro, faz com que a saída stderr do processo seja enviada de volta para Supervisor em seu stdout
descritor de arquivo (em termos de shell UNIX, isso é o equivalente a executar /o programa
2> e 1).

NOTA:
Não definir redirect_stderr = true num [ouvinte de eventos: x] seção. Eventlisteners
usar stdout e stdin para se comunicar com Supervisor. Se stderr é redirecionado,
Saída de stderr irá interferir no protocolo do listener de eventos.

Padrão: falso

Exigido: Não.

Introduzido: 3.0, substitui 2.0's log_stdout e log_stderr

arquivo_log_stdout
Coloque a saída do processo stdout neste arquivo (e se redirect_stderr for verdadeiro, também coloque
saída stderr neste arquivo). Se arquivo_log_stdout não está definido ou definido para AUTO, Supervisor
irá escolher automaticamente um local para o arquivo. Se estiver definido para NENHUM, supervisord irá
não crie nenhum arquivo de log. AUTO arquivos de log e seus backups serão excluídos quando Supervisor
reinicia. o arquivo_log_stdout valor pode conter expressões de string Python que irão
avaliado em relação a um dicionário que contém as chaves nome do grupo, host_node_name,
núm_processo, nome do programa e SUA PARTICIPAÇÃO FAZ A DIFERENÇA (o diretório do arquivo de configuração supervisord).

NOTA:
Não é possível que dois processos compartilhem um único arquivo de log (arquivo_log_stdout)
quando a rotação (stdout_logfile_maxbytes) está ativado. Isso resultará no arquivo
sendo corrompido.

Padrão: AUTO

Exigido: Não.

Introduzido: 3.0, substitui 2.0's arquivo de log

stdout_logfile_maxbytes
O número máximo de bytes que podem ser consumidos por arquivo_log_stdout antes de ser girado
(multiplicadores de sufixo como "KB", "MB" e "GB" podem ser usados ​​no valor). Defina isto
valor para 0 para indicar um tamanho de log ilimitado.

Padrão: 50MB

Exigido: Não.

Introduzido: 3.0, substitui 2.0's logfile_maxbytes

stdout_logfile_backups
O número de arquivo_log_stdout backups a serem mantidos resultantes do log de saída padrão do processo
rotação de arquivo. Se definido como 0, nenhum backup será mantido.

Padrão 10

Exigido: Não.

Introduzido: 3.0, substitui 2.0's logfile_backups

stdout_capture_maxbytes
Número máximo de bytes gravados para capturar FIFO quando o processo está no "modo de captura stdout"
(veja capture_mode). Deve ser um número inteiro (multiplicadores de sufixo como "KB", "MB" e "GB"
pode ser usado no valor). Se este valor for 0, o modo de captura de processo será desativado.

Padrão 0

Exigido: Não.

Introduzido: 3.0, substitui 2.0's logfile_backups

stdout_events_enabled
Se verdadeiro, eventos PROCESS_LOG_STDOUT serão emitidos quando o processo gravar em seu
descritor de arquivo stdout. Os eventos só serão emitidos se o descritor de arquivo não for
no modo de captura no momento em que os dados são recebidos (consulte capture_mode).

Padrão 0

Exigido: Não.

Introduzido: 3.0a7

stderr_logfile
Coloque a saída do processo stderr neste arquivo, a menos que redirecionar_stderr é verdade. Aceita o
mesmos tipos de valor que arquivo_log_stdout e pode conter as mesmas expressões de string Python.

NOTA:
Não é possível que dois processos compartilhem um único arquivo de log (stderr_logfile)
quando a rotação (stderr_logfile_maxbytes) está ativado. Isso resultará no arquivo
sendo corrompido.

Padrão: AUTO

Exigido: Não.

Introduzido 3.0

stderr_logfile_maxbytes
O número máximo de bytes antes da rotação do arquivo de log para stderr_logfile. Aceita o
mesmos tipos de valor que stdout_logfile_maxbytes.

Padrão: 50MB

Exigido: Não.

Introduzido 3.0

stderr_logfile_backups
O número de backups a serem mantidos resultantes da rotação do arquivo de log stderr do processo.
Se definido como 0, nenhum backup será mantido.

Padrão 10

Exigido: Não.

Introduzido 3.0

stderr_capture_maxbytes
Número máximo de bytes gravados para capturar FIFO quando o processo está no "modo de captura stderr"
(veja capture_mode). Deve ser um número inteiro (multiplicadores de sufixo como "KB", "MB" e "GB"
pode ser usado no valor). Se este valor for 0, o modo de captura de processo será desativado.

Padrão 0

Exigido: Não.

Introduzido 3.0

stderr_events_enabled
Se verdadeiro, eventos PROCESS_LOG_STDERR serão emitidos quando o processo gravar em seu
descritor de arquivo stderr. Os eventos só serão emitidos se o descritor de arquivo não for
no modo de captura no momento em que os dados são recebidos (consulte capture_mode).

Padrão: falso

Exigido: Não.

Introduzido: 3.0a7

meio Ambiente
Uma lista de pares de chave / valor no formulário KEY = "val", KEY2 = "val2" que será colocado no
ambiente do processo filho. A string de ambiente pode conter string Python
expressões que serão avaliadas em relação a um dicionário contendo nome do grupo,
host_node_name, núm_processo, nome do programa e SUA PARTICIPAÇÃO FAZ A DIFERENÇA (o diretório do supervisord
arquivo de configuração). Valores contendo caracteres não alfanuméricos devem ser colocados entre aspas (por exemplo
KEY = "val: 123", KEY2 = "val, 456") Caso contrário, citar os valores é opcional, mas
recomendado. Note que o subprocesso irá herdar as variáveis ​​de ambiente do
shell usado para iniciar o "supervisord" exceto para aqueles sobrescritos aqui. Ver
subprocesso_ambiente.

Padrão: Sem ambiente extra

Exigido: Não.

Introduzido 3.0

anuário
Um caminho de arquivo que representa um diretório para o qual Supervisor deveria temporariamente chdir
antes de executar a criança.

Padrão: Sem chdir (herdar do supervisor)

Exigido: Não.

Introduzido 3.0

umask
Um número octal (por exemplo, 002, 022) que representa o umask do processo.

Padrão: Sem umask especial (herdar do supervisor)

Exigido: Não.

Introduzido 3.0

URL do servidor
A URL passada no ambiente para o processo do subprocesso como SUPERVISOR_SERVER_URL
(Vejo supervisor.childutils) para permitir que o subprocesso se comunique facilmente com o
servidor HTTP interno. Se fornecido, deve ter a mesma sintaxe e estrutura do
[supervisorctl] opção de seção com o mesmo nome. Se estiver definido como AUTO ou não estiver definido,
supervisor construirá automaticamente uma URL de servidor, dando preferência a um servidor
que escuta em soquetes de domínio UNIX sobre um que escuta em um soquete de Internet.

Padrão: AUTOMÁTICO

Exigido: Não.

Introduzido 3.0

[programa: x] Seção Exemplo
[programa: gato]
comando =/ bin / cat
process_name =% (program_name) s
numprocs = 1
diretório =/ Tmp
umask = 022
prioridade = 999
autostart = true
autorestart = inesperado
startecs = 10
startretries = 3
códigos de saída = 0,2
stopignal = TERM
stopwaitsecs = 10
stopasgroup = false
killasgroup = false
usuário = crisma
redirect_stderr = false
stdout_logfile = / a / caminho
stdout_logfile_maxbytes = 1 MB
stdout_logfile_backups = 10
stdout_capture_maxbytes = 1 MB
stdout_events_enabled = false
stderr_logfile = / a / caminho
stderr_logfile_maxbytes = 1 MB
stderr_logfile_backups = 10
stderr_capture_maxbytes = 1 MB
stderr_events_enabled = false
ambiente = A = "1", B = "2"
serverurl = AUTO

[incluir] Seção Configurações
A supervisord.conf arquivo pode conter uma seção chamada [incluir]. Se a configuração
arquivo contém um [incluir] seção, ele deve conter uma única chave chamada "arquivos". o
valores nesta chave especificam outros arquivos de configuração a serem incluídos no
configuração.

[incluir] Seção Valores
arquivos
Uma sequência separada por espaço de globs de arquivo. Cada arquivo glob pode ser absoluto ou relativo.
Se o arquivo glob for relativo, ele é considerado relativo à localização do
arquivo de configuração que o inclui. Um "glob" é um padrão de arquivo que corresponde a um
padrão especificado de acordo com as regras usadas pelo shell Unix. Nenhuma expansão de til é
feito, mas *, ?, e intervalos de caracteres expressos com [] será correspondido corretamente.
Inclusões recursivas de arquivos incluídos não são suportadas.

Padrão: Sem padrão (obrigatório)

Exigido: Sim.

Introduzido 3.0

[incluir] Seção Exemplo
[incluir]
files = /an/absolute/filename.conf /an/absolute/*.conf foo.conf config ??. conf

[grupo: x] Seção Configurações
Muitas vezes é útil agrupar grupos de processos "homogêneos" (também conhecidos como "programas") em um
grupo de processos "heterogêneos" para que possam ser controlados como uma unidade do Supervisor
várias interfaces de controlador.

Para colocar programas em um grupo para que você possa tratá-los como uma unidade, defina um [grupo: x] seção
em seu arquivo de configuração. O valor do cabeçalho do grupo é um composto. É a palavra
"grupo", seguido diretamente por dois pontos e o nome do grupo. Um valor de cabeçalho de [grupo: foo]
descreve um grupo com o nome de "foo". O nome é usado em aplicativos clientes
que controlam os processos que são criados como resultado dessa configuração. É um
erro para criar um grupo seção que não tem um nome. O nome não deve incluir um
caractere de dois pontos ou um caractere de colchete.

Para uma [grupo: x], deve haver um ou mais [programa: x] seções em outras partes do seu
arquivo de configuração, e o grupo deve se referir a eles por nome no programas valor.

Se grupos de processos "homogêneos" (representados por seções de programa) são colocados em um
grupo "heterogêneo" via [grupo: x] Seções programas linha, os grupos homogêneos que
estão implícitos na seção do programa não existirá no tempo de execução no supervisor. Em vez disso, todos
processos pertencentes a cada um dos grupos homogêneos serão colocados no
grupo heterogêneo. Por exemplo, dada a seguinte configuração de grupo:

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

Dado o acima exposto, na inicialização do supervisord, o Barra e baz grupos homogêneos não
existem, e os processos que estariam sob eles agora serão movidos para o Foo
grupo.

[grupo: x] Seção Valores
programas
Uma lista separada por vírgulas de nomes de programas. Os programas listados tornam-se membros
do grupo.

Padrão: Sem padrão (obrigatório)

Exigido: Sim.

Introduzido 3.0

prioridade
Um número de prioridade análogo a um [programa: x] valor de prioridade atribuído ao grupo.

Padrão 999

Exigido: Não.

Introduzido 3.0

[grupo: x] Seção Exemplo
[grupo: foo]
programas = bar, baz
prioridade = 999

[programa fcgi: x] Seção Configurações
O supervisor pode gerenciar grupos de CGI rápido processos que ouvem no mesmo soquete.
Até agora, a flexibilidade de implantação do FastCGI era limitada. Para obter o processo completo
gerenciamento, você poderia usar mod_fastcgi no Apache, mas então você estava preso com o Apache
modelo de simultaneidade ineficiente de um processo ou thread por conexão. Além de
exigindo mais recursos de CPU e memória, o processo / thread por modelo de conexão pode ser
rapidamente saturado por um recurso lento, impedindo que outros recursos sejam servidos. No
a fim de aproveitar as vantagens de servidores web orientados a eventos mais recentes, como lighttpd ou nginx, que
não inclui um gerenciador de processos embutido, você teve que usar scripts como cgi-fcgi ou
spawn-fcgi. Estes podem ser usados ​​em conjunto com um gerenciador de processo, como supervisord
ou daemontools, mas exigem que cada processo filho FastCGI se vincule a seu próprio soquete. o
desvantagens disso são: configuração desnecessariamente complicada do servidor da web, desagradável
reinicia e redução da tolerância a falhas. Com menos soquetes para configurar, o servidor web
as configurações são muito menores se grupos de processos FastCGI podem compartilhar sockets. Compartilhado
os soquetes permitem reinicializações perfeitas porque o soquete permanece vinculado ao processo pai
enquanto qualquer um dos processos filho está sendo reiniciado. Finalmente, sockets compartilhados são mais
tolerante a falhas porque se um determinado processo falhar, outros processos podem continuar a servir
conexões de entrada.

Com o suporte de desova FastCGI integrado, o Supervisor oferece o melhor dos dois mundos.
Você obtém gerenciamento de processo completo com grupos de processos FastCGI compartilhando sockets
sem estar vinculado a um servidor web específico. É uma separação clara de preocupações,
permitindo que o servidor web e o gerenciador de processos façam o que fazem melhor.

NOTA:
O gerenciador de soquete no Supervisor foi originalmente desenvolvido para suportar processos FastCGI
mas não se limita a FastCGI. Outros protocolos também podem ser usados ​​sem nenhum
configuração. Qualquer programa que pode acessar um socket aberto a partir de um descritor de arquivo (por exemplo
com soquete.fromfd em Python) pode usar o gerenciador de soquetes. Supervisor irá
cria automaticamente o soquete, liga e escuta antes de bifurcar o primeiro filho em um
grupo. O soquete será passado para cada filho no número do descritor de arquivo 0 (zero).
Quando o último filho do grupo sair, o Supervisor fechará o soquete.

Todas as opções disponíveis para [programa: x] seções também são respeitadas por programa fcgi
.

[programa fcgi: x] Seção Valores
[programa fcgi: x] seções têm uma única chave que [programa: x] seções não têm.

soquete
O soquete FastCGI para este programa, ou soquete de domínio TCP ou UNIX. Para soquetes TCP,
use este formato: tcp: // localhost: 9002. Para soquetes de domínio UNIX, use
unix: ///absolute/path/to/file.sock. Expressões de string são avaliadas em relação a um
dicionário contendo as chaves "nome_do_programa" e "aqui" (o diretório do
arquivo de configuração supervisord).

Padrão: Nenhum padrão.

Exigido: Sim.

Introduzido 3.0

proprietário_soquete
Para soquetes de domínio UNIX, este parâmetro pode ser usado para especificar o usuário e grupo para
o soquete FastCGI. Pode ser um nome de usuário UNIX (por exemplo, chrism) ou um nome de usuário e grupo UNIX
separados por dois pontos (por exemplo, crisma: roda).

Padrão: Usa o usuário e grupo definido para o programa fcgi

Exigido: Não.

Introduzido 3.0

modo_soquete
Para soquetes de domínio UNIX, este parâmetro pode ser usado para especificar o modo de permissão.

Padrão 0700

Exigido: Não.

Introduzido 3.0

Consultar [programa: x] Seção Configurações para outras chaves permitidas, delta as restrições acima
e adições.

[programa fcgi: x] Seção Exemplo
[fcgi-program: fcgiprogramname]
comando = / usr / bin / example.fcgi
socket = unix: /// var / run / supervisor /% (program_name) s.sock
socket_owner = chrism
socket_mode = 0700
process_name =% (program_name) s _% (process_num) 02d
numprocs = 5
diretório =/ Tmp
umask = 022
prioridade = 999
autostart = true
autorestart = inesperado
startecs = 1
startretries = 3
códigos de saída = 0,2
stopignal = SAIR
stopasgroup = false
killasgroup = false
stopwaitsecs = 10
usuário = crisma
redirect_stderr = true
stdout_logfile = / a / caminho
stdout_logfile_maxbytes = 1 MB
stdout_logfile_backups = 10
stdout_events_enabled = false
stderr_logfile = / a / caminho
stderr_logfile_maxbytes = 1 MB
stderr_logfile_backups = 10
stderr_events_enabled = false
ambiente = A = "1", B = "2"
serverurl = AUTO

[ouvinte de eventos: x] Seção Configurações
O supervisor permite que grupos de processos homogêneos especializados ("pools de ouvintes de eventos") sejam
definido no arquivo de configuração. Esses pools contêm processos que se destinam a
receber e responder a notificações de eventos do sistema de eventos do supervisor. Veja eventos para
uma explicação de como os eventos funcionam e como implementar programas que podem ser declarados como
ouvintes de eventos.

Observe que todas as opções disponíveis para [programa: x] as seções são respeitadas pelo ouvinte de eventos
seções exceto para stdout_capture_maxbytes e stderr_capture_maxbytes (ouvintes de eventos
não pode emitir eventos de comunicação de processo, consulte capture_mode).

[ouvinte de eventos: x] Seção Valores
[ouvinte de eventos: x] seções têm algumas chaves que [programa: x] seções não têm.

tamanho do buffer
O tamanho do buffer da fila de eventos do pool do listener de eventos. Quando o buffer de eventos de um pool de ouvintes
está estourado (como pode acontecer quando um pool de ouvintes de evento não consegue acompanhar todos os
eventos enviados para ele), o evento mais antigo no buffer é descartado.

eventos
Uma lista separada por vírgulas de nomes de tipo de evento nos quais este ouvinte está "interessado"
receber notificações para (consulte event_types para obter uma lista de nomes de tipos de eventos válidos).

manipulador_resultado
A pkg_resources entrada ponto corda que resolve para um Python chamável. O padrão
valor é supervisor.dispatchers: default_handler. Especificando um resultado alternativo
manipulador é uma coisa muito incomum de se fazer e, como resultado, como criar um é
não documentado.

Consultar [programa: x] Seção Configurações para outras chaves permitidas, delta as restrições acima
e adições.

[ouvinte de eventos: x] Seção Exemplo
[listener de eventos: theeventlistenername]
command = / bin / eventlistener
process_name =% (program_name) s _% (process_num) 02d
numprocs = 5
eventos = PROCESS_STATE
buffer_size = 10
diretório =/ Tmp
umask = 022
prioridade = -1
autostart = true
autorestart = inesperado
startecs = 1
startretries = 3
códigos de saída = 0,2
stopignal = SAIR
stopwaitsecs = 10
stopasgroup = false
killasgroup = false
usuário = crisma
redirect_stderr = false
stdout_logfile = / a / caminho
stdout_logfile_maxbytes = 1 MB
stdout_logfile_backups = 10
stdout_events_enabled = false
stderr_logfile = / a / caminho
stderr_logfile_maxbytes = 1 MB
stderr_logfile_backups = 10
stderr_events_enabled = false
ambiente = A = "1", B = "2"
serverurl = AUTO

[interface rpc: x] Seção Configurações
Adicionando rpcinterface: x configurações no arquivo de configuração só são úteis para pessoas que
deseja estender o supervisor com comportamento personalizado adicional.

No arquivo de configuração de amostra, há uma seção chamada [interface rpc: supervisor].
Por padrão, é semelhante ao seguinte.

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

A [interface rpc: supervisor] seção devo permanecem na configuração para o padrão
configuração do supervisor para funcionar corretamente. Se você não quiser que o supervisor faça nada,
ainda não faz fora da caixa, isso é tudo que você precisa saber sobre este tipo de
seção.

No entanto, se você deseja adicionar namespaces de interface rpc para personalizar o supervisor, você
pode adicionar mais [rpcinterface: foo] seções, onde "foo" representa o namespace de
a interface (da raiz da web) e o valor nomeado por supervisor.rpcinterface_factory
é uma chamada de fábrica que deve ter uma assinatura de função que aceita um único
argumento posicional Supervisor e quantos argumentos de palavra-chave forem necessários para realizar
configuração. Quaisquer pares de chave / valor extras definidos no [interface rpc: x] seção vai
ser passados ​​como argumentos de palavra-chave para a fábrica.

Aqui está um exemplo de uma função de fábrica, criada no __init__.py arquivo do Python
pacote Meu pacote.

de my.package.rpcinterface importar OutraRPCInterface

def make_another_rpcinterface (supervisord, ** config):
retries = int (config.get ('retries', 0))
another_rpc_interface = AnotherRPCInterface (supervisord, tentativas)
retornar outra_rpc_interface

E uma seção no arquivo de configuração destinada a configurá-lo.

[interface rpc: outra]
supervisor.rpcinterface_factory = my.package: make_another_rpcinterface
tentativas = 1

[interface rpc: x] Seção Valores
supervisor.rpcinterface_factory
pkg_resources nome pontilhado do "ponto de entrada" para a função de fábrica da interface RPC.

Padrão: N / D

Exigido: Não.

Introduzido 3.0

[interface rpc: x] Seção Exemplo
[interface rpc: outra]
supervisor.rpcinterface_factory = my.package: make_another_rpcinterface
tentativas = 1

Glossário
Daemon Tools
A processo ao controle . by DJ Bernstein.

launchd
A processo ao controle . usava by Apple como processo 1 no Mac OS X.

executá-lo A processo ao controle ..

Superlança
Um pacote que fornece várias implementações de ouvinte de evento que se conectam ao
Supervisor que pode ajudar a monitorar o uso de memória do processo e o status do travamento:
http://pypi.python.org/pypi/superlance.

umask Abreviatura de usuário máscara: define a máscara de criação do modo de arquivo do processo atual.
See http://en.wikipedia.org/wiki/Umask.

Use echo_supervisord_conf online usando serviços onworks.net