echo_supervisord_conf - クラウドでオンライン

プログラム：

NAME

echo_supervisord_conf - スーパーバイザー構成ドキュメント

スーパーバイザは、ユーザーが数値を監視および制御できるクライアント/サーバー システムです。
UNIX 系オペレーティング システム上のプロセスの数。

これは、launchd、daemontools、runit などのプログラムと同じ目標の一部を共有しています。 ようではない
これらのプログラムの一部は、代わりに実行することを意図したものではありません。 INIT 「プロセスID」として
1"。代わりに、プロジェクトまたはプロジェクトに関連するプロセスを制御するために使用することを目的としています。
顧客に提供され、ブート時に他のプログラムと同様に開始されることを目的としています。

マニュアル

作成 a 　 File
Supervisor のインストールが完了したら、実行します。 echo_supervisord_conf。 この意志
「サンプル」Supervisor 構成ファイルを端末の stdout に出力します。

ファイルが端末にエコーされたことを確認したら、次のようにコマンドを再呼び出しします。
echo_supervisord_conf > /etc/supervisord.conf. root を持っていない場合、これは機能しません
アクセス。

root アクセス権がない場合、または 監視者.conf 内のファイル
/etc/supervisord.conf`、現在のディレクトリに配置できます（echo_supervisord_conf >
監視者.conf）そして開始 スーパーバイザー -c を指定するためのフラグ
設定ファイルの場所。

たとえば、 スーパーバイザー -c 監視者.conf。 を使用する -c フラグは実際には冗長です
この場合、なぜなら スーパーバイザー 現在のディレクトリを検索して 監視者.conf
ファイルの他の場所を検索する前に、それは機能します。

ファイルシステムに構成ファイルを作成したら、それを変更して、
好み。

　 File
スーパーバイザー構成ファイルは慣習的に名前が付けられています 監視者.conf。 使用されているのは、
両言語で スーパーバイザー と スーパーバイザーctl. いずれかのアプリケーションが -c
オプション (アプリケーションに構成ファイル名を伝えるために使用されるオプション
明示的に）、アプリケーションは次の名前のファイルを探します 監視者.conf 中で
次の場所を指定された順序で。 最初に見つかったファイルが使用されます。

1. $CWD/スーパーバイザーd.conf

2. $CWD/etc/supervisord.conf

3. /etc/supervisord.conf

4. ../etc/supervisord.conf (実行可能ファイルに相対的)

5. ../supervisord.conf (実行可能ファイルに相対的)

注:
一部のディストリビューションでは、Supervisor が独自のカスタマイズでパッケージ化されています。 これらは
Supervisor の変更されたバージョンは、他の場所から構成ファイルをロードする場合があります。
ここに記載されているものよりも。 特に、使用する Ubuntu パッケージが見つかっています。
/etc/スーパーバイザー/スーパーバイザーd.conf.

File フォーマット
監視者.conf Windows-INI スタイル (Python ConfigParser) ファイルです。 セクションがあります（それぞれ
で示される [ヘッダ]) およびセクション内のキーと値のペア。 セクションとその
許容値を以下に示します。

環境 Variables
その時点で環境に存在する環境変数 スーパーバイザー is
started は、Python 文字列式構文を使用して構成ファイルで使用できます
%(ENV_X)s:

【プログラム：例】
コマンド=/usr/bin/example --loglevel=%(ENV_LOGLEVEL)s

上記の例では、式 %(ENV_LOGLEVEL)s の値に拡張されます
環境変数 ログレベル.

注:
Supervisor 3.2 以降では、 %(ENV_X)s 式はすべてのオプションでサポートされています。 の
一部のオプションはサポートしていますが、ほとんどのオプションはサポートしていません。 のドキュメントを参照してください。
以下の各オプション。

[unix_http_server] セクション 設定
この 監視者.conf ファイルには、という名前のセクションが含まれています [unix_http_server] その下で
UNIX ドメイン ソケットをリッスンする HTTP サーバーの構成パラメータは、次のようにする必要があります。
挿入されます。 構成ファイルに [unix_http_server] セクション、UNIX ドメイン
ソケット HTTP サーバーは開始されません。 許容される構成値は次のとおりです。
続く。

[unix_http_server] セクション 価値観
file
UNIX ドメインソケットへのパス (例: /tmp/supervisord.sock）スーパーバイザーが
HTTP/XML-RPC リクエストをリッスンします。 スーパーバイザーctl XML-RPC を使用して通信します
スーパーバイザー このポートを介して。 このオプションには値を含めることができます %(ここ)s、展開します
があるディレクトリに スーパーバイザー 設定ファイルが見つかりました。

デフォルト： なし。

必須：いいえ。

導入: 3.0

chmod
UNIX ドメイン ソケットの UNIX 許可モード ビットを次の値に変更します。
スタートアップ

デフォルト: 0700

必須：いいえ。

導入: 3.0

chown
ソケット ファイルのユーザーとグループをこの値に変更します。 UNIXユーザー名の可能性があります
（例えば クリスム) またはコロンで区切られた UNIX ユーザー名とグループ (例: クリスム：ホイール).

デフォルト: Supervisord を開始するユーザーのユーザー名とグループを使用します。

必須：いいえ。

導入: 3.0

ユーザ名
この HTTP サーバーへの認証に必要なユーザー名。

デフォルト: ユーザー名は必要ありません。

必須：いいえ。

導入: 3.0

password
この HTTP サーバーへの認証に必要なパスワード。 これはクリアテキストにすることができます
パスワード、または文字列が前に付いている場合は SHA-1 ハッシュとして指定できます {社}。 のために
例、 {SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d の SHA 保存バージョンです。
パスワード「thepassword」。

ハッシュされたパスワードは XNUMX 進形式でなければならないことに注意してください。

デフォルト: パスワードは必要ありません。

必須：いいえ。

導入: 3.0

[unix_http_server] セクション 例
[unix_http_server]
ファイル = /tmp/supervisor.sock
chmod = 0777
chown= 誰も:グループなし
ユーザー名 = ユーザー
パスワード = 123

[inet_http_server] セクション 設定
この 監視者.conf ファイルには、という名前のセクションが含まれています [inet_http_server] その下で
TCP (インターネット) ソケットで listen する HTTP サーバーの構成パラメーター
挿入されます。 構成ファイルに [inet_http_server] セクション、inet HTTP
サーバーは起動されません。 設定可能な値は次のとおりです。

[inet_http_server] セクション 価値観
ポート
TCP ホスト:ポート値または (例: 127.0.0.1:9001) スーパーバイザーがリッスンする
HTTP/XML-RPC リクエスト。 スーパーバイザーctl XML-RPC を使用して通信します スーパーバイザー
このポートを介して。 マシン内のすべてのインターフェイスでリッスンするには、次を使用します ：9001 or *:9001.

デフォルト: デフォルトなし。

必須：はい。

導入: 3.0

ユーザ名
この HTTP サーバーへの認証に必要なユーザー名。

デフォルト: ユーザー名は必要ありません。

必須：いいえ。

導入: 3.0

password
この HTTP サーバーへの認証に必要なパスワード。 これはクリアテキストにすることができます
パスワード、または文字列が前に付いている場合は SHA-1 ハッシュとして指定できます {社}。 のために
例、 {SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d の SHA 保存バージョンです。
パスワード「thepassword」。

ハッシュされたパスワードは XNUMX 進形式でなければならないことに注意してください。

デフォルト: パスワードは必要ありません。

必須：いいえ。

導入: 3.0

[inet_http_server] セクション 例
[inet_http_server]
ポート = 127.0.0.1:9001
ユーザー名 = ユーザー
パスワード = 123

[監修] セクション 設定
この 監視者.conf ファイルには、という名前のセクションが含まれています [監修] どのグローバル設定で
の スーパーバイザー プロセスを挿入する必要があります。 これらは次のとおりです。

[監修] セクション 価値観
ログファイル
Supervisord プロセスのアクティビティ ログへのパス。 このオプションには、
値 %(ここ)sこれは、supervisord 構成が格納されているディレクトリに展開されます。
ファイルが見つかりました。

デフォルト: $CWD/supervisord.log

必須：いいえ。

導入: 3.0

logfile_maxbytes
アクティビティ ログ ファイルが削除される前に消費される可能性がある最大バイト数。
回転します (「KB」、「MB」、「GB」などの接尾辞の乗数を値に使用できます)。 設定
ログ サイズが無制限であることを示すには、この値を 0 に設定します。

デフォルト：50MB

必須：いいえ。

導入: 3.0

ログファイルのバックアップ
アクティビティ ログ ファイルのローテーションの結果として保持するバックアップの数。 設定されている場合
0 にすると、バックアップは保持されません。

デフォルト: 10

必須：いいえ。

導入: 3.0

loglevel
ロギング レベル。supervisord アクティビティ ログに何が書き込まれるかを決定します。 の一つ
重大な, エラー, 警告する, info, debug, トレースまたは おしゃべりする. ログレベルで注意してください debug,
Supervisord ログ ファイルは、その子プロセスの stderr/stdout 出力を記録します。
およびプロセス状態の変更に関する拡張情報情報。これは、デバッグに役立ちます。
正しく起動していないプロセス。 参照: activity_log_levels。

デフォルト： 情報

必須：いいえ。

導入: 3.0

pidファイル
Supervisord が pid ファイルを保持する場所。 このオプションには、
値 %(ここ)sこれは、supervisord 構成が格納されているディレクトリに展開されます。
ファイルが見つかりました。

デフォルト: $CWD/スーパーバイザーd.pid

必須：いいえ。

導入: 3.0

umask
Supervisord プロセスの umask。

デフォルト: 022

必須：いいえ。

導入: 3.0

のだえもん
true の場合、supervisord はデーモン化する代わりにフォアグラウンドで開始します。

デフォルト： 間違い

必須：いいえ。

導入: 3.0

ミンフズ
Supervisord が実行する前に利用可能でなければならないファイル記述子の最小数。
正常に起動します。 setrlimit への呼び出しが行われ、ソフトおよび
監視対象プロセスが満たすべき厳しい制限 ミンフズ. ハードリミットは
Supervisord が root として実行されている場合に発生します。 Supervisord はファイル記述子を自由に使用し、
OS から取得できない場合は障害モードになるため、あると便利です。
実行中に不足しないように最小値を指定できます。
このオプションは、プロセスごとの fd 制限が低い Solaris で特に役立ちます。
デフォルト。

デフォルト: 1024

必須：いいえ。

導入: 3.0

minproc
Supervisord の前に使用可能にする必要があるプロセス記述子の最小数
正常に起動します。 ソフトを上げようとするために setrlimit への呼び出しが行われます。
監視対象プロセスの厳しい制限 minproc. ハードリミットは
スーパーバイザーがルートとして実行されている場合にのみ発生します。 Supervisord は障害モードに入ります
OS がプロセス記述子を使い果たしたとき、十分な
プロセス記述子は、 スーパーバイザー スタートアップ

デフォルト: 200

必須：いいえ。

導入: 3.0

ノークリーンアップ
Supervisord が既存のものをクリアできないようにする AUTO 起動時の子ログ ファイル。
デバッグに役立ちます。

デフォルト： 間違い

必須：いいえ。

導入: 3.0

チャイルドログディレクトリ
に使用されるディレクトリ AUTO 子ログ ファイル。 このオプションには値を含めることができます
%(ここ)s、これは、 スーパーバイザー configuration file
発見された。

デフォルト: Python の値 tempfile.get_tempdir()

必須：いいえ。

導入: 3.0

user
指示する スーパーバイザー 何かを行う前に、ユーザーをこの UNIX ユーザー アカウントに切り替える
意味のある処理。 ユーザーを切り替えることができるのは、 スーパーバイザー として開始されます
ルートユーザー。 もしも スーパーバイザー ユーザーを切り替えることはできません。続行しますが、
のログメッセージ 重大な 特権をドロップできないと言っているレベル。

デフォルト: ユーザーを切り替えないでください

必須：いいえ。

導入: 3.0

ディレクトリにジョブを開始します。
日時 スーパーバイザー デーモン化するには、このディレクトリに切り替えます。 このオプションには、
値 %(ここ)s、これは、 スーパーバイザー の監視
ファイルが見つかりました。

デフォルト: cd しない

必須：いいえ。

導入: 3.0

ストリップアンシ
子ログ ファイルからすべての ANSI エスケープ シーケンスを取り除きます。

デフォルト： 間違い

必須：いいえ。

導入: 3.0

環境
フォーム内のキーと値のペアのリスト KEY="val",KEY2="val2" に配置されます
スーパーバイザー プロセスの環境 (結果として、そのすべての子プロセスの環境)
環境)。 このオプションには値を含めることができます %(ここ)sに展開されます。
Supervisord 設定ファイルが見つかったディレクトリ。 含む値
英数字以外の文字は引用符で囲む必要があります (例: KEY="val:123",KEY2="val,456").
それ以外の場合、値を引用することはオプションですが、推奨されます。 パーセントをエスケープするには
文字は、単純に XNUMX つ使用します。 （例えば URI="/first%%20name") 注意 そのサブプロセスは
起動に使用されたシェルの環境変数を継承する スーパーバイザー を除いて
ここおよびプログラムの 環境 オプション。 見る
サブプロセス環境。

デフォルト: 値なし

必須：いいえ。

導入: 3.0

識別子
RPC インターフェイスで使用される、このスーパーバイザ プロセスの識別子文字列。

デフォルト: スーパーバイザー

必須：いいえ。

導入: 3.0

[監修] セクション 例
[監修]
ログファイル = /tmp/supervisord.log
logfile_maxbytes = 50MB
logfile_backups=10
ログレベル = 情報
pidfile = /tmp/supervisord.pid
のだえもん = false
最小値 = 1024
minproc = 200
umask = 022
ユーザー = クリスム
識別子 = スーパーバイザ
ディレクトリ = / tmpに
nocleanup = true
childlogdir = / tmpに
ストリップアンシ = false
環境 = KEY1="値 1"、KEY2="値 2"

[スーパーバイザーctl] セクション 設定
構成ファイルには、 スーパーバイザーctl インタラクティブシェル
プログラム。 これらのオプションを以下に示します。

[スーパーバイザーctl] セクション 価値観
サーバーURL
Supervisord サーバーへのアクセスに使用する URL。
http://localhost：9001. UNIX ドメイン ソケットの場合は、次を使用します。
unix:///absolute/path/to/file.sock.

デフォルト: http://localhost：9001

必須：いいえ。

導入: 3.0

ユーザ名
認証で使用するために Supervisord サーバーに渡すユーザー名。 これは
と同じである ユーザ名 ポートまたは UNIX の Supervisord サーバー構成から
アクセスしようとしているドメインソケット。

デフォルト: ユーザー名なし

必須：いいえ。

導入: 3.0

password
認証に使用するために Supervisord サーバーに渡すパスワード。 これは
のクリアテキスト バージョンである password の Supervisord サーバー構成から
アクセスしようとしているポートまたは UNIX ドメイン ソケット。 この値は次のように渡すことはできません
SHA ハッシュ。 このファイルで指定されている他のパスワードとは異なり、
クリアテキスト。

デフォルト：パスワードなし

必須：いいえ。

導入: 3.0

プロンプト
Supervisorctl プロンプトとして使用される文字列。

デフォルト: スーパーバイザー

必須：いいえ。

導入: 3.0

履歴ファイル
として使用するパス 読み込まれた行 永続履歴ファイル。 この機能を有効にすると、
パスを選択すると、supervisorctl コマンドがファイルに保持され、次を使用できます。
最後の Supervisorctl で実行したコマンドを呼び出すための readline (例: 上向き矢印)
セッション。

デフォルト： ファイルがない

必須：いいえ。

導入：3.0a5

[スーパーバイザーctl] セクション 例
[スーパーバイザーctl]
サーバーURL = unix:///tmp/supervisor.sock
ユーザー名 = クリス
パスワード = 123
プロンプト = mysupervisor

[プログラム:x] セクション 設定
構成ファイルには XNUMX つ以上のファイルが含まれている必要があります プログラム 監視対象のセクション
どのプログラムを開始して制御する必要があるかを知るため。 ヘッダー値は複合値です。
これは、「プログラム」という単語の直後にコロンが続き、その後にプログラム名が続きます。 ヘッダー
の値 [プログラム:foo] 「foo」という名前のプログラムを記述します。 名前が使われています
この結果として作成されるプロセスを制御するクライアント アプリケーション内
構成。 作成エラーです。 プログラム 名前のないセクション。 の
name には、コロン文字またはブラケット文字を含めることはできません。 名前の値は
の値として使用されます。 %(プログラム名)s 他の値内での文字列式の展開
指定された場所。

注:
A [プログラム:x] セクションは、実際にはスーパーバイザーにとって「同種のプロセスグループ」を表します
（3.0現在）。 グループのメンバーは、 numprocs
と プロセス名 構成のパラメーター。 デフォルトでは、numprocs と
process_name はデフォルトから変更されずに残され、グループは
[プログラム:x] 名前が付けられます x という名前の単一のプロセスがあります x 初期化。 この
古いスーパーバイザ リリースとの後方互換性をわずかに提供します。
プログラム セクションを同種のプロセス グループ定義として扱わないでください。

しかし、たとえば、 [プログラム:foo] のセクション numprocs の3とa
プロセス名 の表現 %(プログラム名)s_%(プロセス番号)02d、「foo」グループは
という名前の XNUMX つのプロセスが含まれています。 foo_00, foo_01, foo_02。これにより、次のことが可能になります。
単一のプロセスを使用して、多くの非常に類似したプロセスを開始する [プログラム:x] セクション。 全て
ログファイル名、すべての環境文字列、およびプログラムのコマンドにも含めることができます
同様の Python 文字列式。それぞれにわずかに異なるパラメーターを渡します。
プロセス。

[プログラム:x] セクション 価値観
command
このプログラムの開始時に実行されるコマンド。 コマンドは次のいずれかです。
絶対（例 /path/to/プログラム名）または相対（例 番組名）。 もしそれが
相対、監督者の環境 $ PATH 実行可能ファイルが検索されます。
プログラムは引数を受け入れることができます。 /パス/へ/プログラム foo バー. コマンドラインは使用できます
二重引用符で引数をグループ化し、その中にスペースを入れてプログラムに渡します。
/パス/へ/プログラム/名前 -p 「foo バー". の値に注意してください。 command Python を含む場合があります
文字列式、例えば /path/to/プログラム名 --port=80%(プロセス番号)02d 拡大するかもしれません
〜へ /path/to/プログラム名 -ポート= 8000 実行時に。 文字列式が評価される
キーを含む辞書に対して グループ名, ホストノード名, プロセス番号,
プログラム名, こちら (supervisord 設定ファイルのディレクトリ)、およびすべて
接頭辞が付いた Supervisord の環境変数 環境_. 制御されたプログラムは
スーパーバイザーはデーモン化の責任があると想定しているため、それ自体はデーモンではありません。
サブプロセス (nondaemonizing_of_subprocesses を参照)。

デフォルト: デフォルトなし。

必須：はい。

導入: 3.0

プロセス名
このスーパーバイザ プロセス名を構成するために使用される Python 文字列式
処理する。 変更しない限り、通常、これを設定することについて心配する必要はありません。
numprocs. 文字列式は、以下を含む辞書に対して評価されます。
グループ名, ホストノード名, プロセス番号, プログラム名, こちら (のディレクトリ
Supervisord 構成ファイル)。

デフォルト: %(プログラム名)s

必須：いいえ。

導入: 3.0

numprocs
Supervisor は、numprocs で指定された数のこのプログラムのインスタンスを開始します。 ノート
numprocs > 1 の場合、 プロセス名 式には含める必要があります %(プロセス番号)s （または、
を含むその他の有効な Python 文字列式 プロセス番号） その中で。

デフォルト: 1

必須：いいえ。

導入: 3.0

numprocs_start
数値を計算するために使用される整数オフセット。 numprocs 開始する。

デフォルト: 0

必須：いいえ。

導入: 3.0

優先順位
開始およびシャットダウンの順序におけるプログラムの相対的な優先度。 低い
優先度は、起動時に最初に起動し、最後にシャットダウンするプログラムを示します。
集約コマンドは、さまざまなクライアントで使用されます (「すべて開始」/「すべて停止」など)。 より高い
優先順位は、最後に開始し、最初にシャットダウンするプログラムを示します。

デフォルト: 999

必須：いいえ。

導入: 3.0

自動スタート
true の場合、このプログラムは、supervisord の開始時に自動的に開始されます。

デフォルト： NS

必須：いいえ。

導入: 3.0

開始秒
起動後、プログラムが実行を継続するために必要な合計秒数
開始が成功したと見なす (プロセスを 起動 への状態
ランニング 州）。 に設定 0 プログラムを実行し続ける必要がないことを示す
特定の時間。

注:
プロセスが「予想される」終了コードで終了した場合でも ( 終了コード）、 開始
プロセスがより早く終了した場合でも、失敗と見なされます。 開始秒.

デフォルト: 1

必須：いいえ。

導入: 3.0

開始再試行
一連の失敗試行の回数。 スーパーバイザー しようとすると許可されます
あきらめてプロセスを実行に移す前にプログラムを開始する FATAL 州。 見る
説明のための process_states FATAL でのみ停止させることができます。

デフォルト: 3

必須：いいえ。

導入: 3.0

自動再起動
かどうかを指定します スーパーバイザー プロセスが終了した場合、プロセスを自動的に再起動する必要があります
会場は ランニング 州。 のXNUMXつである可能性があります false, 予期しないまたは true。 場合 false、 プロセス
自動再起動されません。 もしも 予期しない、プロセスは再起動されます
プログラムは、これに関連付けられた終了コードのいずれでもない終了コードで終了します
プロセスの構成 (参照 終了コード） もし true、プロセスは無条件になります
終了コードに関係なく、終了時に再起動されます。

注:
自動再起動 かどうかを制御します スーパーバイザー プログラムが終了した場合、プログラムを自動再起動します
正常に起動した後 (プロセスは ランニング 状態）。

スーパーバイザー プロセスの起動時に異なる再起動メカニズムがあります
(プロセスは 起動 州）。 プロセス起動中のリトライは
によって制御されます 開始秒 と 開始再試行.

デフォルト: 予想外

必須：いいえ。

導入: 3.0

終了コード
で使用されるこのプログラムの「予想される」終了コードのリスト 自動再起動。 もし
自動再起動 パラメータは 予期しない、およびプロセスはそれ以外の方法で終了します
スーパーバイザ停止要求の結果として、 スーパーバイザー その場合、プロセスを再起動します
このリストで定義されていない終了コードで終了します。

デフォルト: 0,2

必須：いいえ。

導入: 3.0

停止信号
停止が要求されたときにプログラムを強制終了するために使用されるシグナル。 これは、TERM、
HUP、INT、QUIT、KILL、USR1、または USR2。

デフォルト： 学期

必須：いいえ。

導入: 3.0

stopwaitsec
OS が SIGCHILD を返すのを待機する秒数 スーパーバイザー 後に
プログラムに停止信号が送信されました。 この秒数が経過する前に
スーパーバイザー プロセスから SIGCHILD を受け取り、 スーパーバイザー それを殺そうとします
最後の SIGKILL で。

デフォルト: 10

必須：いいえ。

導入: 3.0

ストップアスグループ
true の場合、フラグにより​​、スーパーバイザーは停止シグナルをプロセス グループ全体に送信します。
そして意味する キラスグループ 本当です。 これは、デバッグ中の Flask などのプログラムに役立ちます。
モードでは、停止信号が子に伝搬されず、孤立したままになります。

デフォルト： 間違い

必須：いいえ。

導入：3.0b1

キラスグループ
true の場合、SIGKILL をプログラムに送信して終了する場合、そのプログラムに送信します。
代わりにプロセス グループ全体を処理し、その子も同様に処理します。
を使用する Python プログラム マルチプロセッシング.

デフォルト： 間違い

必須：いいえ。

導入：3.0a11

user
指示する スーパーバイザー この UNIX ユーザー アカウントを、
プログラム。 ユーザーを切り替えることができるのは、 スーパーバイザー root ユーザーとして実行されます。 もしも
スーパーバイザー 指定したユーザーに切り替えることができない場合、プログラムは開始されません。

注:
ユーザーは次を使用して変更されます setuid それだけ。 これはログイン シェルを起動せず、
のような環境変数を変更しません USER or ホーム。 見る
詳細については、subprocess_environment を参照してください。

デフォルト: ユーザーを切り替えないでください

必須：いいえ。

導入: 3.0

リダイレクト_stderr
true の場合、プロセスの stderr 出力が に送り返されます。 スーパーバイザー その標準出力で
ファイル記述子 (UNIX シェル用語では、これは実行に相当します。 /プログラム
2>＆1).

注:
設定しないでください redirect_stderr=true で [イベントリスナー:x] セクション。 イベントリスナー
つかいます (Linuxで言うところのstdout） と stdin と通信する スーパーバイザー。 場合 stderr リダイレクトされ、
からの出力 stderr eventlistener プロトコルに干渉します。

デフォルト： 間違い

必須：いいえ。

導入: 3.0、2.0 を置き換えます log_stdout と log_stderr

stdout_logfile
プロセスの stdout 出力をこのファイルに入れます (また、redirect_stderr が true の場合は、
このファイルの stderr 出力)。 もしも stdout_logfile 設定されていないか、設定されています AUTO、監督者
ファイルの場所を自動的に選択します。 これがに設定されている場合 NONEを、監督者の意志
ログファイルを作成しません。 AUTO ログ ファイルとそのバックアップは、次の場合に削除されます。 スーパーバイザー
再起動します。 の stdout_logfile 値には Python 文字列式を含めることができます。
キーを含む辞書に対して評価される グループ名, ホストノード名,
プロセス番号, プログラム名, こちら (supervisord 設定ファイルのディレクトリ)。

注:
XNUMX つのプロセスが XNUMX つのログ ファイルを共有することはできません (stdout_logfile)
回転時（stdout_logfile_maxbytes） 有効になっています。 これにより、ファイル
破損しています。

デフォルト: AUTO

必須：いいえ。

導入: 3.0、2.0 を置き換えます ログファイル

stdout_logfile_maxbytes
によって消費される可能性のある最大バイト数 stdout_logfile 回転する前に
(「KB」、「MB」、「GB」などの接尾辞乗数を値に使用できます)。 これを設定
ログ サイズが無制限であることを示すには、値を 0 に設定します。

デフォルト：50MB

必須：いいえ。

導入: 3.0、2.0 を置き換えます logfile_maxbytes

stdout_logfile_backups
数 stdout_logfile プロセスの stdout ログから生成された、保持するバックアップ
ファイルのローテーション。 0 に設定すると、バックアップは保持されません。

デフォルト: 10

必須：いいえ。

導入: 3.0、2.0 を置き換えます ログファイルのバックアップ

stdout_capture_maxbytes
プロセスが「stdout キャプチャ モード」の場合にキャプチャ FIFO に書き込まれる最大バイト数
(capture_mode を参照)。 整数でなければなりません ("KB"、"MB"、"GB" などの接尾辞の乗数
値で使用できます)。 この値が 0 の場合、プロセス キャプチャ モードはオフになります。

デフォルト: 0

必須：いいえ。

導入: 3.0、2.0 を置き換えます ログファイルのバックアップ

stdout_events_enabled
true の場合、プロセスがその
stdout ファイル記述子。 イベントは、ファイル記述子がそうでない場合にのみ発行されます
データが受信された時点でキャプチャ モード (capture_mode を参照)。

デフォルト: 0

必須：いいえ。

導入：3.0a7

stderr_logfile
プロセスの stderr 出力をこのファイルに入れます。 リダイレクト_stderr 本当です。 受け入れます
と同じ値の型 stdout_logfile 同じ Python 文字列式が含まれる場合があります。

注:
XNUMX つのプロセスが XNUMX つのログ ファイルを共有することはできません (stderr_logfile)
回転時（stderr_logfile_maxbytes） 有効になっています。 これにより、ファイル
破損しています。

デフォルト: AUTO

必須：いいえ。

導入: 3.0

stderr_logfile_maxbytes
のログファイル ローテーション前の最大バイト数 stderr_logfile. 受け入れます
と同じ値の型 stdout_logfile_maxbytes.

デフォルト：50MB

必須：いいえ。

導入: 3.0

stderr_logfile_backups
プロセス stderr ログ ファイルのローテーションから生じる、保持するバックアップの数。
0 に設定すると、バックアップは保持されません。

デフォルト: 10

必須：いいえ。

導入: 3.0

stderr_capture_maxbytes
プロセスが「stderr キャプチャ モード」の場合にキャプチャ FIFO に書き込まれる最大バイト数
(capture_mode を参照)。 整数でなければなりません ("KB"、"MB"、"GB" などの接尾辞の乗数
値で使用できます)。 この値が 0 の場合、プロセス キャプチャ モードはオフになります。

デフォルト: 0

必須：いいえ。

導入: 3.0

stderr_events_enabled
true の場合、プロセスがその
stderr ファイル記述子。 イベントは、ファイル記述子がそうでない場合にのみ発行されます
データが受信された時点でキャプチャ モード (capture_mode を参照)。

デフォルト： 間違い

必須：いいえ。

導入：3.0a7

環境
フォーム内のキーと値のペアのリスト KEY="val",KEY2="val2" に配置されます
子プロセスの環境。 環境文字列には Python 文字列が含まれる場合があります
を含む辞書に対して評価される式 グループ名,
ホストノード名, プロセス番号, プログラム名, こちら (supervisord のディレクトリ
構成ファイル)。 英数字以外の文字を含む値は引用符で囲む必要があります (例:
KEY="val:123",KEY2="val,456"）。 それ以外の場合、値の引用はオプションですが、
お勧めします。 注意 サブプロセスがの環境変数を継承すること
ここでオーバーライドされたものを除いて、シェルは「supervisord」を開始するために使用されます。 見る
サブプロセス環境。

デフォルト: 余分な環境はありません

必須：いいえ。

導入: 3.0

ディレクトリにジョブを開始します。
ディレクトリを表すファイルパス スーパーバイザー 一時的に chdir する必要があります
子供を処刑する前に。

デフォルト: chdir なし (スーパーバイザーの継承)

必須：いいえ。

導入: 3.0

umask
プロセスの umask を表す 002 進数 (例: 022、XNUMX)。

デフォルト: 特別な umask なし (スーパーバイザーの継承)

必須：いいえ。

導入: 3.0

サーバーURL
サブプロセス プロセスに環境で渡される URL SUPERVISOR_SERVER_URL
（参照してください Supervisor.childutils) サブプロセスが簡単に通信できるようにする
内部 HTTP サーバー。 提供される場合、それは同じ構文と構造を持つべきです
[スーパーバイザーctl] 同名のセクションオプション。 これが AUTO に設定されているか、設定されていない場合、
スーパーバイザーは自動的にサーバー URL を作成し、サーバーを優先します。
これは、インターネット ソケットでリッスンするものよりも UNIX ドメイン ソケットでリッスンします。

デフォルト：自動

必須：いいえ。

導入: 3.0

[プログラム:x] セクション 例
【プログラム：ねこ】
コマンド=/ bin / cat
プロセス名=%(プログラム名)s
numprocs=1
ディレクトリ=/ tmpに
umask=022
優先度= 999
自動開始= true
自動再起動=予期しない
開始秒 = 10
開始試行回数=3
終了コード=0,2
停止信号=TERM
停止待機秒=10
stopasgroup=false
killasgroup=false
ユーザー=クリスム
redirect_stderr=false
stdout_logfile=/a/パス
stdout_logfile_maxbytes=1MB
stdout_logfile_backups=10
stdout_capture_maxbytes=1MB
stdout_events_enabled=false
stderr_logfile=/a/パス
stderr_logfile_maxbytes=1MB
stderr_logfile_backups=10
stderr_capture_maxbytes=1MB
stderr_events_enabled=false
環境=A="1",B="2"
サーバーURL=自動

[含む] セクション 設定
この 監視者.conf ファイルには、という名前のセクションが含まれる場合があります [含む]. 構成が
ファイルには [含む] セクションには、「files」という名前の単一のキーが含まれている必要があります。 の
このキーの値は、他の構成ファイルを指定します。
構成。

[含む] セクション 価値観
ファイル
スペースで区切られた一連のファイル グロブ。 各ファイル グロブは、絶対または相対の場合があります。
ファイル グロブが相対である場合は、
それを含む設定ファイル。 「グロブ」は、
Unix シェルで使用される規則に従って指定されたパターン。 チルダ展開なし
完了しましたが、 *, ?、および で表される文字範囲 [] 正しく一致します。
インクルード ファイルからの再帰的なインクルードはサポートされていません。

デフォルト: デフォルトなし (必須)

必須：はい。

導入: 3.0

[含む] セクション 例
[含む]
ファイル = /an/absolute/filename.conf /an/absolute/*.conf foo.conf config??.conf

[グループ:×] セクション 設定
「同種の」プロセス グループ (別名「プログラム」) を XNUMX つのグループにまとめると便利なことがよくあります。
スーパーバイザーからユニットとして制御できるように、「異種」プロセス グループ
さまざまなコントローラー インターフェイス。

プログラムを XNUMX つの単位として扱うことができるようにグループに配置するには、次のように定義します。 [グループ:×]
構成ファイルで。 グループ ヘッダー値は複合です。 という言葉です
"group" の直後にコロンが続き、その後にグループ名が続きます。 のヘッダー値 [グループ:ふー]
「foo」という名前のグループについて説明します。 名前はクライアント アプリケーション内で使用されます
この構成の結果として作成されるプロセスを制御します。 それは
作成エラー グループヘッド 名前のないセクション。 名前に
コロン文字またはブラケット文字。

[グループ:×]、XNUMXつ以上ある必要があります [プログラム:x] あなたの他の場所のセクション
構成ファイルであり、グループはそれらを名前で参照する必要があります。 プログラム の値です。

「同種の」プロセス グループ (プログラム セクションで表される) が
経由の「異種」グループ [グループ:×] セクションの プログラム 行、均質なグループ
プログラム セクションは、実行時にスーパーバイザに存在しないことを意味します。 代わりに、すべて
同種のグループのそれぞれに属するプロセスは、
異種族。 たとえば、次のグループ構成があるとします。

[グループ:ふー]
プログラム=バー、バズ
優先度= 999

上記を考えると、supervisord の起動時に、 バー と バズ 同種のグループは
存在し、その下にあったプロセスは現在、 foo
グループ。

[グループ:×] セクション 価値観
プログラム
プログラム名のコンマ区切りリスト。 リストされているプログラムがメンバーになります
グループの。

デフォルト: デフォルトなし (必須)

必須：はい。

導入: 3.0

優先順位
に類似した優先番号 [プログラム:x] グループに割り当てられたプライオリティ値。

デフォルト: 999

必須：いいえ。

導入: 3.0

[グループ:×] セクション 例
[グループ:ふー]
プログラム=バー、バズ
優先度= 999

[fcgi-プログラム:x] セクション 設定
スーパーバイザーはのグループを管理できます 高速CGI すべてが同じソケットでリッスンするプロセス。
これまで、FastCGI の展開の柔軟性は制限されていました。 完全なプロセスを取得するには
管理、Apache で mod_fastcgi を使用できますが、Apache の
接続ごとに XNUMX つのプロセスまたはスレッドの非効率的な同時実行モデル。 に加えて
より多くの CPU およびメモリ リソースを必要とするため、接続モデルごとのプロセス/スレッドは
遅いリソースによってすぐに飽和状態になり、他のリソースが提供されなくなります。 の
lighttpd や nginx などの新しいイベント駆動型 Web サーバーを利用するために、
組み込みのプロセス マネージャーを含めないでください。cgi-fcgi などのスクリプトを使用する必要がありました。
スポーン-fcgi。 これらは、supervisord などのプロセス マネージャーと組み合わせて使用​​できます。
または daemontools ですが、各 FastCGI 子プロセスが独自のソケットにバインドする必要があります。 の
これの欠点は次のとおりです: 不必要に複雑な Web サーバー構成、見苦しい
再起動し、耐障害性が低下します。 構成するソケットが少ない、Web サーバー
FastCGI プロセスのグループがソケットを共有できる場合、構成ははるかに小さくなります。 共有
ソケットは親プロセスによってバインドされたままであるため、ソケットは正常な再起動を可能にします
子プロセスのいずれかが再起動されている間。 最後に、共有ソケットはさらに
特定のプロセスが失敗した場合、他のプロセスがサービスを継続できるため、フォールト トレラント
インバウンド接続。

統合された FastCGI スポーン サポートにより、Supervisor は両方の長所を提供します。
ソケットを共有する FastCGI プロセスのグループを使用して、フル機能のプロセス管理を実現します。
特定の Web サーバーに縛られることなく。 これは、懸念事項の明確な分離です。
これにより、Web サーバーとプロセス マネージャーがそれぞれのベストを尽くせるようになります。

注:
Supervisor のソケット マネージャは、もともと FastCGI プロセスをサポートするために開発されました。
ただし、FastCGI に限定されません。 他のプロトコルも特別なものなしで使用できます
構成。 ファイル記述子から開いているソケットにアクセスできるプログラム (例:
　 ソケット.fromfd Python では) ソケット マネージャを使用できます。 スーパーバイザーは
最初の子を fork する前に、ソケットを自動的に作成し、バインドし、リッスンします。
グループ。 ソケットは、ファイル記述子番号の各子に渡されます 0 （ゼロ）。
グループ内の最後の子が終了すると、Supervisor はソケットを閉じます。

利用可能なすべてのオプション [プログラム:x] セクションも尊重されます fcgi-プログラム
セクション。

[fcgi-プログラム:x] セクション 価値観
[fcgi-プログラム:x] セクションには単一のキーがあり、 [プログラム:x] セクションにはありません。

ソケット
このプログラムの FastCGI ソケット (TCP または UNIX ドメイン ソケット)。 TCP ソケットの場合、
次の形式を使用します。 tcp://ローカルホスト:9002. UNIX ドメイン ソケットの場合は、次を使用します。
unix:///absolute/path/to/file.sock. 文字列式は、
キー "program_name" と "here" を含む辞書 (ファイルのディレクトリ
Supervisord 構成ファイル)。

デフォルト: デフォルトなし。

必須：はい。

導入: 3.0

ソケット所有者
UNIX ドメイン ソケットの場合、このパラメーターを使用して、ユーザーとグループを指定できます。
FastCGI ソケット。 UNIX ユーザー名 (例: chrism) または UNIX ユーザー名とグループの可能性があります。
コロンで区切ります (例: chrism:wheel)。

デフォルト: fcgi-program に設定されたユーザーとグループを使用します

必須：いいえ。

導入: 3.0

ソケットモード
UNIX ドメイン ソケットの場合、このパラメータを使用して許可モードを指定できます。

デフォルト: 0700

必須：いいえ。

導入: 3.0

相談する [プログラム:x] セクション 設定 他の許容されるキーについては、上記の制約をデルタします
と追加。

[fcgi-プログラム:x] セクション 例
[fcgi-プログラム:fcgiプログラム名]
コマンド=/usr/bin/example.fcgi
ソケット=unix:///var/run/supervisor/%(プログラム名)s.sock
socket_owner=クリスム
ソケットモード=0700
プロセス名=%(プログラム名)s_%(プロセス番号)02d
numprocs=5
ディレクトリ=/ tmpに
umask=022
優先度= 999
自動開始= true
自動再起動=予期しない
開始秒 = 1
開始試行回数=3
終了コード=0,2
停止信号=QUIT
stopasgroup=false
killasgroup=false
停止待機秒=10
ユーザー=クリスム
redirect_stderr=true
stdout_logfile=/a/パス
stdout_logfile_maxbytes=1MB
stdout_logfile_backups=10
stdout_events_enabled=false
stderr_logfile=/a/パス
stderr_logfile_maxbytes=1MB
stderr_logfile_backups=10
stderr_events_enabled=false
環境=A="1",B="2"
サーバーURL=自動

[イベントリスナー:x] セクション 設定
Supervisor により、特殊な同種プロセス グループ (「イベント リスナー プール」) を
構成ファイル内で定義されています。 これらのプールには、次のことを意図したプロセスが含まれています。
スーパーバイザのイベント システムからのイベント通知を受信して​​応答します。 のイベントを見る
イベントがどのように機能するか、および次のように宣言できるプログラムを実装する方法の説明
イベントリスナー。

利用可能なすべてのオプションに注意してください [プログラム:x] セクションは eventlistener によって尊重されます
セクション 以下は除く for stdout_capture_maxbytes と stderr_capture_maxbytes (イベントリスナー
プロセス通信イベントを発行できません。capture_mode を参照してください)。

[イベントリスナー:x] セクション 価値観
[イベントリスナー:x] セクションにはいくつかのキーがあります [プログラム:x] セクションにはありません。

バッファサイズ
イベント リスナー プールのイベント キューのバッファー サイズ。 リスナー プールのイベント バッファ
オーバーフローします (イベント リスナー プールがすべての
送信されたイベント)、バッファー内の最も古いイベントが破棄されます。

イベント
このリスナーが「関心のある」イベント タイプ名のコンマ区切りリスト
の通知を受信します (有効なイベント タイプ名のリストについては、event_types を参照してください)。

結果ハンドラー
A pkg_resources エントリ ポイント string Python callable に解決されます。 デフォルト
値は Supervisor.dispatchers:default_handler. 代替結果の指定
ハンドラーを作成する必要があるのは非常にまれなことであり、その結果、作成方法は次のようになります。
文書化されていません。

相談する [プログラム:x] セクション 設定 他の許容されるキーについては、上記の制約をデルタします
と追加。

[イベントリスナー:x] セクション 例
[イベントリスナー:イベントリスナー名]
command=/bin/イベントリスナー
プロセス名=%(プログラム名)s_%(プロセス番号)02d
numprocs=5
イベント=PROCESS_STATE
バッファサイズ=10
ディレクトリ=/ tmpに
umask=022
優先度=-1
自動開始= true
自動再起動=予期しない
開始秒 = 1
開始試行回数=3
終了コード=0,2
停止信号=QUIT
停止待機秒=10
stopasgroup=false
killasgroup=false
ユーザー=クリスム
redirect_stderr=false
stdout_logfile=/a/パス
stdout_logfile_maxbytes=1MB
stdout_logfile_backups=10
stdout_events_enabled=false
stderr_logfile=/a/パス
stderr_logfile_maxbytes=1MB
stderr_logfile_backups=10
stderr_events_enabled=false
環境=A="1",B="2"
サーバーURL=自動

[rpcインターフェース:x] セクション 設定
追加 rpcインターフェース:x 構成ファイルの設定は、次の人にのみ役立ちます
追加のカスタム動作でスーパーバイザーを拡張したい。

サンプル構成ファイルには、次の名前のセクションがあります。 [rpcインターフェース:スーパーバイザー].
デフォルトでは、次のようになります。

[rpcインターフェース:スーパーバイザー]
スーパーバイザー.rpcinterface_factory = スーパーバイザー.rpcinterface:make_main_rpcinterface

この [rpcインターフェース:スーパーバイザー] しなければなりません 標準の構成にとどまる
スーパーバイザーが適切に動作するようにセットアップします。 スーパーバイザーに何もしてほしくない場合は、
すぐに使えるわけではありません。このタイプの
のセクションから無料でダウンロードできます。

ただし、スーパーバイザーをカスタマイズするために rpc インターフェースの名前空間を追加したい場合は、
追加するかもしれません [rpcinterface:foo] ここで、「foo」は名前空間を表します
インターフェイス (Web ルートから)、およびによって名前が付けられた値 Supervisor.rpcinterface_factory
単一を受け入れる関数シグネチャを持つ必要があるファクトリ呼び出し可能です
位置引数 スーパーバイザー および実行に必要な数のキーワード引数
構成。 内で定義された追加のキーと値のペア [rpcインターフェース:x] セクションは
ファクトリにキーワード引数として渡されます。

で作成されたファクトリ関数の例を次に示します。 __init__。py Python のファイル
パッケージ 私のパッケージ.

my.package.rpcinterface から AnotherRPCInterface をインポート

def make_another_rpcinterface (supervisord、**構成):
再試行 = int(config.get('再試行', 0))
another_rpc_interface = AnotherRPCInterface(supervisord、再試行)
another_rpc_interface を返す

そして、それを構成するための構成ファイルのセクション。

[rpcinterface:別の]
Supervisor.rpcinterface_factory = my.package:make_another_rpcinterface
再試行 = 1

[rpcインターフェース:x] セクション 価値観
Supervisor.rpcinterface_factory
pkg_resources RPC インターフェイスのファクトリ関数への「エントリ ポイント」ドット名。

デフォルト：N / A

必須：いいえ。

導入: 3.0

[rpcインターフェース:x] セクション 例
[rpcinterface:別の]
Supervisor.rpcinterface_factory = my.package:make_another_rpcinterface
再試行 = 1

用語解説
デーモンツール
A プロセス コントロール 　 by DJ バーンスタイン.

打ち上げ
A プロセス コントロール 　 中古 by Apple Mac OS X ではプロセス 1 として。

それを実行します A プロセス コントロール 　.

スーパーランス
にプラグインするさまざまなイベント リスナー実装を提供するパッケージ
プロセス メモリの使用状況とクラッシュ ステータスの監視に役立つスーパーバイザ:
http://pypi.python.org/pypi/superlance.

umask の略語 user mask: 現在のプロセスのファイル モード作成マスクを設定します。
見る http://en.wikipedia.org/wiki/Umask.

onworks.net サービスを使用してオンラインで echo_supervisord_conf を使用する