使用限制

僅Web 函數實例支持設置健康檢查功能。

健康檢查的行為

實例啟動行為

關于探測成功閾值和最大失敗次數的設置，請參見使用控制臺為函數實例設置健康檢查。

單次健康檢查行為

健康檢查失敗后的調度行為

使用控制臺為函數實例設置健康檢查

本文以選擇Web 函數方式創建一個運行環境為Node.js 18的函數為例，介紹如何為函數的實例配置健康檢查功能。

步驟一：創建函數

1. 登錄函數計算控制臺，在左側導航欄，單擊函數。

2. 在頂部菜單欄，選擇地域，然后在函數頁面，單擊創建函數。

3. 在創建函數頁面，按需選擇創建函數的方式，配置以下配置項，然后單擊創建。

   本文選擇創建函數的方式為Web函數。配置項說明如下，其余配置項保持默認值。

   配置項	說明
   函數名稱	自定義函數名稱。
   運行環境	選擇Node.js 18。

4. 在函數配置頁面，選擇代碼頁簽，在代碼編輯器內編輯函數代碼，然后部署代碼并執行函數。

   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，持續檢查實例是否正常。

   當函數計算判定您的函數實例異常時，將嘗試將請求調度到其他正常的實例。如果函數計算調度失敗，會返回健康檢查失敗相關的報錯信息。

步驟二：為函數實例設置健康檢查

1. 登錄函數計算控制臺，在左側導航欄，單擊函數。

2. 在頂部菜單欄，選擇地域，然后在函數頁面，單擊目標函數。

3. 在函數配置頁面，選擇配置頁簽。

4. 在左側菜單欄，選擇健康檢查頁簽，單擊編輯，在健康檢查頁面按需設置以下配置項，然后單擊確定。

   配置項	說明
   健康檢查	是否開啟對實例進行健康檢查的功能。如果選擇啟用，您需要設置下面的配置項。
   請求路徑	健康檢查的HTTP Get請求的路徑，函數計算向此路徑發送HTTP Get請求做健康檢查。取值必須以/開頭。
   首次探測延遲時間	首次健康檢查之前，延遲等待的時間。
   探測時間間隔	發送HTTP GET請求的周期。
   探測超時時間	HTTP GET請求超時的時間，超過設置的該值，則認為請求失敗。
   最大失敗次數	HTTP GET請求失敗閾值。健康檢查循環執行期間，HTTP GET請求連續失敗次數達到設置的該值時，健康檢查狀態被判定為檢查失敗。
   探測成功閾值	HTTP GET請求成功閾值。健康檢查循環執行期間，HTTP GET請求連續成功次數達到設置的該值后，健康檢查狀態被判定為檢查成功。

步驟三：驗證健康檢查配置情況

1. 在函數配置頁面，選擇代碼頁簽，單擊測試函數，查看函數運行結果。

   步驟一的代碼示例，函數實例健康檢查正常，返回結果為OK。

2. 修改代碼中的健康檢查部分為下面的代碼，然后單擊部署代碼，代碼部署成功后，再次單擊測試函數，查看函數運行結果。

   修改后的代碼內容如下。

   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');
   });

   函數實例健康檢查將總是返回500錯誤碼，再次執行函數，返回的信息如下。

   {
       "RequestId": "1-65081d42-e4895cbc7d6252bda643****",
       "Code": "FunctionNotStarted",
       "Message": "The function http server cannot be started. check function health failed with status code: 500 "
   }

更多信息