Node.js & Kubernetes Graceful Shutdown
k8s-graceful-shutdown:该库提供了使用 Kubernetes
实现 Graceful Shutdown
(优雅退出) Node.js App 的资源。
问题描述
在 kubernetes 中运行微服务时。我们需要处理 kubernetes 发出的终止信号。这样做的正确方法是:
- 监听
SIGINT
,SIGTERM
- 收到信号后,将服务置于不健康模式(
/health
路由应返回状态码4xx
,5xx
) - 在关闭之前添加宽限期,以允许 kubernetes 将您的应用程序从负载均衡器中移除
- 关闭服务器和所有打开的连接
- 关闭
该库使上述过程变得容易。只需注册您的 graceful shutdown hook(优雅退出的钩子)并添加宽限期即可。
请注意,您的宽限期必须小于 kubernetes 中定义的宽限期!
使用 Express 框架的示例
例如,使用Express框架:
import { Response, Request } from 'express'
import express from 'express'
import { addGracefulShutdownHook, getHealthHandler, shutdown } from '@neurocode.io/k8s-graceful-shutdown'
const app = express()
app.disable('x-powered-by')
const port = process.env.PORT || 3000
const server = app.listen(port, () => console.log(`App is running on http://localhost:${port}`))
// 修补 NodeJS 服务器关闭功能,使其具有正确的关闭功能,因为您可能期望为您关闭 keep-alive connections(保持活动的连接)!
// 在这里阅读更多信息 https://github.com/nodejs/node/issues/2642
server.close = shutdown(server)
const healthy = (req: Request, res: Response) => {
res.send('everything is great')
}
const notHealthy = (req: Request, res: Response) => {
res.status(503).send('oh no, something bad happened!')
}
const healthTest = async () => {
// 这是可选的
// 你可以用它来进行健康检查
return true
}
const healthCheck = getHealthHandler({ healthy, notHealthy, test: healthTest })
app.get('/health', healthCheck)
const sleep = (time: number) => new Promise((resolve) => setTimeout(resolve, time))
const asyncOperation = async () => sleep(3000).then(() => console.log('Async op done'))
const closeServers = async () => {
await asyncOperation() // 可以是任何异步操作,例如 mongo db 关闭,或发送 slack 消息;)
server.close()
}
const gracePeriodSec = 5*1000
addGracefulShutdownHook(gracePeriodSec, closeServers)
server.addListener('close', () => console.log('shutdown after graceful period'))
上面所示的这个简单的应用程序,添加了一个
5
秒的优雅关闭周期,在此之后,钩子(在关闭功能的帮助下负责关闭服务器)被触发。在发送SIGINT
或SIGTERM
信号时,用户可以看到5
秒的宽限期,之后发生了3
秒的等待异步操作,然后才会显示“shutdown after graceful period”
的消息,表示关闭服务器。该应用程序还展示了
“getHealthHandler”
的功能。在请求localhost:3000/health
时,healthTest
将返回true
,并显示'everything is great'
消息,表明 health 检查为正常。用户可以将healthTest
改为返回false
,然后看到消息变为'oh no, something bad happened!'
这表明了一种不健康的状态。
如果您使用 Koa
框架,请查看 demos/
文件夹。 我们有一个 Koa
示例,其功能与上述应用类似。Koa
应用程序使用具有 health
和 notHealthy
处理程序的 fn(ctx)
支持的 getHealthContextHandler
,而不是将 health
和 notHealthy
处理程序作为 fn(req, res)
的 getHealthHandler
。
它是如何工作的?
正常关闭工作流程的工作方式示例:
Kubernetes
向Pod
发送SIGTERM
信号。手动缩小Pod
或在滚动部署期间自动缩小Pod
时会发生这种情况- 该库接收
SIGTERM
信号并调用您的notHealthy
处理程序。您的处理程序应返回400
或500
的http
状态代码(抛出错误?),这表明该pod
不再接收任何流量。注意此步骤是可选的(请检查下一步) - 库等待指定的 grace time 以启动应用程序的关闭。宽限时间应在
5
到20
秒之间。kubernetes
端点控制器需要宽限时间才能从有效端点列表中删除Pod
,进而从服务中删除Pod
(从iptables
所有节点中获取pod
的ip
地址)。 Kubernetes
从Service
中删除Pod
- 该库调用您所有已注册的关闭 hook
- 在配置的宽限期之后,应用程序将使用我们的关机机制正确地关机,你可能期望默认工作,但在
NodeJS http server
,express
和Koa
不是
互相交流学习
我的微信:
最新文章
- ABP文档 - SignalR 集成
- .NET Core扩展IServiceCollection自动注册服务
- apache配置文件参数优化
- 【UEditor】 UEditor整合项目上传资源到阿里云服务器
- 表单中Readonly和Disabled的区别(转载)
- linux 查看服务器性能常用命令
- Java类的执行顺序
- c++分割字符串(类似于boost::split)
- ArcGisServer根据最大最小坐标换算瓦片行列号(转载)
- HDOJ2005-第几天?
- Qt中事件分发源代码剖析
- 制作OpenStack使用的windows镜像
- 不二之选_iTOP-4418开发板研发之旅_缩短开发时间
- Vue-admin工作整理(十七):Mock模拟Ajax请求
- SQL Server 第四章 存储过程(Procedure),触发器(Trigger),数据完整性(Data Integrity)
- AWS、Azure和Google的云容器注册表有什么区别?
- 中国大学mooc直播回放看这里哦http://www.icourse163.org/forum/1001974001/topic-1003372881.htm?sortType=1&;pageIndex=1
- c# C#获取屏幕鼠标坐标点颜色
- FastAdmin 开发第三天:认识目录
- django-媒体文件,图片存储
热门文章
- python + pytest 基本使用方法(Fixture)
- 记录一个SQL语句 case select 1
- SQL注入之二次,加解密,DNS等注入
- decimal和float的区别
- mysql 占用90%多的CPU,解决思路
- Spring WebFlow 远程代码执行漏洞(CVE-2017-4971)
- phpMyAdmin 4.0.x—4.6.2 远程代码执行漏洞(CVE-2016-5734)
- JBoss JMXInvokerServlet 反序列化漏洞
- 微信JSSDK的使用步骤
- 为MySQL的source命令导入SQL文件配置参数