公司使用了阿里云的服务,其中可以在项目中使用全链路监测,最近要排查慢响应,所以就在 Node 项目中接了一下[SkyWalking](https://github.com/apache/skywalking-nodejs/tree/master)。
  本文还会记录在使用时遇到的问题,以及解决思路。
## 一、初始化
**1)参数配置**
  SkyWalking支持自动埋点和手动埋点,自动埋点只要初始化后,就可以开始工作,很便捷。
:-: 
**2)下载依赖**
  下载 SkyWalking Node.js Agent
~~~
npm install --save skywalking-backend-js
~~~
**3)初始化**
  在项目的 app.js 中配置和启用 SkyWalking。
~~~
const {default: agent} = require("skywalking-backend-js");
agent.start({
serviceName: 'web-api-pro',
collectorAddress: 'xxx',
authorization: 'xxx'
});
~~~
## 二、分析
**1)应用概览**
  在应用列表,选择web-api进入后,就能看到如下的分析页面。
:-: 
  SkyWalking默认会上报项目内的所有接口通信、MySQL查询、MongoDB查询等。
  但这样会增加存储成本,所以我需要将不相关的接口过滤去除。
**2)过滤接口**
  翻阅官方文档,发现有个参数有这个过滤作用,字符串类型,默认是空字符串。
| 参数 | 描述 | 默认值 |
| --- | --- |--- |
| SW_TRACE_IGNORE_PATHThe | paths of endpoints that will be ignored (not traced), comma separated | `` |
  而跳转到源码中,也发现了对应的字段:traceIgnorePath。
~~~
export declare type AgentConfig = {
serviceName?: string;
collectorAddress?: string;
authorization?: string;
ignoreSuffix?: string;
traceIgnorePath?: string;
reIgnoreOperation?: RegExp;
};
~~~
  在 deepseek 上提问,AI 给了我如何使用参数的示例,通配符的作用也详细的说明了。
~~~
traceIgnorePath: "/healthcheck/*,/static/**"
~~~
  但是,提交到测试环境后,并没有像预想的那样,将指定路径的接口过滤掉。
  在将配置路径,翻来覆去的更改后,仍然不见效,遂去查看源码,在源码中的确包含 traceIgnorePath 参数。
**3)求助阿里云**
  由于这是阿里云提供的可选类型,所以就去阿里云上创建工单。
:-: 
  马上就自动创建了一个小群,与对方的人员语音沟通了下,并且共享了屏幕代码。
  他表示需要花点时间,自己操作一下,在此期间,我自己也继续查看源码,最终发现了端倪。
   阿里云的响应还是很快的,特别及时。
**4)源码分析**
  在 node\_modules 目录中的文件,也可以打印日志,我将传入的参数都打印了出来。
~~~
serviceName: 'web-api',
serviceInstance: 'MacBook-Pro.local',
collectorAddress: 'xxxx',
authorization: 'xxxx',
ignoreSuffix: '.gif',
traceIgnorePath: '/audiostream/audit/callback',
reIgnoreOperation: /^.+(?:\.gif)$|^(?:\/audiostream\/audit\/callback)$/,
~~~
  看到 reIgnoreOperation 参数被赋值了,一段正则,这个很关键,过滤接口,其实就是匹配正则。
  用 reIgnoreOperation 搜索,搜到了被使用的一段代码,operation 是一个传递进来的参数。
~~~
SpanContext.prototype.ignoreCheck = function (operation, type, carrier) {
if (operation.match(AgentConfig_1.default.reIgnoreOperation) ||
(carrier && !carrier.isValid()))
return DummySpan_1.default.create();
return undefined;
};
~~~
  然后再用用 traceIgnorePath 去搜索代码,并没有得到有用的信息,于是将关键字改成 Ignore。
:-: 
  果然找到了合适的代码,在 HttpPlugin.prototype.interceptServerRequest 方法中,找到一段创建 span 的代码。
~~~
var operation = reqMethod + ':' + (req.url || '/').replace(/\?.*/g, '');
var span = AgentConfig_1.ignoreHttpMethodCheck(reqMethod)
? DummySpan_1.default.create()
: ContextManager_1.default.current.newEntrySpan(operation, carrier);
~~~
  链路(即[链路追踪](https://www.cnblogs.com/strick/p/18146195))可深入了解请求路径、性能瓶颈和系统依赖关系,多个处理数据的片段(也叫 span,跨度)通过链路 ID 进行串联,组成一条链路追踪。
  span 中有个三目运算,经过测试发现,如果没有配置要过滤的请求方法,那么就是 false。
  所以会进入到 newEntrySpan() 方法中,而在此方法中,恰恰会调用 ignoreCheck() 方法。
  那么其传入的 operation,其实就是要匹配的路径值,原来我配错了,官方需要带请求方法,如下所示。
~~~
traceIgnorePath: 'POST:/audiostream/audit/callback',
~~~
  不要过渡依赖 AI,我这次就非常相信 AI 给的示例,结果绕了大弯。
**5)运行原理**
  在执行 start() 方法时,会进行参数合并,参数修改等操作。
~~~
Agent.prototype.start = function (options) {
// 传入参数和默认参数合并
Object.assign(AgentConfig_1.default, options);
// 初始化参数,例如拼接正则等
AgentConfig_1.finalizeConfig(AgentConfig_1.default);
// 挂载插件,就是注入链路代码
new PluginInstaller_1.default().install();
// 上报
this.protocol = new GrpcProtocol_1.default().heartbeat().report();
this.started = true;
};
~~~
  其中在 report() 中,会创建一个定时任务,每秒运行一次。
~~~
setTimeout(this.reportFunction.bind(this), 1000).unref();
~~~
  .unref() 告诉 Node.js 事件循环:“此定时器不重要,如果它是唯一剩余的任务,可以忽略它并退出进程”。
  优化进程生命周期管理,避免无关任务阻塞退出。
  最核心的插件有HttpPlugin、IORedisPlugin、MongoosePlugin、AxiosPlugin、MySQLPlugin 等。
  以 HttpPlugin 为例,在 install() 时,会调用 interceptServerRequest() 方法注入链路操作。
~~~
HttpPlugin.prototype.install = function () {
var http = require('http');
this.interceptServerRequest(http, 'http');
};
~~~
  在 interceptServerRequest() 中,会修改 addListener()、on() 方法,并且会包装响应。
~~~
HttpPlugin.prototype.interceptServerRequest = function (module, protocol) {
var plugin = this;
var _addListener = module.Server.prototype.addListener;
module.Server.prototype.addListener = module.Server.prototype.on =
function (event, handler) {
var addArgs = [];
// 复制参数
for (var _i = 2; _i < arguments.length; _i++) {
addArgs[_i - 2] = arguments[_i];
}
// 执行事件
return _addListener.call.apply(
_addListener,
tslib_1.__spreadArrays([this, event,
event === 'request'
? _sw_request
: handler
],
addArgs)
);
function _sw_request(req, res) {
var _this = this;
var _a;
var reqArgs = [];
// 复制参数
for (var _i = 2; _i < arguments.length; _i++) {
reqArgs[_i - 2] = arguments[_i];
}
var carrier = ContextCarrier_1.ContextCarrier.from(req.headers || {});
var reqMethod = (_a = req.method) !== null && _a !== void 0 ? _a : 'GET';
// 拼接请求方法和接口路径
var operation = reqMethod + ':' + (req.url || '/').replace(/\?.*/g, '');
var span = AgentConfig_1.ignoreHttpMethodCheck(reqMethod)
? DummySpan_1.default.create()
: ContextManager_1.default.current.newEntrySpan(operation, carrier);
span.component = Component_1.Component.HTTP_SERVER;
span.tag(Tag_1.default.httpURL(protocol + '://' + (req.headers.host || '') + req.url));
// 包装响应信息
return plugin.wrapHttpResponse(span, req, res, function () {
return handler.call.apply(
handler,
tslib_1.__spreadArrays([_this, req, res], reqArgs)
);
});
}
};
};
~~~
  不过在上线后,发生了意想不到的意外,就是原先可以链式调用的 Mongoose 的方法:
~~~
this.liveApplyRecord.find({ userId }).sort({ createTime: -1 });
~~~
  在调用时会出现报错:
~~~
this.liveApplyRecord.find(...).sort is not a function
~~~
*****
> 原文出处:
[博客园-Node.js躬行记](https://www.cnblogs.com/strick/category/1688575.html)
[知乎专栏-Node.js躬行记](https://zhuanlan.zhihu.com/pwnode)
已建立一个微信前端交流群,如要进群,请先加微信号freedom20180706或扫描下面的二维码,请求中需注明“看云加群”,在通过请求后就会把你拉进来。还搜集整理了一套[面试资料](https://github.com/pwstrick/daily),欢迎浏览。

推荐一款前端监控脚本:[shin-monitor](https://github.com/pwstrick/shin-monitor),不仅能监控前端的错误、通信、打印等行为,还能计算各类性能参数,包括 FMP、LCP、FP 等。
- ES6
- 1、let和const
- 2、扩展运算符和剩余参数
- 3、解构
- 4、模板字面量
- 5、对象字面量的扩展
- 6、Symbol
- 7、代码模块化
- 8、数字
- 9、字符串
- 10、正则表达式
- 11、对象
- 12、数组
- 13、类型化数组
- 14、函数
- 15、箭头函数和尾调用优化
- 16、Set
- 17、Map
- 18、迭代器
- 19、生成器
- 20、类
- 21、类的继承
- 22、Promise
- 23、Promise的静态方法和应用
- 24、代理和反射
- HTML
- 1、SVG
- 2、WebRTC基础实践
- 3、WebRTC视频通话
- 4、Web音视频基础
- CSS进阶
- 1、CSS基础拾遗
- 2、伪类和伪元素
- 3、CSS属性拾遗
- 4、浮动形状
- 5、渐变
- 6、滤镜
- 7、合成
- 8、裁剪和遮罩
- 9、网格布局
- 10、CSS方法论
- 11、管理后台响应式改造
- React
- 1、函数式编程
- 2、JSX
- 3、组件
- 4、生命周期
- 5、React和DOM
- 6、事件
- 7、表单
- 8、样式
- 9、组件通信
- 10、高阶组件
- 11、Redux基础
- 12、Redux中间件
- 13、React Router
- 14、测试框架
- 15、React Hooks
- 16、React源码分析
- 利器
- 1、npm
- 2、Babel
- 3、webpack基础
- 4、webpack进阶
- 5、Git
- 6、Fiddler
- 7、自制脚手架
- 8、VSCode插件研发
- 9、WebView中的页面调试方法
- Vue.js
- 1、数据绑定
- 2、指令
- 3、样式和表单
- 4、组件
- 5、组件通信
- 6、内容分发
- 7、渲染函数和JSX
- 8、Vue Router
- 9、Vuex
- TypeScript
- 1、数据类型
- 2、接口
- 3、类
- 4、泛型
- 5、类型兼容性
- 6、高级类型
- 7、命名空间
- 8、装饰器
- Node.js
- 1、Buffer、流和EventEmitter
- 2、文件系统和网络
- 3、命令行工具
- 4、自建前端监控系统
- 5、定时任务的调试
- 6、自制短链系统
- 7、定时任务的进化史
- 8、通用接口
- 9、微前端实践
- 10、接口日志查询
- 11、E2E测试
- 12、BFF
- 13、MySQL归档
- 14、压力测试
- 15、活动规则引擎
- 16、活动配置化
- 17、UmiJS版本升级
- 18、半吊子的可视化搭建系统
- 19、KOA源码分析(上)
- 20、KOA源码分析(下)
- 21、花10分钟入门Node.js
- 22、Node环境升级日志
- 23、Worker threads
- 24、低代码
- 25、Web自动化测试
- 26、接口拦截和页面回放实验
- 27、接口管理
- 28、Cypress自动化测试实践
- 29、基于Electron的开播助手
- 30、SkyWalking使用和排查分析
- Node.js精进
- 1、模块化
- 2、异步编程
- 3、流
- 4、事件触发器
- 5、HTTP
- 6、文件
- 7、日志
- 8、错误处理
- 9、性能监控(上)
- 10、性能监控(下)
- 11、Socket.IO
- 12、ElasticSearch
- 监控系统
- 1、SDK
- 2、存储和分析
- 3、性能监控
- 4、内存泄漏
- 5、小程序
- 6、较长的白屏时间
- 7、页面奔溃
- 8、shin-monitor源码分析
- 前端性能精进
- 1、优化方法论之测量
- 2、优化方法论之分析
- 3、浏览器之图像
- 4、浏览器之呈现
- 5、浏览器之JavaScript
- 6、网络
- 7、构建
- 前端体验优化
- 1、概述
- 2、基建
- 3、后端
- 4、数据
- 5、后台
- Web优化
- 1、CSS优化
- 2、JavaScript优化
- 3、图像和网络
- 4、用户体验和工具
- 5、网站优化
- 6、优化闭环实践
- 数据结构与算法
- 1、链表
- 2、栈、队列、散列表和位运算
- 3、二叉树
- 4、二分查找
- 5、回溯算法
- 6、贪心算法
- 7、分治算法
- 8、动态规划
- 程序员之路
- 大学
- 2011年
- 2012年
- 2013年
- 2014年
- 项目反思
- 前端基础学习分享
- 2015年
- 再一次项目反思
- 然并卵
- PC网站CSS分享
- 2016年
- 制造自己的榫卯
- PrimusUI
- 2017年
- 工匠精神
- 2018年
- 2019年
- 前端学习之路分享
- 2020年
- 2021年
- 2022年
- 2023年
- 2024年
- 日志
- 2020