cdc: Add Debezium protocol

[breezewish]

What problem does this PR solve?

Issue Number: ref #1799

What is changed and how it works?

• Debezium output format for Kafka sink
  • DML: INSERT
  • DML: UPDATE
  • DML: DELETE
  • DDL (not supported in this PR)
  • Schema: See cdc: Support schema for Debezium output protocol #10307
  • Virtual Generated Column (not supported in this PR)
• Optimized for performance and memory footprint
• Unit tests for the Debezium output format

Integration tests are now excluded from this PR, in order to make review easier.

Benchmark:

Debezium JSON using JSON Writer in this PR:

BenchmarkEncodeOneTinyColumn-10    	 2771671	       430.0 ns/op	       0 B/op	       0 allocs/op
BenchmarkEncodeLargeText-10        	  974575	      1250 ns/op	       0 B/op	       0 allocs/op
BenchmarkEncodeLargeBinary-10      	  978442	      1143 ns/op	    1154 B/op	       3 allocs/op

Debezium JSON using golang's JSON Marshaler:

BenchmarkEncodeOneTinyColumn-10    	 1000000	      1007 ns/op	    1072 B/op	      10 allocs/op
BenchmarkEncodeLargeText-10        	  526785	      2144 ns/op	    3169 B/op	      12 allocs/op
BenchmarkEncodeLargeBinary-10      	  363991	      3232 ns/op	    5348 B/op	      13 allocs/op

Cancel JSON:

BenchmarkEncodeOneTinyColumn-10    	 2046062	       593.4 ns/op	     819 B/op	       6 allocs/op
BenchmarkEncodeLargeText-10        	  703260	      1544 ns/op	    2928 B/op	       7 allocs/op
BenchmarkEncodeLargeBinary-10      	  432828	      2508 ns/op	    3968 B/op	       9 allocs/op

Typical output from Debezum:

{
  "payload": {
    "after": {
      "id": 1
    },
    "before": null,
    "op": "c",
    "source": {
      "connector": "mysql",
      "db": "test",
      "file": "mysql-bin.000004",
      "gtid": null,
      "name": "dbserver1",
      "pos": 414547,
      "query": null,
      "row": 0,
      "sequence": null,
      "server_id": 223344,
      "snapshot": "false",
      "table": "tablename",
      "thread": 37,
      "ts_ms": 1701314261000,
      "version": "2.4.0.Final"
    },
    "transaction": null,
    "ts_ms": 1701314261838
  },
  "schema": {
    // ...
    // Schema omitted
  }
}

The output of TiCDC's Debezium format:

{
  "payload": {
    "after": {
      "id": 1
    },
    "before": null,
    "op": "c",
    "source": {
      "cluster_id": "",
      "commit_ts": 445989325844512800,
      "connector": "TiCDC",
      "db": "test",
      "file": "",
      "gtid": null,
      "name": "",
      "pos": 0,
      "query": null,
      "row": 0,
      "server_id": 0,
      "snapshot": "false",
      "table": "tablename",
      "thread": 0,
      "ts_ms": 1701314261797,
      "version": "2.4.0.Final"
    },
    "transaction": null,
    "ts_ms": 1701314270171
  }
}

Check List

Tests

• Unit test

• Manual test (add detailed scripts or steps below)

Questions

Will it cause performance regression or break compatibility?

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

Release note

cdc: Support Debezium output format for Kafka sink

[ti-chi-bot]

Welcome @breezewish!

It looks like this is your first PR to pingcap/tiflow 🎉.

I'm the bot to help you request reviewers, add labels and more, See available commands.

We want to make sure your contribution gets all the attention it needs!



Thank you, and welcome to pingcap/tiflow. 😃

[ti-chi-bot]

Hi @breezewish. 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.

[sre-bot]

All committers have signed the CLA.

[3AceShowHand]

simply use ErrEncodeFailed should be ok

[breezewish]

Seems that all formats use its own error.

[ti-chi-bot]

[APPROVALNOTIFIER] This PR is APPROVED

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

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,asddongmen]

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]

[LGTM Timeline notifier]

Timeline:

• 2023-12-11 03:56:02.637334318 +0000 UTC m=+242053.674561245: ☑️ agreed by asddongmen.
• 2023-12-12 07:42:17.349744449 +0000 UTC m=+342028.386971376: ☑️ agreed by 3AceShowHand.

[breezewish]

/retest