本指南提供了创建健康检查URL的简单指导,适用于QuickNode的附加组件。它涵盖了理想的URL路径、认证要求、期望响应格式以及连接到数据库的最佳实践,旨在帮助开发者顺利构建附加组件。
作为创建插件的一部分,QuickNode 需要你提供一种检查你的供应和 RPC 服务健康状况的方法。在本指南中,我们将介绍创建插件健康检查 URL 时应遵循的简单准则。
我们每 10 分钟发送一次健康检查 ping。
虽然不是强制要求,但用于健康检查的典型 URL 是 /healthz
。在 QuickNode,我们也喜欢 /healthcheck
。但是,你可以在我们的市场开发者门户中指定你想要的任何 URL。
你的健康检查 URL 前面不应有任何身份验证。我们希望能够简单地发送一个 GET 请求来查看健康状况。你的健康检查 URL 必须对外开放。
当返回健康检查 URL 响应时,如果你的服务正常,我们要求你返回 200 OK HTTP 响应代码。如果你以其他任何方式响应,而不是 200 OK 响应代码,我们将认为你的服务已降级,并停止允许客户进行新安装的配置。
此外,在你的健康检查响应体中,我们更喜欢但不要求使用如下格式的 JSON:
{ "status": "ok" }
你的健康检查应该理想情况下对你的数据库或基础数据存储执行实际调用。这将使我们能够更好地了解你服务的整体健康和性能。
现在你已经学习了如何正确设置你的健康检查 URL,我们希望你能够更加轻松地构建插件。如需有关市场的更多信息,请访问 QuickNode Marketplace 或查看更多 Marketplace Guides。
最后,如果你对此指南有任何反馈或问题,请 告诉我们。我们期待你的意见!
- 原文链接: quicknode.com/guides/qui...
- 登链社区 AI 助手,为大家转译优秀英文文章,如有翻译不通的地方,还请包涵~
如果觉得我的文章对您有用,请随意打赏。你的支持将鼓励我继续创作!