# @bondsports/telemetry 中文文档

规范地址：https://npmcn.com/package/%40bondsports/telemetry/

版本：1\.3\.0
npm 元数据更新时间：2026-08-25T13:49:26.450Z
中文译文更新时间：2026-11-08T10:57:18.869Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40bondsports/telemetry
原文对照：https://npmcn.com/package/%40bondsports/telemetry/?lang=original
源码仓库：https://github.com/Bond-Sports/bondUtils#main

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

- 包体积（解压后）：74.4 kB，74 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：14 个
- 首次发布：2022-07-31T09:22:05.418Z
- 最新版本发布：2026-04-23T13:11:49.191Z
- 近 30 天下载量：2117（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：30（近 12 个月 3 个）

## 中文简介

债券运动中所有开远的软件包

## 安装

```sh
npm install @bondsports/telemetry
```

也可以使用：`pnpm add @bondsports/telemetry`、`yarn add @bondsports/telemetry`、`bun add @bondsports/telemetry`

## README

# 遥测

## 动机

这个软件包的目标是使配置和与OpenTeleometry合作的经验更加容易.

## 实例

以下是追踪和衡量尺度的简短例子。 现有更多实例 [示例文件夹](https://npmcn.com/package/%40bondsports/telemetry/examples/),以及各种开口遥测重置.

### 追踪

下面的代码显示了一个简单的例子,说明如何进行追踪. 请注意您需要手动安装您需要的自动仪器库 .

```typescript
import { Tracing } from '@bondsports/telemetry';
import { trace } from '@opentelemetry/api';

const tracing = new Tracing();

tracing.start();

const tracer = trace.getTracer('tracing-name')

const span = tracer.startSpan('some-action');

span.setAttribute('some-attribute');

// DO STUFF

span.end();

tracing.stop().then(() => console.log('done'));
```

用自定义资源初始化追踪的另一种方式:

```typescript
import { Tracing } from '@bondsports/telemetry';
import { Resource } from '@opentelemetry/resources';

const resource = new Resource({ 'service.version': number, 'service.name': 'my-service-name' });

const tracing = new Tracing([], resource);
...
```

### 计量

以下的代码显示了一个如何使用度量衡的简单实例.

```typescript
import { Metrics } from '@bondsports/telemetry';

const metrics = new Metrics('sample-meter');

const meter = metrics.start();

const counter = meter.createCounter('sample_counter');

counter.add(1);

metrics.stop().then(() => console.log('done'));
```

### Trace-ID 响应信头( Express Misterware)

`getTraceIdHeaderMiddleware` 设置来自 活动 OpenTelection 跨度使客户端和日志聚合工具可以关联到一个 跨系统单项请求:

| 页眉 | 格式 | 匹配 |
| --- | --- | --- |
| `X-Trace-Id` | 32-Char 十六进制(W3C) | `trace_id` 应用程序日志中的字段 |
| `Trace_Id` | 32-Char 十六进制(W3C) | `trace_id` 应用程序日志中的字段 |
| `X-Amzn-Trace-Id` | `Root=1-<8hex>-<24hex>` (AWS X-Ray) (美国英语) | 原始内容 `X-Amzn-Trace-Id` 存储在 AWS ALB 访问日志/ OpenSearch 中的页眉 |

当入境请求已经载有 `X-Amzn-Trace-Id` 页眉( 典型的) 在AWS ALB后面,其价值被逐字反射,所以 `Self=` 编号 : `Sampled=` 编号 : 中等跳跃设置的自定义字段被保留。 否则头是 由活动段的跟踪ID重建而来.

```typescript
import express from 'express';
import { getTraceIdHeaderMiddleware } from '@bondsports/telemetry';

const app = express();
app.use(getTraceIdHeaderMiddleware());
```

## 配置

### 通用配置

| 名称 | 允许的值 | 默认值 | 说明 |
| --- | --- | --- | --- |
| 电话 服务 NAME | 字符串 | 从软件包.json | 服务名称 |
| TEMETRY 服务 VERSION | 字符串 | 从软件包.json | 服务版本 |
| (原始内容存档于2018-10-21). TELEMATRY HOST NAME | 字符串 | `os.hostname()` | 主机名称 |
|   
 |  |  |  |

### 追踪配置

| 名称 | 允许的值 | 默认值 | 说明 |
| --- | --- | --- | --- |
| 电话: 收听: | '真','虚假' | "虚假" | 是否启用追踪 |
| 电话 电话\* 联合国 | 字符串 | http://localhost:55681/v1/trace (英语) | 打开远程收藏器的 URL |
| 电话: 收听: | 浮动 | 1个 | 样本的痕迹量 |

\* 联合国 需要(仅在允许追查时).  

### 计量配置

| 名称 | 允许的值 | 默认值 | 说明 |
| --- | --- | --- | --- |
| 铁矿 金属矿 | '真','虚假' | "虚假" | 是否启用计量 |
| 铁丝网 铁丝网 URL\* 联合国 | 字符串 | http://localhost:55681/v1/metrics (英语) | 打开远程收藏器的 URL |
| (电话: | 编号 | 15000个 | 向采集器发送数据之间的相差微秒 |

\* 联合国 需要(仅在允许追查时).

## 常见问题

### @bondsports/telemetry 是什么？

债券运动中所有开远的软件包

### 如何安装 @bondsports/telemetry？

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

### @bondsports/telemetry 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @bondsports/telemetry 支持 ESM 还是 CommonJS？

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

### @bondsports/telemetry 可以商用吗？

@bondsports/telemetry 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @bondsports/telemetry 的下载量有多少？

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

### @bondsports/telemetry 还在维护吗？

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