@ chainsaf/ prometheus- gc- stats
使用Prometheus报告Nodejs垃圾收集数据
使用量
此模块对等端依赖 prom-client目前,有10个得到支持.
调用时自动启动GC 数据的收集 gcStats ,并在调用返回的函数时被停止.
示例
import prometheus from 'prom-client';
import { gcStats } from '@chainsafe/prometheus-gc-stats';
prometheus.collectDefaultMetrics();
const stopGcStats = gcStats(prometheus.register);
// eventually
stopGcStats()
node:v8
用于收集GC统计数据的模块是: node:v8,本模块使用需要Nodejs v18+的特性.
暴露的计量
本模块暴露出3个度量:
nodejs_gc_runs_total: 计算引用GC的次数nodejs_gc_pause_seconds_total: GC用时以秒计nodejs_gc_reclaimed_bytes_total: GC 字节数已释放
您可以使用下列选项在参数名称中添加前缀:
const stopGcStats = gcStats(prometheus.register, {
prefix: 'my_application_',
});
贷项
感谢@tcolgate和@SimenB的原始执行.
关于 @chainsafe/prometheus-gc-stats 的常见问题
@chainsafe/prometheus-gc-stats 是什么？
使用Prometheus报告Nodejs垃圾收集数据
如何安装 @chainsafe/prometheus-gc-stats？
在项目目录运行 npm install @chainsafe/prometheus-gc-stats，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：prom-client（>= 10）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。
@chainsafe/prometheus-gc-stats 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
@chainsafe/prometheus-gc-stats 支持 ESM 还是 CommonJS？
以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module，更早的版本需要改用动态 import()。
@chainsafe/prometheus-gc-stats 需要什么版本的 Node.js？
package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。
@chainsafe/prometheus-gc-stats 可以商用吗？
@chainsafe/prometheus-gc-stats 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
@chainsafe/prometheus-gc-stats 的下载量有多少？
根据 npm 官方下载统计，@chainsafe/prometheus-gc-stats 在 2026/10/10 – 2026/11/08 这 30 天内被下载 62,631 次，日均约 2,088 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@chainsafe/prometheus-gc-stats 还在维护吗？
最新版本 1.0.2 发布于 2023/06/22（3 年前）；至今共发布 2 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/06/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。