Skip to content
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

fix(kafka): enforced 'string' format for Kafka trace headers and removed 'binary' support #1296

Merged
merged 7 commits into from
Sep 10, 2024

Conversation

aryamohanan
Copy link
Contributor

@aryamohanan aryamohanan commented Aug 29, 2024

Kafka header migration phase-2

  • Always send Kafka trace correlation headers in  format 'string' 

  • Remove the ability to configure the header format

  • Remove the code associated with sending headers in format 'binary' or sending 'both' formats.

Tasks

Post Release

refs https://jsw.ibm.com/browse/INSTA-809

This PR should merge against V4 branch.

@aryamohanan aryamohanan changed the base branch from v4 to main August 29, 2024 09:36
@aryamohanan aryamohanan changed the base branch from main to v4 September 9, 2024 05:55
@aryamohanan aryamohanan marked this pull request as ready for review September 9, 2024 07:57
@aryamohanan aryamohanan requested a review from a team as a code owner September 9, 2024 07:57
@aryamohanan aryamohanan changed the title feat(kafka): set kafka header format 'string' by default feat(kafka): enforced 'string' format for kafka trace headers and removed 'binary' support Sep 9, 2024
Copy link
Contributor

@kirrg001 kirrg001 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find a usage of header format in packages/collector/test/announceCycle/unannounced_test.js

I find a usage of kafka binary here
packages/core/src/tracing/cls.js

@@ -364,9 +361,7 @@ mochaSuiteFn('tracing/messaging/node-rdkafka', function () {
let consumerControls;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO, the warning and debug log are related to the Kafka header format configuration option. Since the logWarningForKafkaHeaderFormat method has been removed from this PR, these comments are no longer necessary in the tests.

@kirrg001
Copy link
Contributor

kirrg001 commented Sep 9, 2024

How about we separate the tasks in https://jsw.ibm.com/browse/INSTA-786?

  • Undone
  • Done

@aryamohanan aryamohanan changed the base branch from v4 to main September 9, 2024 09:39
Copy link
Contributor

@kirrg001 kirrg001 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM ♡

Commit message issue:
Please add "BREAKING CHANGE" in the commit body.
See convention.

IMO this is not a feature. Its a fix.

fix(kafka): removed binary trace header support
refs X

BREAKING CHANGE

@kirrg001
Copy link
Contributor

@aryamohanan Please change the target branch to v4!

@kirrg001
Copy link
Contributor

kirrg001 commented Sep 10, 2024

I am missing one important task:
- [ ] Update our docs layer page with the new layer arn

Wrong PR

❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️ ❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️ ❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️ ❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️ ❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️ ❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️ ❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️ ❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️ ❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️ ❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️ ❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️ ❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️ ❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️❤️

@aryamohanan aryamohanan changed the base branch from main to v4 September 10, 2024 14:28
@aryamohanan aryamohanan changed the base branch from v4 to main September 10, 2024 14:41
@aryamohanan aryamohanan changed the title feat(kafka): enforced 'string' format for kafka trace headers and removed 'binary' support fix(kafka): enforced 'string' format for Kafka trace headers and removed 'binary' support Sep 10, 2024
@aryamohanan aryamohanan changed the base branch from main to v4 September 10, 2024 15:32
@aryamohanan aryamohanan merged commit 95d3002 into v4 Sep 10, 2024
1 check passed
@aryamohanan aryamohanan deleted the kafka-migration branch September 10, 2024 15:41
aryamohanan added a commit that referenced this pull request Sep 11, 2024
…d binary support (#1296)

BREAKING CHANGE:
- Removed the ability to configure the header format; headers will always be sent in 'string' format.
- Removed support for 'binary' format and code related to sending headers in 'binary' or 'both' formats.
refs INSTA-809
aryamohanan added a commit that referenced this pull request Sep 25, 2024
…d binary support (#1296)

BREAKING CHANGE:
- Removed the ability to configure the header format; headers will always be sent in 'string' format.
- Removed support for 'binary' format and code related to sending headers in 'binary' or 'both' formats.
refs INSTA-809
aryamohanan added a commit that referenced this pull request Sep 30, 2024
…d binary support (#1296)

BREAKING CHANGE:
- Removed the ability to configure the header format; headers will always be sent in 'string' format.
- Removed support for 'binary' format and code related to sending headers in 'binary' or 'both' formats.
refs INSTA-809
abhilash-sivan pushed a commit that referenced this pull request Sep 30, 2024
…d binary support (#1296)

BREAKING CHANGE:
- Removed the ability to configure the header format; headers will always be sent in 'string' format.
- Removed support for 'binary' format and code related to sending headers in 'binary' or 'both' formats.
refs INSTA-809
aryamohanan added a commit that referenced this pull request Oct 7, 2024
…d binary support (#1296)

BREAKING CHANGE:
- Removed the ability to configure the header format; headers will always be sent in 'string' format.
- Removed support for 'binary' format and code related to sending headers in 'binary' or 'both' formats.
refs INSTA-809
@aryamohanan aryamohanan mentioned this pull request Oct 10, 2024
20 tasks
aryamohanan added a commit that referenced this pull request Oct 14, 2024
…d binary support (#1296)

BREAKING CHANGE:
- Removed the ability to configure the header format; headers will always be sent in 'string' format.
- Removed support for 'binary' format and code related to sending headers in 'binary' or 'both' formats.
refs INSTA-809
aryamohanan added a commit that referenced this pull request Oct 14, 2024
…d binary support (#1296)

BREAKING CHANGE:
- Removed the ability to configure the header format; headers will always be sent in 'string' format.
- Removed support for 'binary' format and code related to sending headers in 'binary' or 'both' formats.
refs INSTA-809
aryamohanan added a commit that referenced this pull request Oct 14, 2024
…d binary support (#1296)

BREAKING CHANGE:
- Removed the ability to configure the header format; headers will always be sent in 'string' format.
- Removed support for 'binary' format and code related to sending headers in 'binary' or 'both' formats.
refs INSTA-809
aryamohanan added a commit that referenced this pull request Oct 14, 2024
…d binary support (#1296)

BREAKING CHANGE:
- Removed the ability to configure the header format; headers will always be sent in 'string' format.
- Removed support for 'binary' format and code related to sending headers in 'binary' or 'both' formats.
refs INSTA-809
aryamohanan added a commit that referenced this pull request Oct 18, 2024
…d binary support (#1296)

BREAKING CHANGE:
- Removed the ability to configure the header format; headers will always be sent in 'string' format.
- Removed support for 'binary' format and code related to sending headers in 'binary' or 'both' formats.
refs INSTA-809
aryamohanan added a commit that referenced this pull request Oct 21, 2024
…d binary support (#1296)

BREAKING CHANGE:
- Removed the ability to configure the header format; headers will always be sent in 'string' format.
- Removed support for 'binary' format and code related to sending headers in 'binary' or 'both' formats.
refs INSTA-809
aryamohanan added a commit that referenced this pull request Oct 22, 2024
…d binary support (#1296)

BREAKING CHANGE:
- Removed the ability to configure the header format; headers will always be sent in 'string' format.
- Removed support for 'binary' format and code related to sending headers in 'binary' or 'both' formats.
refs INSTA-809
aryamohanan added a commit that referenced this pull request Oct 23, 2024
…d binary support (#1296)

BREAKING CHANGE:
- Removed the ability to configure the header format; headers will always be sent in 'string' format.
- Removed support for 'binary' format and code related to sending headers in 'binary' or 'both' formats.
refs INSTA-809
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants