opentelemetry-instrumentation-kafkajs

v0.41.0

open telemetry instrumentation for the `kafkajs` kafka client For more information about how to use this package see README

Latest version published 6 months ago

License: Apache-2.0

NPM

GitHub

Package Health Score

53 / 100

security
No known security issues
popularity
Recognized
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.41.0	\|	05/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.40.0	\|	10/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.35.1	\|	07/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.39.1	\|	07/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.34.0	\|	11/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (85,174)

GitHub Stars: 172
Forks: 40
Contributors: 30

Direct Usage Popularity

The npm package opentelemetry-instrumentation-kafkajs receives a total of 85,174 downloads a week. As such, we scored opentelemetry-instrumentation-kafkajs popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package opentelemetry-instrumentation-kafkajs, we found that it has been starred 172 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 30
Funding: No

With more than 10 contributors for the opentelemetry-instrumentation-kafkajs repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like opentelemetry-instrumentation-kafkajs is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

archived

Commit Frequency

Open Issues: 20
Open PR: 4
Last Release: 6 months ago
Last Commit: 6 months ago

Further analysis of the maintenance status of opentelemetry-instrumentation-kafkajs based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

We found that opentelemetry-instrumentation-kafkajs demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 4 years
Dependencies: 2 Direct
Versions: 70
Install Size: 53.4 kB
Dist-tags: 3
# of Files: 18
Maintainers: 1
TS Typings: No

opentelemetry-instrumentation-kafkajs has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

OpenTelemetry kafkajs Instrumentation for Node.js

This module provides automatic instrumentation for kafkajs.

Installation

npm install --save opentelemetry-instrumentation-kafkajs

Usage

For further automatic instrumentation instruction see the @opentelemetry/instrumentation package.

const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const { KafkaJsInstrumentation } = require('opentelemetry-instrumentation-kafkajs');

const tracerProvider = new NodeTracerProvider({
  // be sure to disable old plugin
  plugins: {
    kafkajs: { enabled: false, path: 'opentelemetry-plugin-kafkajs' }
  }
});

registerInstrumentations({
  tracerProvider,
  instrumentations: [
    new KafkaJsInstrumentation({
      // see under for available configuration
    })
  ]
});

kafkajs Instrumentation Options

kafkajs instrumentation has few options available to choose from. You can set the following:

Options	Type	Description
`producerHook`	`KafkaProducerCustomAttributeFunction`	Hook called before producer message is sent, which allow to add custom attributes to span.
`consumerHook`	`KafkaConsumerCustomAttributeFunction`	Hook called before consumer message is processed, which allow to add custom attributes to span.
`moduleVersionAttributeName`	`string`	If passed, a span attribute will be added to all spans with key of the provided `moduleVersionAttributeName` and value of the patched module version

This extension (and many others) was developed by Aspecto with ❤️

opentelemetry-instrumentation-kafkajs dependencies

@opentelemetry/instrumentation @opentelemetry/semantic-conventions

opentelemetry-instrumentation-kafkajs development dependencies

@opentelemetry/api @opentelemetry/contrib-test-utils @opentelemetry/sdk-trace-base @types/mocha aspecto-opentelemetry-instrumentation-mocha expect kafkajs mocha ts-node typescript

FAQs

What is opentelemetry-instrumentation-kafkajs?

open telemetry instrumentation for the `kafkajs` kafka client. Visit Snyk Advisor to see a full health score report for opentelemetry-instrumentation-kafkajs, including popularity, security, maintenance & community analysis.

Is opentelemetry-instrumentation-kafkajs popular?

The npm package opentelemetry-instrumentation-kafkajs receives a total of 85,174 weekly downloads. As such, opentelemetry-instrumentation-kafkajs popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is opentelemetry-instrumentation-kafkajs well maintained?

We found indications that opentelemetry-instrumentation-kafkajs is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is opentelemetry-instrumentation-kafkajs safe to use?

The npm package opentelemetry-instrumentation-kafkajs was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 13 November-2024, at 04:46 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP