Skip to content

feat(instrumentation-kafkajs)!: add .tav.yml and narrow support range to (>=0.3.0 <3) #2758

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Mar 19, 2025

Conversation

AvihuHenya
Copy link
Contributor

Which problem is this PR solving?

KafkaJS versions below 0.3.0 do not properly export Kafka from the main file, causing errors when trying to instrument applications using it.

This PR:

  • Adds .tav.yml to enable testing across multiple KafkaJS versions.
  • Updates supported KafkaJS versions in both .tav.yml and instrumentation.ts to prevent compatibility issues.

Short description of the changes

  • Updated KafkaJS version support: Initially, KafkaJS instrumentation supported >=0.1.0 <3. However, errors were found in versions <0.3.0 due to the Kafka object not being properly exported in the main file, causing issues when trying to instrument applications using it.
  • Added .tav.yml file to enable automated testing across KafkaJS versions (>=0.3.0 <3)
  • Updated instrumentation.ts to enforce the new version range (>=0.3.0 <3), ensuring compatibility and preventing instrumentation failures.

@AvihuHenya AvihuHenya requested a review from a team as a code owner March 17, 2025 13:33
Copy link

linux-foundation-easycla bot commented Mar 17, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

@github-actions github-actions bot requested a review from seemk March 17, 2025 13:34
@AvihuHenya AvihuHenya changed the title Kafkajs tav file feat(instrumentation-kafkajs)!: add .tav.yml and update supported versions Mar 17, 2025
Copy link

codecov bot commented Mar 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.56%. Comparing base (a7763a1) to head (34ef474).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2758      +/-   ##
==========================================
+ Coverage   90.51%   90.56%   +0.04%     
==========================================
  Files         166      166              
  Lines        8020     8020              
  Branches     1533     1533              
==========================================
+ Hits         7259     7263       +4     
+ Misses        761      757       -4     

see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pichlermarc pichlermarc changed the title feat(instrumentation-kafkajs)!: add .tav.yml and update supported versions feat(instrumentation-kafkajs)!: add .tav.yml and clarify that only 0.3.0 and later are supported Mar 18, 2025
@pichlermarc pichlermarc changed the title feat(instrumentation-kafkajs)!: add .tav.yml and clarify that only 0.3.0 and later are supported feat(instrumentation-kafkajs)!: add .tav.yml and narrow support range to (>=0.3.0 <3) Mar 18, 2025
@pichlermarc pichlermarc merged commit 5837997 into open-telemetry:main Mar 19, 2025
10 checks passed
@dyladan dyladan mentioned this pull request Mar 19, 2025
deejay1 pushed a commit to deejay1/opentelemetry-js-contrib that referenced this pull request Apr 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants