open-telemetry
OpenTelemetry kafkajs Instrumentation for Node.js
This module provides automatic instrumentation for the kafkajs package, which may be loaded using the @opentelemetry/sdk-trace-node package and is included in the @opentelemetry/auto-instrumentations-node bundle.
If total installation size is not constrained, it is recommended to use the @opentelemetry/auto-instrumentations-node bundle with @opentelemetry/sdk-node for the most seamless instrumentation experience.
Compatible with OpenTelemetry JS API and SDK 1.0+.
Installation
npm install --save @opentelemetry/instrumentation-kafkajsSupported versions
kafkajsversions>=0.1.0 <3
Usage
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { KafkaJsInstrumentation } = require('@opentelemetry/instrumentation-kafkajs');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const provider = new NodeTracerProvider();
provider.register();
registerInstrumentations({
instrumentations: [
new KafkaJsInstrumentation({
// see below for available configuration
}),
],
});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.24+, which implements Semantic Convention Version 1.7.0
Attributes collected:
| Attribute | Short Description |
|---|---|
messaging.system |
An identifier for the messaging system being used. |
messaging.destination |
The message destination name. |
messaging.operation |
A string identifying the kind of messaging operation. |
Useful links
- For more information on OpenTelemetry, visit: https://opentelemetry.io/
- For more about OpenTelemetry JavaScript: https://github.com/open-telemetry/opentelemetry-js
- For help or feedback on this project, join us in GitHub Discussions
License
Apache 2.0 - See LICENSE for more information.