# @opentelemetry/instrumentation-kafkajs > OpenTelemetry instrumentation for `kafkajs` messaging client for Apache Kafka Latest version **0.32.0** (published 2026-10-06) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install @opentelemetry/instrumentation-kafkajs pnpm add @opentelemetry/instrumentation-kafkajs yarn add @opentelemetry/instrumentation-kafkajs bun add @opentelemetry/instrumentation-kafkajs ``` ## Health **Score 70/100 (B)** — status: active. Positive: has types; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score. Warnings: low downloads; no esm support; pre 1.0. ## Facts | | | |---|---| | Version | 0.32.0 | | Published | 2026-10-06 | | First published | 2024-05-17 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | bundled | | Module format | CommonJS | | Node | ^18.19.0 \|\| >=20.6.0 | | Dependencies | 2 | | Unpacked size | 129.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Provenance | attested (GitHub Actions) | | GitHub stars | 931 | | Author | OpenTelemetry Authors | | Maintainers | dyladan, pichlermarc, overbalance, npmjs-account, trentm, martinkuba | | Keywords | kafkajs, instrumentation, nodejs, opentelemetry, profiling, tracing | ## Links - npm: https://www.npmjs.com/package/@opentelemetry/instrumentation-kafkajs - Repository: https://github.com/open-telemetry/opentelemetry-js-contrib - Homepage: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-kafkajs#readme - Issues: https://github.com/open-telemetry/opentelemetry-js-contrib/issues - npm.io page: https://npm.io/package/@opentelemetry/instrumentation-kafkajs ## Dependencies (2) - [@opentelemetry/instrumentation](https://npm.io/package/@opentelemetry/instrumentation.md) ^0.223.0 - [@opentelemetry/semantic-conventions](https://npm.io/package/@opentelemetry/semantic-conventions.md) ^1.30.0 ## Recent versions - 0.32.0 (latest) — 2026-10-06 - 0.31.0 — 2026-08-31 - 0.30.0 — 2026-07-23 - 0.29.0 — 2026-07-03 - 0.28.0 — 2026-06-11 - 0.27.0 — 2026-05-13 - 0.26.0 — 2026-05-06 - 0.25.0 — 2026-04-29 - 0.24.0 — 2026-04-17 - 0.23.0 — 2026-03-26 - 0.22.0 — 2026-03-04 - 0.21.0 — 2026-02-17 - 0.20.0 — 2026-01-22 - 0.19.0 — 2026-01-15 - 0.18.1 — 2025-12-17 - … 24 more at https://npm.io/package/@opentelemetry/instrumentation-kafkajs/versions ## README # OpenTelemetry `kafkajs` Instrumentation for Node.js [![NPM Published Version][npm-img]][npm-url] [![Apache License][license-image]][license-image] This module provides automatic instrumentation for the [`kafkajs`](https://www.npmjs.com/package/kafkajs) package. If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](https://www.npmjs.com/package/@opentelemetry/sdk-node) for the most seamless instrumentation experience. Compatible with OpenTelemetry JS API and SDK `1.0+`. ## Installation ```bash npm install --save @opentelemetry/instrumentation-kafkajs ``` ### Supported versions - [`kafkajs`](https://www.npmjs.com/package/kafkajs) versions `>=0.3.0 <3` ## Usage ```js const { NodeSDK } = require('@opentelemetry/sdk-node'); const { KafkaJsInstrumentation } = require('@opentelemetry/instrumentation-kafkajs'); const sdk = new NodeSDK({ instrumentations: [ new KafkaJsInstrumentation({ // see below for available configuration }), ], }); sdk.start(); process.once('beforeExit', async () => { await sdk.shutdown(); }); ``` ### Instrumentation Options You can set the following: | Options | Type | Description | | -------------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------- | | `producerHook` | `KafkaProducerCustomAttributeFunction` | Function called before a producer message is sent. Allows for adding custom attributes to the span. | | `consumerHook` | `KafkaConsumerCustomAttributeFunction` | Function called before a consumer message is processed. Allows for adding custom attributes to the span. | ## Semantic Conventions This package uses `@opentelemetry/semantic-conventions` version `1.30+`, which implements Semantic Convention [Version 1.30.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.30.0/docs/README.md) ### Spans Emitted | KafkaJS Object | Action | Span Kind | Span Name | Operation Type / Name | | -------------- | -------------------------- | --------- | -------------------------- | --------------------- | | Consumer | `eachBatch` | Client | `poll ` | `receive` / `poll` | | Consumer | `eachBatch`, `eachMessage` | Consumer | `process ` [1] | `process` / `process` | | Producer | `send` | Producer | `send ` | `send` / `send` | **[1] `process `:** In the context of `eachBatch`, this span will be emitted for each message in the batch but the timing (start, end, duration) will reflect the timing of the batch. ### Metrics Emitted | KafkaJS Object | Metric Name | Short Description | | --------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------ | | Consumer | `messaging.process.duration` | Duration of processing operation. [1] | | Consumer | `messaging.client.consumed.messages` | Number of messages that were delivered to the application. | | Consumer and Producer | `messaging.client.operation.duration` | Number of messages that were delivered to the application. (Only emitted for kafkajs@1.5.0 and later.) | | Producer | `messaging.client.sent.messages` | Number of messages producer attempted to send to the broker. | **[1] `messaging.process.duration`:** In the context of `eachBatch`, this metric will be emitted once for each message but the value reflects the duration of the entire batch. ### Attributes Collected These attributes are added to both spans and metrics, where possible. | Attribute | Short Description | | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `messaging.system` | An identifier for the messaging system being used (i.e. `"kafka"`). | | `messaging.destination.name` | The message destination name. | | `messaging.operation.type` | A string identifying the type of messaging operation. | | `messaging.operation.name` | The system-specific name of the messaging operation. | | `messaging.operation.name` | The system-specific name of the messaging operation. | | `messaging.kafka.message.key` | A stringified value representing the key of the Kafka message (if present). | | `messaging.kafka.message.tombstone` | A boolean that is true if the message is a tombstone. | | `messaging.kafka.offset` | The offset of a record in the corresponding Kafka partition. | | `messaging.kafka.cluster.id` | The Kafka cluster id, read from the broker metadata kafkajs's own producer/consumer already fetch — no separate connection is opened. On consumer spans this is always present once messages are flowing, since kafkajs refreshes metadata before it can fetch any record. On producer spans it's best-effort: omitted on a freshly created producer's first `send`/`sendBatch` (metadata isn't fetched until then), present on every send after. Also omitted if the broker predates KIP-78 (cluster id support). | | `messaging.destination.partition.id` | The identifier of the partition messages are sent to or received from, unique within the `messaging.destination.name`. **Note:** only available on producer spans. | ## Useful links - For more information on OpenTelemetry, visit: - For more about OpenTelemetry JavaScript: - For help or feedback on this project, join us in [GitHub Discussions][discussions-url] ## License Apache 2.0 - See [LICENSE][license-url] for more information. [discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions [license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat [npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-kafkajs [npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-kafkajs.svg --- _Source: https://npm.io/package/@opentelemetry/instrumentation-kafkajs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._