追踪钩子

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

使用量

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

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

// 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

调试

这个 调试模块 用于提供 深入了解补丁过程。 设定 DEBUG='@apm-js-collab*' 查看这些 木头.

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

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 补丁并释放 和以前一样同步 端口不能让过程活着 所以 当程序退出时,诊断还在飞行中.