描述
启用 ready 时,端口 8181 上的 HTTP 终结点将在所有能够发出准备就绪信号的插件完成信号发送后返回 200 OK。如果一些插件尚未就绪,终结点将返回 503,并返回一个正文,其中包含尚未就绪的插件列表。一次插件发出就绪信号后,将不再查询它。
启用了 ready 插件的每个服务器块将让该服务器块中的插件在同一端口上运行的 /ready 终结点报告准备就绪。这也意味着配置不同的 同一个 插件(可能在 不同的 服务器块中)将具有准备就绪的联合报告(联合了各自的准备就绪)。
句法
ready [ADDRESS]
ready 可选择使用一个地址;默认值为 :8181
。路径固定为 /ready
。准备就绪终结点在该服务器就绪时返回 200 响应代码和单词“OK”。在其他情况下返回 503 和 尚未就绪的插件列表。
插件
任何希望发出准备就绪信号的插件都需要通过实现方法 Ready() bool
来实现 ready.Readiness
接口,该方法在插件就绪时返回 true,否则返回 false。
示例
ready 报告 .
和 example.org
服务器的准备就绪(假设 whois 插件也导出准备就绪)
. {
ready
erratic
}
example.org {
ready
whoami
}
在不同的端口上运行 ready。
. {
ready localhost:8091
}