# @defra/hapi-tracing 中文文档

规范地址：https://npmcn.com/package/%40defra/hapi-tracing/

版本：1\.30\.2
npm 元数据更新时间：2026-11-03T16:18:00.923Z
中文译文更新时间：2026-11-11T21:04:01.748Z
软件包许可：OGL-UK-3\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40defra/hapi-tracing
原文对照：https://npmcn.com/package/%40defra/hapi-tracing/?lang=original
项目主页：https://github.com/DEFRA/cdp-libraries/tree/main/packages/hapi-tracing#readme
源码仓库：https://github.com/DEFRA/cdp-libraries

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

- 包体积（解压后）：22.8 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22
- 运行依赖：0 个
- 首次发布：2024-12-10T13:16:40.505Z
- 最新版本发布：2026-11-03T16:18:00.586Z
- 近 30 天下载量：66752（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：31（近 12 个月 3 个）

## 中文简介

用于传播微量 id 头的 hapi 插件

## 安装

```sh
npm install @defra/hapi-tracing
```

也可以使用：`pnpm add @defra/hapi-tracing`、`yarn add @defra/hapi-tracing`、`bun add @defra/hapi-tracing`

## README

# 哈皮追踪

Hapi Tracking是一个Hapi插件,用于在请求的生命周期中提供选定的信头,而无需 手动将它们或请求对象传递到每个呼叫中. 主要用途是宣传追踪信头,以便登入并传送到 其他电话.

-   [这有什么用](https://npmcn.com/package/%40defra/hapi-tracing/#readme-what-does-this-do)
-   [这不起作用](https://npmcn.com/package/%40defra/hapi-tracing/#readme-what-this-does-not-do)
-   [安装](https://npmcn.com/package/%40defra/hapi-tracing/#readme-installing)
-   [使用量](https://npmcn.com/package/%40defra/hapi-tracing/#readme-usage)
    -   [注册插件](https://npmcn.com/package/%40defra/hapi-tracing/#readme-register-the-plugin)
-   [常见使用案例](https://npmcn.com/package/%40defra/hapi-tracing/#readme-common-use-cases)
    -   [作宣说头.](https://npmcn.com/package/%40defra/hapi-tracing/#readme-propagating-headers)
    -   [登录信头](https://npmcn.com/package/%40defra/hapi-tracing/#readme-logging-the-header)

## 这有什么用

Hapi Track被注册为插件. 应通过插件的选项提供特定的追踪头. 如果收到带有特定跟踪头的HTTP请求,则一旦登记,将提取头的值, 存储于 [本地同步组件](https://nodejs.org/api/async_context.html) 并在整个请求期间提供. 帮助函数 `getTraceId()` 提供对跟踪信头值的访问,而无需通过请求 对象跨越多个调用.

## 这不起作用

-   自动将跟踪ID转发到其他 HTTP 呼叫
-   自动日志跟踪ID

为支持这一点而建造的,将来可能会被添加.

## 安装

`npm install @defra/hapi-tracing`

## 使用量

图书馆由两部分组成:

1.  Hapi 插件
2.  这个 `getTraceId()` 财务报告和审定财务报表 `withTraceId` 帮助者

### 注册插件

作为创建服务器的一部分,注册capi追踪插件.

```js
import { tracing } from '@defra/hapi-tracing'

await server.register({
  plugin: tracing.plugin,
  options: { tracingHeader: 'x-your-trace-id' }
})
```

一旦注册,你就可以打电话 `getTraceId()` 在控制器内返回信头的值,如果是的话 已经传入.

例如:

```js
import { getTraceId } from '@defra/hapi-tracing'

const healthController = {
  handler: (request, h) => {
    return h.response({ message: `trace-id is ${getTraceId()}` }).code(200)
  }
}
```

要求 `getTraceId()` 不需要来自控制器。 从控制器调用的任何功能, 直接或间接可以使用.

```js
import { getTraceId } from '@defra/hapi-tracing'

const healthController = {
  handler: (request, h) => {
    doSomething()
    return h.response().code(200)
  }
}

const doSomething = () => {
  doSomethingElse()
}

const doSomethingElse = () => {
  console.log(`trace-id is still ${getTraceId()}`)
}
```

## 常见使用案例

### 作宣说头.

要追踪多个服务的请求, 您需要将追踪头转到其他通话中 作为请求的一部分.

举例来说,我们将使用节点:牵引。 不同的 HTTP 客户端可能对设置头有不同的 API , 但是 这一概念应该是一样的.

这个 `hapi-tracing` 软件包包括一个 `withTraceId` 使用跟踪头和对象名称的帮助 包含现有标题. 如果已设定了微量线标, 它会返回带有微量线标头和增加值的原始标题对象 。 如果 trackId没有设置,然后原始标题对象会被返回未修改.

```js
import { withTraceId } from '@defra/hapi-tracing'

async function getSomething() {
  return await fetch('http://localhost:8080/test', {
    method: 'get',
    headers: withTraceId('x-your-trace-id', {
      'Content-Type': 'application/json',
      'x-some-other-header': '1234'
    })
  })
}
```

### 登录信头

一些日志将自动包含原始的 HTTP 请求,其中将包括跟踪头以及任何其他 未编辑的页眉 . 举个例子,我们将使用皮诺 与ECS 物质作为我们的记录器.

```js
export const loggerOptions = {
  enabled: logConfig.enabled,
  level: 'info', // other setup
  nesting: true,
  mixin: () => {
    const mixinValues = {}
    const traceId = getTraceId()

    if (traceId) {
      mixinValues.trace = { id: traceId }
    }
    return mixinValues
  }
}

// elsewhere
const logger = pino(loggerOptions)
```

这将设定在 `trace.id` 字段在结构日志中.

## 常见问题

### @defra/hapi-tracing 是什么？

用于传播微量 id 头的 hapi 插件

### 如何安装 @defra/hapi-tracing？

在项目目录运行 npm install @defra/hapi-tracing，或使用 pnpm add / yarn add / bun add。

### @defra/hapi-tracing 支持 TypeScript 吗？

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

### @defra/hapi-tracing 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @defra/hapi-tracing 需要什么版本的 Node\.js？

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

### @defra/hapi-tracing 可以商用吗？

@defra/hapi-tracing 使用 OGL-UK-3\.0 许可。声明的许可为 OGL-UK-3\.0，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @defra/hapi-tracing 的下载量有多少？

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

### @defra/hapi-tracing 还在维护吗？

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