【Express.js】健康检查

健康检查

许多时候，我们需要对应用进行监控，来获取他的详细状态，这节介绍几个在 express 中进行健康检查的方案。

亲自手写

亲自创建一些路由，根据情况返回应用的相关信息，不过自己写比较麻烦，除非有特别的需求，一般我们就用第三方的解决方案。

express-actuator

express-actuator.js 是一个现成的用于 express 的健康检查中间件：

npm install express-acutator --save
1

配置express-actuator：
在你的主应用中引入 actuator 即可：

const actuator = require('express-actuator');

const app = express();

app.use(actuator({
  basePath: '/actuator',
  infoGitMode: 'simple',
  // infoBuildOptions: null, // extra information you want to expose in the build object. Requires an object.
  // infoDateFormat: null, // by default, git.commit.time will show as is defined in git.properties. If infoDateFormat is defined, moment will format git.commit.time. See https://momentjs.com/docs/#/displaying/format/.
  customEndpoints: [] // array of custom endpoints
}));
1
2
3
4
5
6
7
8
9
10
11

其中有一些配置选项：

• basePath： actuator的基路由，如果不设置，则其所有路由（“/info”, “health”, “metrics”）将挂载在 app 的路由上
• infoGitMode： 暴露的Git信息, ‘simple’ 或者 ‘full’
• infoBuildOptions： 额外暴露的信息
• infoDateFormat： Git提交信息的时间格式
• customEndpoints： 自定义端点（初始仅提供了"/info", “health”, “metrics”）

访问端点：

• “/info”：会包含你的项目信息（从 package.json 读取）和Git信息，如：

{
    "build": {
        "description": "This is my new app",
        "name": "MyApp",
        "version": "1.0.0"
    },
    "git": {
        "branch": "master",
        "commit": {
            "id": "329a314",
            "time": "2016-11-18 08:16:39-0500"
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

• “/metrics”：express 应用的健康详情，如：

{
    "mem": {
        "rss": 39350272,
        "heapTotal": 11038720,
        "heapUsed": 8889952,
        "external": 892742,
        "arrayBuffers": 32982
    },
    "uptime": 58.3234052
}
1
2
3
4
5
6
7
8
9
10

• “/health”：当下的健康状况，如：

{
    "status": "UP"
}
1
2
3

lightship

lightship.js 也是一个不错的健康检查工具，并且可以与 Kubernetes 集成：

npm install lightship --save
1

不过与 express-actuator 不同的是，express-actuator是挂载在 express 应用上的中间件，而 lightship 是自己单独开辟一个 http 服务器（即额外占用一个端口）：

async function start() {
  const config = require('./config').get();
  const init = require('./init');
  await init();
  const express = require('express');
  const jsTextChart = require('js-text-chart');
  const logger = require('./utils/logger');
  const server = require('./utils/server');
  const Lightship = await import('lightship');
  const createLightship = Lightship.createLightship;
  
  const app = require('./app');
  const lightship = await createLightship({
    detectKubernetes: false,
    port: 8081,
    // gracefulShutdownTimeout, // 优雅停机时间
    // gracefulShutdownTimeout, // 优雅停机延迟
    // shutdownHandlerTimeout, // 停机Handler时间
    // signals, // An a array of [signal events]{@link https://nodejs.org/api/process.html#process_signal_events}. Default: [SIGTERM].
    // terminate // Default: `() => { process.exit(1) };`
  });
  
  server.on('request', app);
  server.listen(config.app.port, config.app.host, async() => {
    let host = server.address().address;
    let port = server.address().port;
  
    let str = config.app.name;
    let mode = [ "close", "far", undefined ];
    let chart = jsTextChart.convert(str, mode[0]);
    console.log(chart);
  
    console.log("Server is ready on http://%s:%s", host, port);

    lightship.registerShutdownHandler(() => {
      lightship.shutdown();
      server.close();
    })
    
    lightship.signalReady();
  });
}

start();
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

其中有一些配置选项：

• detectKubernetes 是否探查 Kubernates
• port lightship服务器端口
• gracefulShutdownTimeout 优雅停机前时间
• gracefulShutdownTimeout 优雅停机延迟时间
• shutdownHandlerTimeout 停机Handler前时间
• signals 标记
• terminate 用于shutdown停机的函数

访问端点：

• “/health”： 健康状况，有如下几种返回：
  • 200 status code, message “SERVER_IS_READY” 服务器就绪
  • 500 status code, message “SERVER_IS_NOT_READY” 服务器正在初始化
  • 500 status code, message “SERVER_IS_SHUTTING_DOWN” 服务器挂了
• “/live”： 还活着吗，有如下几种返回：
  • 200 status code, message “SERVER_IS_NOT_SHUTTING_DOWN”.
  • 500 status code, message “SERVER_IS_SHUTTING_DOWN”.
• “/ready”： 是否就绪，有如下几种返回：
  • 200 status code, message “SERVER_IS_READY”.
  • 500 status code, message “SERVER_IS_NOT_READY”.

Kubernates

Kubernates 提供了两个健康检查服务：liveness 和 readiness，你可以将 express 部署到 Kubernates 容器中。