@bondsports/telemetry

中文文档
1.3.0发布于 2026/04/23ISCTypeScriptCommonJS近 30 天下载 2117

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

中文使用文档
文档目录9 节
  1. 动机
  2. 实例
  3. 追踪
  4. 计量
  5. Trace-ID 响应信头( Express Misterware)
  6. 配置
  7. 通用配置
  8. 追踪配置
  9. 计量配置

遥测

动机

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

实例

以下是追踪和衡量尺度的简短例子。 现有更多实例 示例文件夹,以及各种开口遥测重置.

追踪

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

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'));

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

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);
...

计量

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

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-Id32-Char 十六进制(W3C)trace_id 应用程序日志中的字段
Trace_Id32-Char 十六进制(W3C)trace_id 应用程序日志中的字段
X-Amzn-Trace-IdRoot=1-<8hex>-<24hex> (AWS X-Ray) (美国英语)原始内容 X-Amzn-Trace-Id 存储在 AWS ALB 访问日志/ OpenSearch 中的页眉

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

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 共发布 30 个版本,首次发布于 2022/07/31;过去 12 个月发布了 3 个版本。

版本发布日期距今
1.3.0latest2026/04/236 个月前
1.2.32026/04/216 个月前
1.2.02026/04/216 个月前
1.1.62024/12/041.9 年前
1.1.6-test-new-trace-id-middleware2024/12/041.9 年前
1.1.52024/08/222 年前

其他发布通道:ido → 1.1.3-ido。

关于 @bondsports/telemetry 的常见问题

@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 和提交记录判断。