レディ

説明

レディを有効にすると、ポート8181のHTTPエンドポイントは200 OKを返します。これは、準備信号を送信できるすべてのプラグインがそうしたときに送信されます。一部のプラグインがまだ準備ができていない場合は、エンドポイントはステータス503を返し、未準備のプラグインのリストを含む本文を含みます。プラグインはレディ信号を送信すると、それ以降はクエリされません。

レディプラグインを有効化する各サーバーブロックは、同じサーバーブロック内のプラグインに、同じポートで実行される/readyエンドポイントに準備状況を報告させます。これは、（おそらく異なるサーバーブロック内の）異なる設定を持つ同じプラグインのレディネスが、それらのそれぞれのレディネスの和として報告されることも意味します。

構文

ready [ADDRESS]

レディはオプションであドレスを使用します。デフォルトは:8181です。パスは/readyに固定されています。準備状況のエンドポイントは、サーバーがレディ状態のときに200の応答コードと文字「OK」を返します。それ以外の場合は、503を返し、準備ができていないプラグインのリストを併記します。

プラグイン

プラ​​グインがレディ信号を送信するには、ready.Readinessインターフェースを実装し、プラグインの準備状態がtrueになり、それ以外の場合はfalseを返すReady() boolメソッドを実装する必要があります。

例

レディに.サーバーとexample.orgサーバーの両方の準備状況を報告させます（whoisプラグインも準備状況を出力すると仮定）。

. {
    ready
    erratic
}

example.org {
    ready
    whoami
}

異なるポートでレディを実行します。

. {
    ready localhost:8091
}