Node綁定全局TraceID的實現(xiàn)方法
問題描述
由于Node.js的 單線程模型 的限制，我們無法設置全局 traceid 來聚合請求，即 實現(xiàn)輸出日志與請求的綁定 。如果不實現(xiàn)日志和請求的綁定，我們難以判斷日志輸出與對應用戶請求的對應關系，這對 線上問題排查 帶來了困難。
例如，在用戶訪問 retrieveOne API 時，其會調用 retrieveOneSub 函數(shù)，如果我們想在 retrieveOneSub 函數(shù)中輸出當前請求對應的學生信息，是繁瑣的。在 course-se 現(xiàn)有實現(xiàn)下，我們針對此問題的解決方法是：
- 方案1：在調用 retrieveOneSub 函數(shù)的父函數(shù)，即 retrieveOne 內，對 paramData 進行 解構 ，輸出學生相關信息，但該方案 無法細化日志輸出粒度 。
- 方案2：修改 retrieveOneSub 函數(shù)簽名，接收 paramData 為其參數(shù)，該方案 能確保日志輸出粒度 ，但 在調用鏈很深的情況下，需要給各函數(shù)修改函數(shù)簽名 ，使其接收 paramData ，頗具工作量，并不太可行。
/**
* 返回獲取一份提交的函數(shù)
* @param {ParamData} paramData
* @param {Context} ctx
* @param {string} id
*/
export async function retrieveOne(paramData, ctx, id) {
const { subModel } = paramData.ce;
const sub_asgn_id = Number(id);
// 通過 paramData.user 獲取 user 相關信息，如 user_id ，
// 但無法細化日志輸出粒度，除非修改 retrieveOneSub 的簽名，
// 添加 paramData 為其參數(shù)。
const { user_id } = paramData.user;
console.log(`${user_id} is trying to retreive one submission.`);
// 調用了 retrieveOneSub 函數(shù)。
const sub = await retrieveOneSub(sub_asgn_id, subModel);
const submission = sub;
assign(sub, { sub_asgn_id });
assign(paramData, { submission, sub });
return sub;
}
/**
* 從數(shù)據(jù)庫獲取一份提交
* @param {number} sub_asgn_id
* @param {SubModel} model
*/
async function retrieveOneSub(sub_asgn_id, model) {
const [sub] = await model.findById(sub_asgn_id);
if (!sub) {
throw new ME.SoftError(ME.NOT_FOUND, '找不到該提交');
}
return sub;
}
Async Hooks
其實，針對以上的問題，我們還可以從 Node 的 Async Hooks 實驗性 API 方面入手。在 Node.js v8.x 后，官方提供了可用于 監(jiān)聽異步行為 的 Async Hooks（異步鉤子）API 的支持。
Async Scope
Async Hooks 對每一個（同步或異步）函數(shù)提供了一個 Async Scope ，我們可調用 executionAsyncId 方法獲取當前函數(shù)的 Async ID ，調用 triggerAsyncId 獲取當前函數(shù)調用者的 Async ID。
const asyncHooks = require("async_hooks");
const { executionAsyncId, triggerAsyncId } = asyncHooks;
console.log(`top level: ${executionAsyncId()} ${triggerAsyncId()}`);
const f = () => {
console.log(`f: ${executionAsyncId()} ${triggerAsyncId()}`);
};
f();
const g = () => {
console.log(`setTimeout: ${executionAsyncId()} ${triggerAsyncId()}`);
setTimeout(() => {
console.log(`inner setTimeout: ${executionAsyncId()} ${triggerAsyncId()}`);
}, 0);
};
setTimeout(g, 0);
setTimeout(g, 0);
在上述代碼中，我們使用 setTimeout 模擬一個異步調用過程，且在該異步過程中我們調用了 handler 同步函數(shù)，我們在每個函數(shù)內都輸出其對應的 Async ID 和 Trigger Async ID 。執(zhí)行上述代碼后，其運行結果如下。
top level: 1 0 f: 1 0 setTimeout: 7 1 setTimeout: 9 1 inner setTimeout: 11 7 inner setTimeout: 13 9
通過上述日志輸出，我們得出以下信息：
- 調用同步函數(shù)，不會改變其 Async ID ，如函數(shù) f 內的 Async ID 和其調用者的 Async ID 相同。
- 同一個函數(shù)，被不同時刻進行異步調用，會分配至不同的 Async ID ，如上述代碼中的 g 函數(shù)。
追蹤異步資源
正如我們前面所說的，Async Hooks 可用于追蹤異步資源。為了實現(xiàn)此目的，我們需要了解 Async Hooks 的相關 API ，具體說明參照以下代碼中的注釋。
const asyncHooks = require("async_hooks");
// 創(chuàng)建一個 AsyncHooks 實例。
const hooks = asyncHooks.createHook({
// 對象構造時會觸發(fā) init 事件。
init: function(asyncId, type, triggerId, resource) {},
// 在執(zhí)行回調前會觸發(fā) before 事件。
before: function(asyncId) {},
// 在執(zhí)行回調后會觸發(fā) after 事件。
after: function(asyncId) {},
// 在銷毀對象后會觸發(fā) destroy 事件。
destroy: function(asyncId) {}
});
// 允許該實例中對異步函數(shù)啟用 hooks 。
hooks.enable();
// 關閉對異步資源的追蹤。
hooks.disable();
我們在調用 createHook 時，可注入 init 、 before 、 after 和 destroy 函數(shù)，用于 追蹤異步資源的不同生命周期 。
全新解決方案
基于 Async Hooks API ，我們即可設計以下解決方案，實現(xiàn)日志與請求記錄的綁定，即 Trace ID 的全局綁定。
const asyncHooks = require("async_hooks");
const { executionAsyncId } = asyncHooks;
// 保存異步調用的上下文。
const contexts = {};
const hooks = asyncHooks.createHook({
// 對象構造時會觸發(fā) init 事件。
init: function(asyncId, type, triggerId, resource) {
// triggerId 即為當前函數(shù)的調用者的 asyncId 。
if (contexts[triggerId]) {
// 設置當前函數(shù)的異步上下文與調用者的異步上下文一致。
contexts[asyncId] = contexts[triggerId];
}
},
// 在銷毀對象后會觸發(fā) destroy 事件。
destroy: function(asyncId) {
if (!contexts[asyncId]) return;
// 銷毀當前異步上下文。
delete contexts[asyncId];
}
});
// 關鍵！允許該實例中對異步函數(shù)啟用 hooks 。
hooks.enable();
// 模擬業(yè)務處理函數(shù)。
function handler(params) {
// 設置 context ，可在中間件中完成此操作（如 Logger Middleware）。
contexts[executionAsyncId()] = params;
// 以下是業(yè)務邏輯。
console.log(`handler ${JSON.stringify(params)}`);
f();
}
function f() {
setTimeout(() => {
// 輸出所屬異步過程的 params 。
console.log(`setTimeout ${JSON.stringify(contexts[executionAsyncId()])}`);
});
}
// 模擬兩個異步過程（兩個請求）。
setTimeout(handler, 0, { id: 0 });
setTimeout(handler, 0, { id: 1 });
在上述代碼中，我們先聲明了 contexts 用于存儲每個異步過程中的上下文數(shù)據(jù)（如 Trace ID），隨后我們創(chuàng)建了一個 Async Hooks 實例。我們在異步資源初始化時，設置當前 Async ID 對應的上下文數(shù)據(jù)，使得其數(shù)據(jù)為調用者的上下文數(shù)據(jù)；我們在異步資源被銷毀時，刪除其對應的上下文數(shù)據(jù)。
通過這種方式，我們只需在一開始設置上下文數(shù)據(jù)，即可在其引發(fā)的各個過程（同步和異步過程）中，獲得上下文數(shù)據(jù)，從而解決了問題。
執(zhí)行上述代碼，其運行結果如下。根據(jù)輸出日志可知，我們的解決方案是可行的。
handler {"id":0}
handler {"id":1}
setTimeout {"id":0}
setTimeout {"id":1}
不過需要注意的是，Async Hooks 是 實驗性 API ， 存在一定的性能損耗 ，但 Node 官方正努力將其變得生產可用。因此， 在機器資源足夠的情況下，使用本解決方案，犧牲部分性能，換取開發(fā)體驗。
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。
相關文章
NodeJS 將文件夾按照存放路徑變成一個對應的JSON的方法
這篇文章主要介紹了NodeJS 將文件夾按照存放路徑變成一個對應的JSON的方法，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-10-10
node.js中express中間件body-parser的介紹與用法詳解
這篇文章主要給大家介紹了關于node.js中express中間件body-parser的相關資料，文章通過示例代碼介紹的非常詳細，對大家具有一定的參考學習價值，需要的朋友們下面來一起看看吧。2017-05-05
在node環(huán)境下parse Smarty模板的使用示例代碼
這篇文章主要介紹了在node環(huán)境下parse Smarty模板的使用示例代碼，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2019-11-11
今天小編就為大家分享一篇完美解決linux下node.js全局模塊找不到的情況，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2018-05-05
這篇文章主要介紹了詳解NODEJS的http實現(xiàn)的技術過程以及詳細分析，需要的朋友學習參考下吧。2018-01-01
這篇文章的目標是為了向大家展示如何在Docker的container里運行Node.js程序，文中通過圖文與示例代碼介紹的非常詳細，有需要的朋友們可以參考借鑒。2016-09-09
下面小編就為大家分享一篇基于模板引擎Jade的應用詳解，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2017-12-12
這篇文章主要為大家詳細介紹了Node的stream數(shù)據(jù)流，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下，希望能夠給你帶來幫助2022-02-02
本文是本系列文章的第二篇，主要是測試針對于web后端的驅動，在開發(fā)過程中，在開發(fā)完成一段代碼后如果負責任而不是說完全把問題交給測試人員去發(fā)現(xiàn)的話，這個時候通常都會去做一些手動的測試。2015-04-04
Node.js用c++語言編寫而成的，是一個基于chrome V8引擎的javascript運行環(huán)境。這篇文章主要介紹了詳解node.js中的npm和webpack配置,需要的朋友可以參考下2018-01-01