【Express.js】健康检查

健康检查

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

亲自手写

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

express-actuator

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

shell 复制代码
npm install express-acutator --save

配置express-actuator:

在你的主应用中引入 actuator 即可:

javascript 复制代码
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
}));

其中有一些配置选项:

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

访问端点:

  • "/info":会包含你的项目信息(从 package.json 读取)和Git信息,如:
json 复制代码
{
    "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"
        }
    }
}
  • "/metrics":express 应用的健康详情,如:
json 复制代码
{
    "mem": {
        "rss": 39350272,
        "heapTotal": 11038720,
        "heapUsed": 8889952,
        "external": 892742,
        "arrayBuffers": 32982
    },
    "uptime": 58.3234052
}
  • "/health":当下的健康状况,如:
json 复制代码
{
    "status": "UP"
}

lightship

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

shell 复制代码
npm install lightship --save

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

javascript 复制代码
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();

其中有一些配置选项:

  • 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 容器中。

相关推荐
一直在学习的小白~几秒前
node_modules 明明写进 .gitignore,却还是被 push/commit 的情况
前端·javascript·vue.js
nightunderblackcat32 分钟前
新手向:从零理解LTP中文文本处理
前端·javascript·easyui
User:你的影子39 分钟前
WPF ItemsControl 绑定
开发语言·前端·javascript
小程序设计1 小时前
【springboot+vue】高校迎新平台管理系统(源码+文档+调试+基础修改+答疑)
vue.js·spring boot·后端
海梨花1 小时前
字节一面 面经(补充版)
jvm·redis·后端·面试·juc
野生程序员y1 小时前
深入解析Spring AOP核心原理
java·后端·spring
波波烤鸭2 小时前
Spring Boot 原理与性能优化实战
spring boot·后端·性能优化
知识分享小能手2 小时前
React学习教程,从入门到精通,React 构造函数(Constructor)完整语法知识点与案例详解(16)
前端·javascript·学习·react.js·架构·前端框架·vue
shellvon2 小时前
从抓包到攻防:解锁API安全设计的秘密
后端·安全
言之。2 小时前
Django REST Framework响应类Response详解
后端·python·django