# @dazn/lambda-powertools-correlation-ids 中文文档

规范地址：https://npmcn.com/package/%40dazn/lambda-powertools-correlation-ids/

版本：1\.28\.1
npm 元数据更新时间：2025-12-04T09:09:02.728Z
中文译文更新时间：2026-11-11T16:42:59.331Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40dazn/lambda-powertools-correlation-ids
原文对照：https://npmcn.com/package/%40dazn/lambda-powertools-correlation-ids/?lang=original

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

- 包体积（解压后）：13.4 kB，7 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2019-07-24T09:47:03.111Z
- 最新版本发布：2020-12-10T13:06:42.156Z
- 近 30 天下载量：114766（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

记录相关ID的模块

## 安装

```sh
npm install @dazn/lambda-powertools-correlation-ids
```

也可以使用：`pnpm add @dazn/lambda-powertools-correlation-ids`、`yarn add @dazn/lambda-powertools-correlation-ids`、`bun add @dazn/lambda-powertools-correlation-ids`

## README

# 羊肉-功用工具-指针

一个用于记录相关ID的帮助模块.

主要特点:

-   允许您获取、更新和删除相关ID
    
-   尊重相关标识的常规,即:. `x-correlation-`
    
-   手动启用/ 无法调试日志( M)`debug-log-enabled`由其它/下游中件取出
    
-   允许您存储多个相关ID,从而允许您 _关联_ 多个维度的日志(例如: `x-correlation-user-id`,或 `x-correlation-order-id`页:1
    

## 开始

从国家预防机制安装: `npm install @dazn/lambda-powertools-correlation-ids`

## API 密码

```js
const CorrelationIds = require('@dazn/lambda-powertools-correlation-ids')

// automatically inserts 'x-correlation-' prefix if not provided
CorrelationIds.set('id', '12345678') // records id as x-correlation-id
CorrelationIds.set('x-correlation-username', 'theburningmonk') // records as x-correlation-username

// Manully enable debug logging (debug-log-enabled)
CorrelationIds.debugLoggingEnabled = true

const myCorrelationIds = CorrelationIds.get()
// {
//   'x-correlation-id': '12345678',
//   'x-correlation-username': 'theburningmonk',
//   'debug-log-enabled': 'true'
// }

CorrelationIds.clearAll() // removes all recorded correlation IDs
CorrelationIds.replaceAllWith({  // bypasses the 'x-correlation-' convention
  'debug-log-enabled': 'true',
  'User-Agent': 'jest test'
})

// Disable debug logging
CorrelationIds.debugLoggingEnabled = false
```

在实践上,你可能只需要 `set` 当您想要从您的功能中记录相关ID时.

中间的软件, `@dazn/lambda-powertools-middleware-correlation-ids`,将自动捕捉所支持的事件源引用事件的相关ID:

-   API 网关( 通过 HTTP 信头)
    
-   Kinesis(通过JSON有效载荷)
    
-   SNS( 通过信件属性)
    
-   与特别领域有关的引用事件 `__context__` (这就是我们如何给他们注入步骤函数 和Lambda客户端下面)
    

其他动力工具将使用 `get` 使用相关标识:

-   `@dazn/lambda-powertools-logger` 在日志中包含已记录的相关ID
    
-   `@dazn/lambda-powertools-http-client` 当您提出 HTTP 请求时, 包含作为 HTTP 头的已记录的相关ID
    
-   `@dazn/lambda-powertools-sns-client` 当您向 SNS 发布消息时, 包含作为 SNS 消息属性的已记录关联ID( ie) . `SNS.publish`(中文(简体) )
    
-   `@dazn/lambda-powertools-kinesis-client` 当您向 Kinesis( ie) 发布事件时, 将记录的相关ID作为事件有效载荷的一部分. `Kinesis.putRecord` 财务报告和审定财务报表 `Kinesis.putRecords`(中文(简体) )
    
-   `@dazn/lambda-powertools-step-functions-client` 当您开始 Step 函数执行( e. `SFN.startExecution`(中文(简体) )
    
-   `@dazn/lambda-powertools-lambda-client` 当您直接引用了 Lambda 函数( e. `Lambda.invoke` 财务报告和审定财务报表 `Lambda.invokeAsync`(中文(简体) )

## 常见问题

### @dazn/lambda-powertools-correlation-ids 是什么？

记录相关ID的模块

### 如何安装 @dazn/lambda-powertools-correlation-ids？

在项目目录运行 npm install @dazn/lambda-powertools-correlation-ids，或使用 pnpm add / yarn add / bun add。

### @dazn/lambda-powertools-correlation-ids 支持 TypeScript 吗？

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

### @dazn/lambda-powertools-correlation-ids 支持 ESM 还是 CommonJS？

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

### @dazn/lambda-powertools-correlation-ids 可以商用吗？

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

### @dazn/lambda-powertools-correlation-ids 的下载量有多少？

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

### @dazn/lambda-powertools-correlation-ids 还在维护吗？

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