ticdc: support detecting the Kafka cluster version automatically #10854

wk989898 · 2024-03-27T08:40:02Z

What problem does this PR solve?

Issue Number: close #10852

What is changed and how it works?

Add Kafka version detect. Connect a broker and use ApiVersionsRequest to get ApiKeys and MaxVersion, according to MaxVersion infer the Kafka version.

Test:

ticdc instance: v8.0.0-master-dirty
pd instance:v7.6.0
tikv instance:v7.6.0
tidb instance:v7.6.0

kafka version	status
3.7.0	success
3.0.1	success
2.8.0	success
2.7.0	success
2.5.0	success
2.4.0	success
2.3.1	success
2.1.1	success
2.1.0	success
2.0.1	success
2.0.0	success
1.0.1	success
0.11.0.2	success
0.10.1	API is not supported
0.10.0	API is not supported
0.8.2	not support ApiVersionsRequest

Check List

Tests

Unit test
Integration test
Manual test (add detailed scripts or steps below)
No code

Questions

Will it cause performance regression or break compatibility?

not sure.

Do you need to update user documentation, design documentation or monitoring documentation?

no.

Release note

`None`

ti-chi-bot · 2024-03-27T08:40:12Z

Hi @wk989898. Thanks for your PR.

I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

sdojjy · 2024-03-28T01:02:55Z

pkg/sink/kafka/sarama.go

@@ -122,6 +117,28 @@ func NewSaramaConfig(ctx context.Context, o *Options) (*sarama.Config, error) {
 		return nil, cerror.WrapError(cerror.ErrKafkaInvalidConfig, err)
 	}

+	kafkaVersion, err := GetKafkaVersion(ctx, config, o)


only detect the kafka cluster version when there is no version specified by the user

detect the kafka version is necessary if the user specified an error version

sdojjy · 2024-03-28T01:06:08Z

pkg/sink/kafka/sarama.go

+	}
+	if o.IsAssignedVersion {
+		config.Version = version
+		if version.String() != kafkaVersion.String() {


according to the api version mapping, if the kafka cluster version is greater than 2.8.0, version.String() != kafkaVersion.String() is always true.

sdojjy · 2024-03-28T01:10:30Z

pkg/sink/kafka/sarama.go

+			log.Warn("Kafka fail to open broker", zap.String("addr", addrs[i]))
+			continue
+		}
+		defer func() {


do not use defer in for loop

sdojjy · 2024-03-28T01:13:18Z

pkg/sink/kafka/sarama.go

+	return sarama.V2_0_0_0, err
+}
+
+func requiredVersion(version int16) sarama.KafkaVersion {


requiredVersion is not a good name here, this function is just a version mapping.

CharlesCheung96 · 2024-03-28T08:41:41Z

pkg/sink/kafka/sarama.go

+	}
+	if o.IsAssignedVersion {
+		config.Version = version
+		if !version.IsAtLeast(sarama.V2_8_0_0) && version.String() != kafkaVersion.String() {


It is better to use constants rather than literals.

CharlesCheung96 · 2024-03-28T08:42:59Z

pkg/sink/kafka/sarama.go

+			return version, err
+		}
+	}
+	return sarama.V2_0_0_0, err


It is better to use constants rather than literals.

3AceShowHand · 2024-03-29T06:19:26Z

pkg/sink/kafka/sarama.go

+	if err != nil {
+		return nil, cerror.WrapError(cerror.ErrKafkaInvalidVersion, err)
+	}
+	if o.IsAssignedVersion {


config.Version = kafkaVersion can be set at the very first, else is redundant.

3AceShowHand · 2024-03-29T06:20:35Z

pkg/sink/kafka/sarama.go

+	var err error
+	addrs := o.BrokerEndpoints
+	if len(addrs) > 1 {
+		// Shuffle the list of addresses to randomize the order in which


Why shuffle here ?

Prevent latency from increasing when the first address is inaccessible.

ti-chi-bot · 2024-04-08T10:24:09Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 3AceShowHand, CharlesCheung96

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [3AceShowHand,CharlesCheung96]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

ti-chi-bot · 2024-04-08T10:24:10Z

[LGTM Timeline notifier]

Timeline:

2024-04-01 05:27:51.601357024 +0000 UTC m=+248933.128897563: ☑️ agreed by CharlesCheung96.
2024-04-08 10:24:09.791888507 +0000 UTC m=+871511.319429053: ☑️ agreed by 3AceShowHand.

codecov · 2024-04-22T16:39:54Z

Codecov Report

Attention: Patch coverage is 51.94805% with 37 lines in your changes are missing coverage. Please review.

Project coverage is 57.4052%. Comparing base (894b36f) to head (4c10b56).

Additional details and impacted files

Components	Coverage Δ
cdc	`61.6809% <51.9480%> (+0.0162%)`	⬆️
dm	`51.2315% <ø> (-0.0061%)`	⬇️
engine	`63.3950% <ø> (+0.0070%)`	⬆️

Flag	Coverage Δ
unit	`57.4052% <51.9480%> (+0.0086%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

@@               Coverage Diff                @@
##             master     #10854        +/-   ##
================================================
+ Coverage   57.3966%   57.4052%   +0.0086%     
================================================
  Files           851        851                
  Lines        125469     125539        +70     
================================================
+ Hits          72015      72066        +51     
- Misses        48034      48056        +22     
+ Partials       5420       5417         -3

wk989898 · 2024-04-28T06:54:33Z

/retest

ti-chi-bot · 2024-04-28T06:54:48Z

@wk989898: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

CharlesCheung96 · 2024-05-07T07:01:16Z

/retest

ti-chi-bot · 2024-05-16T08:29:45Z

In response to a cherrypick label: new pull request created to branch release-8.1: #11120.

ti-chi-bot · 2024-05-16T10:17:05Z

In response to a cherrypick label: new pull request created to branch release-7.5: #11123.

) (#11120) close #10852

) (#11123) close #10852

wk989898 added 2 commits March 27, 2024 15:49

feat: add kafka version check

8f7849b

fix typo

1b02cc0

ti-chi-bot bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 27, 2024

fix typo

b075719

sdojjy reviewed Mar 28, 2024

View reviewed changes

modify func and code style

57a178c

ti-chi-bot bot removed the do-not-merge/needs-triage-completed label Mar 28, 2024

wk989898 requested a review from sdojjy March 28, 2024 06:45

CharlesCheung96 reviewed Mar 28, 2024

View reviewed changes

3AceShowHand reviewed Mar 29, 2024

View reviewed changes

update

5cb0d36

CharlesCheung96 approved these changes Apr 1, 2024

View reviewed changes

ti-chi-bot bot added needs-1-more-lgtm Indicates a PR needs 1 more LGTM. approved labels Apr 1, 2024

fix unused param check

c397631

3AceShowHand approved these changes Apr 8, 2024

View reviewed changes

ti-chi-bot bot added the lgtm label Apr 8, 2024

ti-chi-bot bot removed the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Apr 8, 2024

wk989898 added 2 commits April 8, 2024 19:21

update test

fc56778

fix no available brokers

49f78fb

Merge branch 'pingcap:master' into kafka-version

4c10b56

ti-chi-bot bot merged commit 99d3755 into pingcap:master May 7, 2024
28 checks passed

ti-chi-bot added the needs-cherry-pick-release-8.1 Should cherry pick this PR to release-8.1 branch. label May 16, 2024

ti-chi-bot mentioned this pull request May 16, 2024

ticdc: support detecting the Kafka cluster version automatically (#10854) #11120

Merged

ti-chi-bot added the needs-cherry-pick-release-7.5 Should cherry pick this PR to release-7.5 branch. label May 16, 2024

ti-chi-bot mentioned this pull request May 16, 2024

ticdc: support detecting the Kafka cluster version automatically (#10854) #11123

Merged

ti-chi-bot bot pushed a commit that referenced this pull request May 16, 2024

ticdc: support detecting the Kafka cluster version automatically (#10854

f98b245

) (#11120) close #10852

ti-chi-bot bot pushed a commit that referenced this pull request May 17, 2024

ticdc: support detecting the Kafka cluster version automatically (#10854

e85b6d1

) (#11123) close #10852

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ticdc: support detecting the Kafka cluster version automatically #10854

ticdc: support detecting the Kafka cluster version automatically #10854

wk989898 commented Mar 27, 2024 •

edited

Loading

ti-chi-bot bot commented Mar 27, 2024

sdojjy Mar 28, 2024 •

edited

Loading

wk989898 Mar 28, 2024

sdojjy Mar 28, 2024

sdojjy Mar 28, 2024

sdojjy Mar 28, 2024

CharlesCheung96 Mar 28, 2024

CharlesCheung96 Mar 28, 2024

3AceShowHand Mar 29, 2024

3AceShowHand Mar 29, 2024

wk989898 Apr 1, 2024

ti-chi-bot bot commented Apr 8, 2024

ti-chi-bot bot commented Apr 8, 2024

codecov bot commented Apr 22, 2024 •

edited

Loading

wk989898 commented Apr 28, 2024

ti-chi-bot bot commented Apr 28, 2024

CharlesCheung96 commented May 7, 2024

ti-chi-bot commented May 16, 2024

ti-chi-bot commented May 16, 2024

ticdc: support detecting the Kafka cluster version automatically #10854

ticdc: support detecting the Kafka cluster version automatically #10854

Conversation

wk989898 commented Mar 27, 2024 • edited Loading

What problem does this PR solve?

What is changed and how it works?

Test:

Check List

Tests

Questions

Will it cause performance regression or break compatibility?

Do you need to update user documentation, design documentation or monitoring documentation?

Release note

ti-chi-bot bot commented Mar 27, 2024

sdojjy Mar 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ti-chi-bot bot commented Apr 8, 2024

ti-chi-bot bot commented Apr 8, 2024

[LGTM Timeline notifier]

codecov bot commented Apr 22, 2024 • edited Loading

Codecov Report

wk989898 commented Apr 28, 2024

ti-chi-bot bot commented Apr 28, 2024

CharlesCheung96 commented May 7, 2024

ti-chi-bot commented May 16, 2024

ti-chi-bot commented May 16, 2024

wk989898 commented Mar 27, 2024 •

edited

Loading

sdojjy Mar 28, 2024 •

edited

Loading

codecov bot commented Apr 22, 2024 •

edited

Loading