@drazke/instrumentation-confluent-kafka-javascript

中文文档
1.0.0发布于 2025/10/23Apache-2.0TypeScriptCommonJS近 30 天下载 4038

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

中文使用文档
文档目录9 节
  1. 安装
  2. 支持的版本
  3. 使用量
  4. 仪器选项
  5. 语义公约
  6. 泉水喷出
  7. 已收集属性
  8. 有用链接
  9. 许可证

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

NPM Published Version Apache License

灵感来自 @eqxjs/kafka-server-node-rdkafka 财务报告和审定财务报表 @opentelemetry/instrumentation-kafkajs

本模块为下列人员提供自动仪器: @confluentinc/kafka-javascript 软件包,可以使用 @opentelemetry/sdk-trace-node 软件包,并包含在 @opentelemetry/auto-instrumentations-node 捆绑.

如果总安装尺寸不受限制,建议使用 @opentelemetry/auto-instrumentations-node 捆绑在一起 @ opletemetry/ sdk- 节点 对于最无缝的仪器体验.

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

安装

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

支持的版本

使用量

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
    }),
  ],
});

仪器选项

您可以设置如下:

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

语义公约

此软件包使用 @opentelemetry/semantic-conventions 版本 1.30+,执行语义公约 1.3.0.0版本 翻译:

泉水喷出

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。 。 。 . 说明: 仅供生产者使用.

许可证

Apache 2. 0 - 见 自由主义 更多信息.

版本与发布记录

@drazke/instrumentation-confluent-kafka-javascript 共发布 8 个版本,首次发布于 2025/06/30;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.0latest2025/10/231.1 年前
0.2.12025/10/201.1 年前
0.2.02025/07/171.3 年前
0.1.42025/07/171.3 年前
0.1.32025/07/011.4 年前
0.1.22025/07/011.4 年前

关于 @drazke/instrumentation-confluent-kafka-javascript 的常见问题

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