设置实例自定义健康检查

使用限制

仅支持为自定义运行时环境和使用自定义镜像启动的函数实例设置健康检查功能。

健康检查的行为

实例启动行为

关于探测成功阈值和最大失败次数的设置，请参见使用控制台为函数实例设置健康检查。

单次健康检查行为

健康检查失败后的调度行为

使用控制台为函数实例设置健康检查

本文以选择使用自定义运行时创建方式创建一个运行环境为Node.js 14，请求处理程序类型为处理事件请求的函数为例，介绍如何为函数的实例配置健康检查功能。

步骤一：创建函数

1. 登录函数计算控制台，在左侧导航栏，单击服务及函数。
2. 在顶部菜单栏，选择地域，然后在服务列表页面，单击目标服务。
3. 在函数管理页面，单击创建函数。
4. 在创建函数页面，选择使用自定义运行时创建，按需设置配置项，然后单击创建。
   配置项说明如下，其余配置项保持默认值。

   配置项	说明
   函数名称	自定义函数名称。
   请求处理程序类型	选择处理事件请求处理序类型。
   运行环境	选择Node.js 14。

5. 在函数详情页面，选择函数代码页签，在代码编辑器内编辑函数代码，然后部署代码并执行函数。
   index.js代码示例如下。

   'use strict';
   
   // Constants
   const PORT = 9000;
   const HOST = '0.0.0.0';
   const REQUEST_ID_HEADER = 'x-fc-request-id'
   
   const express = require('express');
   const bodyParser = require('body-parser');
   const app = express();
   
   app.use(bodyParser.urlencoded({ extended: true }));
   app.use(bodyParser.json());
   app.use(bodyParser.raw());
   
   app.get('/readyz', (req, res) => {
     console.log(`receive health check`);
     res.status(200);
     console.log(`i am ready`);
     res.send('i am ready\n');
   });
   
   // invocation
   app.post('/invoke', (req, res) => {
     var rid = req.headers[REQUEST_ID_HEADER]
     console.log(`FC Invoke Start RequestId: ${rid}`)
     res.send('OK');
     console.log(`FC Invoke End RequestId: ${rid}`)
   });
   
   var server = app.listen(PORT, HOST);
   console.log(`Running on http://${HOST}:${PORT}`);
   
   server.timeout = 0; // never timeout
   server.keepAliveTimeout = 0; // keepalive, never timeout

   上述代码中，readyz为定义的健康检查的Handler，用于处理/readyz路径下的HTTP GET请求。完成步骤二的操作后，您可以配置周期性执行此Handler，持续检查实例是否正常。

   当函数计算判定您的函数实例异常时，将尝试将请求调度到其他正常的实例。如果函数计算调度失败，会返回健康检查失败相关的报错信息。

   例如，将上方示例代码的健康检查部分替换为以下示例，将总是返回500错误码。

   app.get('/readyz', (req, res) => {
     console.log(`receive health check`);
     res.status(500);
     console.log(`i am not ready`);
     res.send('i am not ready\n');
   });

   再次执行函数，返回的信息如下。

   {
       "ErrorCode": "FunctionNotStarted",
       "ErrorMessage": "check function health failed with status code: 500 "
   }

步骤二：为函数实例设置健康检查

1. 登录函数计算控制台，在左侧导航栏，单击服务及函数。
2. 在顶部菜单栏，选择地域，然后在服务列表页面，单击目标服务。
3. 在函数管理页面，单击目标函数操作列的配置。
4. 在编辑函数配置页面的HealthCheck 配置区域，按需设置以下配置项，然后单击保存。

   配置项	说明
   健康检查	是否开启对实例进行健康检查的功能。如果选择启用，您需要设置下面的配置项。
   请求路径	健康检查的HTTP Get请求的路径，函数计算向此路径发送HTTP Get请求做健康检查。取值必须以/开头。
   首次探测延迟时间	首次健康检查之前，延迟等待的时间。
   探测时间间隔	发送HTTP GET请求的周期。
   探测超时时间	HTTP GET请求超时的时间，超过设置的该值，则认为请求失败。
   最大失败次数	HTTP GET请求失败阈值。健康检查循环执行期间，HTTP GET请求连续失败次数达到设置的该值时，健康检查状态被判定为检查失败。
   探测成功阈值	HTTP GET请求成功阈值。健康检查循环执行期间，HTTP GET请求连续成功次数达到设置的该值后，健康检查状态被判定为检查成功。

更多信息