NodeJS Profiling¶
目前 DataKit 支持 1 种方式来采集 NodeJS profiling 数据，即 Pyroscope。
Pyroscope¶
Pyroscope 是一款开源的持续 profiling 平台，DataKit 已经支持将其上报的 profiling 数据展示在观测云。
Pyroscope 采用 C/S 架构，运行模式分为 Pyroscope Agent 和 Pyroscope Server，这两个模式均集成在一个二进制文件中，通过不同的命令行命令来展现。
这里需要的是 Pyroscope Agent 模式。DataKit 已经集成了 Pyroscope Server 功能，通过对外暴露 HTTP 接口的方式，可以接收 Pyroscope Agent 上报的 profiling 数据。
Profiling 数据流向：「Pyroscope Agent 采集 Profiling 数据 -> Datakit -> 观测云」。
在这里，你的 NodeJS 程序就相当于是一个 Pyroscope Agent。
前置条件¶
- 根据 Pyroscope 官方文档 NodeJS, 支持以下平台：
| Linux | macOS | Windows | Docker |
|---|---|---|---|
 |
|
 |
|
- Profiling NodeJS 程序
Profiling NodeJS 程序需要把 npm 模块引入到程序中：
把以下代码加入到你的 NodeJS 程序代码中：
const Pyroscope = require('@pyroscope/nodejs');
Pyroscope.init({
serverAddress: 'http://pyroscope:4040',
appName: 'myNodeService',
tags: {
region: 'cn'
}
});
Pyroscope.start()
[[inputs.profile]]
## profile Agent endpoints register by version respectively.
## Endpoints can be skipped listen by remove them from the list.
## Default value set as below. DO NOT MODIFY THESE ENDPOINTS if not necessary.
endpoints = ["/profiling/v1/input"]
# config
[[inputs.profile.pyroscope]]
# listen url
url = "0.0.0.0:4040"
# service name
service = "pyroscope-demo"
# app env
env = "dev"
# app version
version = "0.0.0"
[inputs.profile.pyroscope.tags]
tag1 = "val1"
启动 DataKit, 然后启动你的 NodeJS 程序。
查看 Profile¶
执行上述操作后，你的 NodeJS 程序会开始采集 profiling 数据并将数据报给给 Datakit，Datakit 会将这些数据上报给观测云。稍等几分钟后就可以在观测云空间应用性能监测 -> Profile 查看相应数据。
Pull 模式 (可选)¶
集成 NodeJS 程序的方式也支持 Pull 模式。你必须确保你的 NodeJS 程序有 profiling 路由 (/debug/pprof/profile 和 /debug/pprof/heap) 且是启用状态。为此你可以使用 expressMiddleware 模块或者自己创建路由接入点：
const Pyroscope, { expressMiddleware } = require('@pyroscope/nodejs');
Pyroscope.init({...})
app.use(expressMiddleware())
注意：你不必再使用
.start()但必须使用.init()。
FAQ¶
如何排查 Pyroscope 问题¶
可以设置环境变量 DEBUG 到 pyroscope, 然后查看调试信息：