# @codefresh-io/cf-telemetry 中文文档

规范地址：https://npmcn.com/package/%40codefresh-io/cf-telemetry/

版本：4\.6\.6
npm 元数据更新时间：2026-11-09T14:48:46.174Z
中文译文更新时间：2026-11-10T06:41:45.279Z
软件包许可：未声明

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

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

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

- 包体积（解压后）：142 kB，179 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- Node.js 要求：\>=20 \<=24
- 运行依赖：13 个
- 首次发布：2025-01-17T15:09:30.736Z
- 最新版本发布：2026-11-09T14:48:45.954Z
- 近 30 天下载量：6282（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：153（近 12 个月 74 个）

## 中文简介

用于监测的基特利斯.

## 安装

```sh
npm install @codefresh-io/cf-telemetry
```

也可以使用：`pnpm add @codefresh-io/cf-telemetry`、`yarn add @codefresh-io/cf-telemetry`、`bun add @codefresh-io/cf-telemetry`

## README

# 相对远程测量

用于监测的基特利斯.

包括:

-   [日志](https://npmcn.com/package/%40codefresh-io/cf-telemetry/src/logs/README.md)快速和结构完善.
-   [蒙戈DB](https://npmcn.com/package/%40codefresh-io/cf-telemetry/src/metrics/mongodb/README.md) 客户端监控助手.
-   [打开几何](https://npmcn.com/package/%40codefresh-io/cf-telemetry/src/otel/README.md) 自动仪器、API和助手.
-   [普罗米修斯](https://npmcn.com/package/%40codefresh-io/cf-telemetry/src/metrics/prometheus/README.md) 服务器和自定义参数.
-   [平面镜](https://npmcn.com/package/%40codefresh-io/cf-telemetry/src/profiles/README.md) 以配置 CPU 和内存.

## 使用量

添加 `import '@codefresh-io/cf-telemetry/init'` 语句,在应用程序生命周期之初.

关于进一步的配置和使用细节,请参见上文单独的文件.

```TS
// index.ts
// ↓ Should be imported first
import '@codefresh-io/cf-telemetry/init'
// ↓ Keep one blank line below to prevent automatic import reordering
```

### 生命周期通知

此库只登记终止收听器 `beforeExit` 事件以优雅地终止仪器,其中可能包括冲出日志、度量衡和配置.

> \[大 请确保呼叫 `terminate()` 此库调用前的方法 `process.exit()`,或者将它纳入处理的应用程序逻辑中 `SIGINT`编号 :`SIGTERM` 信号,以确保优雅地终止仪器.

```TS
import { terminate } from '@codefresh-io/cf-telemetry/init'

// ...your application logic
await terminate();    // Ensure graceful termination of instrumentation
process.exit(0);      // Now it's safe to exit the process
```

```TS
import { terminate } from '@codefresh-io/cf-telemetry/init'

process.on('SIGINT', async () => {
  await terminate();    // Ensure graceful termination of instrumentation
  process.exit(130);    // Now it's safe to exit the process
});
process.on('SIGTERM', async () => {
  await terminate();    // Ensure graceful termination of instrumentation
  process.exit(143);    // Now it's safe to exit the process
});
```

## 环境变量

| 变量 | 需求 | 默认值 | 说明 |
| --- | --- | --- | --- |
| `CF_SERVICE_NAME` | 选项 | `unknown_service:node` | 设置 OpenTeleometry, Pyroscope 和 Prometheus 的服务名称. |
| `CF_SERVICE_VERSION` | 选项 | `unknown` | 设定OpenTeleometry,平面镜和普罗米修斯的服务版本. |

## 常见问题

### @codefresh-io/cf-telemetry 是什么？

用于监测的基特利斯\.

### 如何安装 @codefresh-io/cf-telemetry？

在项目目录运行 npm install @codefresh-io/cf-telemetry，或使用 pnpm add / yarn add / bun add。

### @codefresh-io/cf-telemetry 支持 TypeScript 吗？

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

### @codefresh-io/cf-telemetry 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @codefresh-io/cf-telemetry 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20 \<=24。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @codefresh-io/cf-telemetry 可以商用吗？

@codefresh-io/cf-telemetry 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @codefresh-io/cf-telemetry 的下载量有多少？

根据 npm 官方下载统计，@codefresh-io/cf-telemetry 在 2026/10/10 – 2026/11/08 这 30 天内被下载 6,282 次，日均约 209 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @codefresh-io/cf-telemetry 还在维护吗？

最新版本 4\.6\.6 发布于 2026/11/09（今天）；至今共发布 153 个版本，其中过去 12 个月发布了 74 个；首次发布于 2025/01/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。