# @apm-js-collab/tracing-hooks 中文文档

规范地址：https://npmcn.com/package/%40apm-js-collab/tracing-hooks/

版本：0\.14\.0
npm 元数据更新时间：2026-10-23T13:00:07.134Z
中文译文更新时间：2026-11-06T10:40:08.747Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40apm-js-collab/tracing-hooks
原文对照：https://npmcn.com/package/%40apm-js-collab/tracing-hooks/?lang=original
项目主页：https://github.com/apm-js-collab/tracing-hooks#readme
源码仓库：https://github.com/apm-js-collab/tracing-hooks

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：31.5 kB，8 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：3 个
- 首次发布：2025-08-19T16:33:10.502Z
- 最新版本发布：2026-10-23T13:00:06.748Z
- 近 30 天下载量：41670660（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 16 个）

## 中文简介

CJS和管风琴的无害环境管理钩

## 安装

```sh
npm install @apm-js-collab/tracing-hooks
```

也可以使用：`pnpm add @apm-js-collab/tracing-hooks`、`yarn add @apm-js-collab/tracing-hooks`、`bun add @apm-js-collab/tracing-hooks`

## README

# 追踪钩子

该寄存器包含一个用于向Node.js模块中注入跟踪通道钩的无害环境管理装载器。 它还有一个用于补丁CJS模块的模块补丁.

## 使用量

注:节点.js中的模块加载钩子 API 已改变 v26. 用 具有前置兼容性,创建作为无害环境管理模块的综合装载器.

对于任何普通JS都可以这样做 _或者说_ ES模块应用,但 装载机本身必须使用无害环境管理.

```js
// loader.mjs
import Module from 'node:module'

// the synchronous hooks for newer node versions
import { initialize, resolve, load } from '@apm-js-collab/tracing-hooks/hook-sync.mjs'
import ModulePatch from '@apm-js-collab/tracing-hooks'

// the instrumentations we want to apply
const instrumentations = [
  {
    channelName: 'channel1',
    module: { name: 'pkg1', verisonRange: '>=1.0.0', filePath: 'index.js' },
    functionQuery: {
      className: 'Class1',
      methodName: 'method1',
      kind: 'Async'
    }
  },
  {
    channelName: 'channel2',
    module: { name: 'pkg2', verisonRange: '>=1.0.0', filePath: 'index.js' },
    functionQuery: {
      className: 'Class2,
      methodName: 'method2',
      kind: 'Sync'
    }
  }
]

// detection to decide module loader hooks to use
// registerHooks was present but not stable until 24.13 and 25.1
const version = (process.versions.node ?? '0.0.0')
  .split('.')
  .map(n => parseInt(n, 10))
const stableSyncHooks = version[0] > 25 ||
  version[0] === 25 && version[1] >= 1 ||
  version[0] === 24 && version[1] >= 13

if (typeof Module.registerHooks === 'function' && stableSyncHooks) {
  initialize({ instrumentations })
  Module.registerHooks({ resolve, load })
} else if (typeof Module.register === 'function') {
  Module.register('@apm-js-collab/tracing-hooks/hook.mjs', import.meta.url, {
    data: { instrumentations }
  });

  // ALSO patch `Module.prototype._compile`. This is REQUIRED, not an
  // optimisation: on this path CommonJS is instrumented entirely by
  // the patch, never by the async `load` hook.
  // Two reasons. When an ESM file `import`s a CJS package, Node
  // resolves the package's INTERNAL `require()` calls through the CJS
  // machinery, so they never reach the ESM resolve hook. And handing
  // `source` back for a CommonJS module from the async `load` hook
  // makes Node evaluate it on the synchronous require(esm) bridge,
  // which throws ERR_VM_MODULE_LINK_FAILURE on Node < 24.12 whenever
  // that module's top-level require() chain reaches an ES module
  // (https://github.com/nodejs/node/issues/59666).
  // Neither applies in the registerHooks case, because Node applies
  // those hooks to all CJS and ESM modules.
  new ModulePatch({ instrumentations }).patch();
} else {
  throw new Error('No available API to apply module load hooks')
}
```

要运行您的申请 与这些仪器应用,通过 给 `--import` 参数 :

```
node --import=loader.mjs ./my-app.js
```

## 调试

这个 [调试模块](https://www.npmjs.com/package/debug) 用于提供 深入了解补丁过程。 设定 `DEBUG='@apm-js-collab*'` 查看这些 木头.

此外,任何被补丁的文件都可以通过启用垃圾堆模式来写入. 这个 设置环境变量 `TRACING_DUMP` 任何价值。 以 默认时,它将将文件写入系统的临时目录 父目录。 目标父目录可以通过设置来配置 页:1 `TRACING_DUMP_DIR` 环境变量到绝对路径。 无论是 中,已解析的模块文件名随附后。 对于 示例,如果我们正在补丁 `lib/index.js` 输入 `foo` 包,我们设置 一个基础目录 `/tmp/dump/`,然后将补丁代码写入 `/tmp/dump/foo/lib/index.js`。 。 。 .

### 诊断钩

诊断钩可以设置,每一次模块被转换时都叫它 或转换失败.

```js
import { setDiagnosticsHook } from '@apm-js-collab/tracing-hooks/hook-sync.mjs'

setDiagnosticsHook(({ url, moduleName, error }) => {
  if(error) {
    // injection failed
  } else {
    // injection succeeded
  }
})
```

与同步 `registerHooks` (和 `_compile` 补丁) 这是需要的。 年长的Aync `register` 在一条单独的线上运行它的钩 上面设置的钩子不可见,所以通过用 `createDiagnosticsPort()` 用于装入器线条将其诊断结果放回:

```js
import { setDiagnosticsHook, createDiagnosticsPort } from '@apm-js-collab/tracing-hooks/hook-sync.mjs'

setDiagnosticsHook(({ url, moduleName, error }) => { /* ... */ })

const diagnosticsPort = createDiagnosticsPort()
Module.register('@apm-js-collab/tracing-hooks/hook.mjs', import.meta.url, {
  data: { instrumentations, diagnosticsPort },
  transferList: [diagnosticsPort]
})
```

在这个路径上,从加载器线程中发布ES模块的诊断结果和 因此,在模块转换之后的一段时间内,同步到达; 通用JS模块的诊断来自 `_compile` 补丁并释放 和以前一样同步 端口不能让过程活着 所以 当程序退出时,诊断还在飞行中.

## 常见问题

### @apm-js-collab/tracing-hooks 是什么？

CJS和管风琴的无害环境管理钩

### 如何安装 @apm-js-collab/tracing-hooks？

在项目目录运行 npm install @apm-js-collab/tracing-hooks，或使用 pnpm add / yarn add / bun add。

### @apm-js-collab/tracing-hooks 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/apm-js-collab\_\_tracing-hooks 是否存在。

### @apm-js-collab/tracing-hooks 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @apm-js-collab/tracing-hooks 可以商用吗？

@apm-js-collab/tracing-hooks 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @apm-js-collab/tracing-hooks 的下载量有多少？

根据 npm 官方下载统计，@apm-js-collab/tracing-hooks 在 2026/10/07 – 2026/11/05 这 30 天内被下载 41,670,660 次，日均约 1,389,022 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @apm-js-collab/tracing-hooks 还在维护吗？

最新版本 0\.14\.0 发布于 2026/10/23（15 天前）；至今共发布 22 个版本，其中过去 12 个月发布了 16 个；首次发布于 2025/08/20。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。