就緒

原始碼

ready 啟用一個就緒檢查 HTTP 端點。

說明

啟用 ready 後,當所有能夠發出就緒信號的外掛程式都完成時,在 8181 埠上的 HTTP 端點將會回傳 200 OK。如果有些外掛程式尚未就緒,則端點會回傳 503,並且在內容中包含尚未就緒的外掛程式列表。一旦外掛程式發出已就緒的信號,就不會再被查詢。

每個啟用 ready 外掛程式的伺服器區塊,都會讓該伺服器區塊中的外掛程式向在相同埠上運行的 /ready 端點報告就緒狀態。這也表示,即使是具有不同配置(可能在不同的伺服器區塊中)的相同外掛程式,它們的就緒狀態也會以各自就緒狀態的聯集形式報告。

語法

ready [ADDRESS]

ready 可以選擇性地接收一個位址;預設值為 :8181。路徑固定為 /ready。當此伺服器就緒時,就緒端點會回傳 200 回應碼以及文字「OK」。否則會回傳 503,並且回傳尚未就緒的外掛程式列表。

外掛程式

任何想要發出就緒信號的外掛程式,都需要實作 ready.Readiness 介面,實作一個 Ready() bool 方法,當外掛程式就緒時回傳 true,否則回傳 false。

範例

ready 報告 .example.org 伺服器的就緒狀態 (假設 whois 外掛程式也匯出就緒狀態)

. {
    ready
    erratic
}

example.org {
    ready
    whoami
}

在不同的埠上執行 ready

. {
    ready localhost:8091
}