# @drazke/instrumentation-confluent-kafka-javascript 中文文档

规范地址：https://npmcn.com/package/%40drazke/instrumentation-confluent-kafka-javascript/

版本：1\.0\.0
npm 元数据更新时间：2025-10-23T11:44:36.491Z
中文译文更新时间：2026-11-12T22:21:08.206Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40drazke/instrumentation-confluent-kafka-javascript
原文对照：https://npmcn.com/package/%40drazke/instrumentation-confluent-kafka-javascript/?lang=original
项目主页：https://github.com/Drazke/instrumentation-confluent-kafka-javascript/tree/main/#readme
源码仓库：https://github.com/Drazke/instrumentation-confluent-kafka-javascript

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

- 包体积（解压后）：60.3 kB，16 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：^18\.19\.0 \|\| \>=20\.6\.0
- 运行依赖：2 个
- peer 依赖：@opentelemetry/api ^1\.3\.0
- 首次发布：2025-06-29T21:36:40.048Z
- 最新版本发布：2025-10-23T11:44:36.288Z
- 近 30 天下载量：4038（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 0 个）

## 中文简介

用于 OpenTelemet 仪器 `confluent-kafka-javascript` apache Kafka 信件客户端

## 安装

```sh
npm install @drazke/instrumentation-confluent-kafka-javascript
```

也可以使用：`pnpm add @drazke/instrumentation-confluent-kafka-javascript`、`yarn add @drazke/instrumentation-confluent-kafka-javascript`、`bun add @drazke/instrumentation-confluent-kafka-javascript`

## README

# 打开几何 `confluent-kafka-javascript` 节点J的仪器

[![NPM Published Version](https://badge.fury.io/js/%40drazke%2Finstrumentation-confluent-kafka-javascript.svg)](https://www.npmjs.com/package/@drazke/instrumentation-confluent-kafka-javascript) [![Apache License](https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat)](https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat)

灵感来自 [`@eqxjs/kafka-server-node-rdkafka`](https://www.npmjs.com/package/@eqxjs/kafka-server-node-rdkafka) 财务报告和审定财务报表 [`@opentelemetry/instrumentation-kafkajs`](https://www.npmjs.com/package/@opentelemetry/instrumentation-kafkajs)

本模块为下列人员提供自动仪器: [`@confluentinc/kafka-javascript`](https://www.npmjs.com/package/@confluentinc/kafka-javascript) 软件包,可以使用 [`@opentelemetry/sdk-trace-node`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node) 软件包,并包含在 [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) 捆绑.

如果总安装尺寸不受限制,建议使用 [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) 捆绑在一起 [@ opletemetry/ sdk- 节点](https://npmcn.com/package/%40drazke/instrumentation-confluent-kafka-javascript/%60https://www.npmjs.com/package/@opentelemetry/sdk-node%60) 对于最无缝的仪器体验.

与 OpenTeleometry JS API 和 SDK 兼容 `1.0+`。 。 。 .

## 安装

```bash
npm install --save @drazke/instrumentation-confluent-kafka-javascript
```

### 支持的版本

-   [`@confluentinc/kafka-javascript`](https://www.npmjs.com/package/@confluentinc/kafka-javascript) 版本 `>=1.3.0`

## 使用量

```js
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const {
  ConfluentKafkaInstrumentation,
} = require('@drazke/instrumentation-confluent-kafka-javascript');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');

const provider = new NodeTracerProvider();
provider.register();

registerInstrumentations({
  instrumentations: [
    new ConfluentKafkaInstrumentation({
      // see below for available configuration
    }),
  ],
});
```

### 仪器选项

您可以设置如下:

| 选项 | 类型 | 说明 |
| --- | --- | --- |
| `producerHook` | `KafkaProducerCustomAttributeFunction` | 在发送制作人消息前调用函数 。 允许在跨度上添加自定义属性 . |
| `consumerHook` | `KafkaConsumerCustomAttributeFunction` | 在处理消费者信息之前调用函数 。 允许在跨度上添加自定义属性 . |

## 语义公约

此软件包使用 `@opentelemetry/semantic-conventions` 版本 `1.30+`,执行语义公约 [1.3.0.0版本 翻译:](https://github.com/open-telemetry/semantic-conventions/blob/v1.30.0/docs/README.md)

### 泉水喷出

| KafkaJS 对象 | 行动 | Span 宽度 | 宽边名 | 操作类型/ 名称 |
| --- | --- | --- | --- | --- |
| 消费者 | `data` | 消费者 | `<topic-name>` | `receive` 编号 : `received` |
| 制作人 | `delivery-report` | 制作人 | `<topic-name>` | `deliver` 编号 : `delivery-report` |
| 制作人 | `produce` | 制作人 | `<topic-name>` | `send` 编号 : `produce` |

### 已收集属性

这些属性尽可能地被添加到跨度和度量中.

| 属性 | 简短说明 |
| --- | --- |
| `messaging.system` | 正在使用的邮件系统标识符(即:. `"kafka"`) (中文(简体) ). |
| `messaging.destination.name` | 消息目的地名称 . |
| `messaging.operation.type` | 一个字符串来识别消息操作的类型 . |
| `messaging.operation.name` | 消息操作的系统特有名称. |
| `messaging.client.id` | 客户身份. |
| `messaging.kafka.message.key` | 代表 Kafka 信件密钥的字符串值( 如果存在 ) . |
| `messaging.kafka.message.tombstone` | 如果讯息是墓碑的话. |
| `messaging.kafka.offset` | 相应卡夫卡分区记录的相抵. |
| `messaging.destination.partition.id` | 分区信件的标识符发送到或接收到,在 `messaging.destination.name`。 。 。 . **说明:** 仅供生产者使用. |

## 有用链接

-   关于OpenTeleometry的更多信息,请访问: [https://opentelemetry.io/ 互联网档案馆的存檔,存档日期2013-12-02](https://opentelemetry.io/)

## 许可证

Apache 2. 0 - 见 [自由主义](https://github.com/drazke/opentelemetry-js-contrib/blob/main/LICENSE) 更多信息.

## 常见问题

### @drazke/instrumentation-confluent-kafka-javascript 是什么？

用于 OpenTelemet 仪器 confluent-kafka-javascript apache Kafka 信件客户端

### 如何安装 @drazke/instrumentation-confluent-kafka-javascript？

在项目目录运行 npm install @drazke/instrumentation-confluent-kafka-javascript，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@opentelemetry/api（^1\.3\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @drazke/instrumentation-confluent-kafka-javascript 支持 TypeScript 吗？

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

### @drazke/instrumentation-confluent-kafka-javascript 支持 ESM 还是 CommonJS？

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

### @drazke/instrumentation-confluent-kafka-javascript 需要什么版本的 Node\.js？

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

### @drazke/instrumentation-confluent-kafka-javascript 可以商用吗？

@drazke/instrumentation-confluent-kafka-javascript 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @drazke/instrumentation-confluent-kafka-javascript 的下载量有多少？

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

### @drazke/instrumentation-confluent-kafka-javascript 还在维护吗？

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