Transferring data to Yandex Managed Service for Apache Kafka® using Debezium
You can track data changes in Managed Service for MySQL® and send them to Managed Service for Apache Kafka® using change data capture (CDC).
In this tutorial, you will learn how to create a virtual machine in Yandex Cloud and set up Debezium
Required paid resources
- Managed Service for Apache Kafka® cluster: computing resources allocated to hosts, size of storage and backups (see Managed Service for Apache Kafka® pricing).
- Managed Service for MySQL® cluster: computing resources allocated to hosts, size of storage and backups (see Managed Service for MySQL® pricing).
- Fee for public IP addresses assigned to cluster hosts (see Virtual Private Cloud pricing).
- VM fee, which covers the use of computing resources, storage, and public IP address (see Compute Cloud pricing).
Getting started
-
Create a source cluster with the following settings:
- Hosts: Publicly available
- Database:
db1 - User:
user1
-
Create a Managed Service for Apache Kafka® target cluster in any suitable configuration with publicly available hosts.
-
Create a virtual machine running Ubuntu 20.04 with a public IP address.
-
If you use security groups, configure them to allow connections to the clusters from the internet and from the VM you created, and to allow SSH access to that VM from the internet:
-
Connect to your VM over SSH and complete its initial setup:
-
Install the dependencies:
sudo apt update && \ sudo apt install kafkacat openjdk-17-jre mysql-client --yesMake sure you can use it to connect to the Managed Service for Apache Kafka® source cluster over SSL.
-
Create a directory for Apache Kafka®:
sudo mkdir -p /opt/kafka/ -
Download the archive with Apache Kafka® executables and unpack it into this directory. For example, to download and unpack Apache Kafka® 3.0, run this command:
wget https://archive.apache.org/dist/kafka/3.0.0/kafka_2.13-3.0.0.tgz && \ sudo tar xf kafka_2.13-3.0.0.tgz --strip 1 --directory /opt/kafka/You can check the current Apache Kafka® version on the project’s download page
. -
Install certificates on the VM and make sure you can access the clusters:
- Managed Service for Apache Kafka® (use
kafkacat). - Managed Service for MySQL® (use
mysql).
- Managed Service for Apache Kafka® (use
-
Create a directory to store the files required for the Debezium connector:
sudo mkdir -p /etc/debezium/plugins/ -
To enable the Debezium connector to connect to Managed Service for Apache Kafka® broker hosts, add the SSL certificate to Java Key Store. For extra storage security, specify a password of at least six characters in the
-storepasssetting:sudo keytool \ -importcert \ -alias YandexCA -file /usr/local/share/ca-certificates/Yandex/YandexInternalRootCA.crt \ -keystore /etc/debezium/keystore.jks \ -storepass <JKS_password> \ --noprompt
-
Set up the source cluster
-
Assign the
REPLICATION CLIENTandREPLICATION SLAVEglobal privileges touser1. -
Connect to the
db1database asuser1. -
Add test data to the database. In this example, we will use a simple table containing information from certain car sensors.
-
Create a table:
CREATE TABLE measurements ( `device_id` VARCHAR(32) PRIMARY KEY NOT NULL, `datetime` TIMESTAMP NOT NULL, `latitude` REAL NOT NULL, `longitude` REAL NOT NULL, `altitude` REAL NOT NULL, `speed` REAL NOT NULL, `battery_voltage` REAL, `cabin_temperature` REAL NOT NULL, `fuel_level` REAL ); -
Populate the table with data:
INSERT INTO measurements VALUES ('iv9a94th6rzt********', '2020-06-05 17:27:00', 55.70329032, 37.65472196, 427.5, 0, 23.5, 17, NULL), ('rhibbh3y08qm********', '2020-06-06 09:49:54', 55.71294467, 37.66542005, 429.13, 55.5, NULL, 18, 32), ('iv9a94th678t********', '2020-06-07 15:00:10', 55.70985913, 37.62141918, 417.0, 15.7, 10.3, 17, NULL);
-
Set up the Debezium connector
-
Connect to the VM over SSH.
-
Download the current Debezium connector
and unpack into the/etc/debezium/plugins/directory.You can check the current connector version on the project page
. Below are commands for1.9.4.Final.VERSION="1.9.4.Final" wget https://repo1.maven.org/maven2/io/debezium/debezium-connector-mysql/${VERSION}/debezium-connector-mysql-${VERSION}-plugin.tar.gz && \ sudo tar -xzvf debezium-connector-mysql-${VERSION}-plugin.tar.gz -C /etc/debezium/plugins/ -
Create a file named
/etc/debezium/mdb-connector.confwith Debezium connector settings for connecting to the source cluster:name=debezium-mmy connector.class=io.debezium.connector.mysql.MySqlConnector database.hostname=c-<cluster_ID>.rw.mdb.yandexcloud.net database.port=3306 database.user=user1 database.password=<user1_password> database.dbname=db1 database.server.name=mmy database.ssl.mode=required_identity table.include.list=db1.measurements heartbeat.interval.ms=15000 heartbeat.topics.prefix=__debezium-heartbeat snapshot.mode=never include.schema.changes=false database.history.kafka.topic=dbhistory.mmy database.history.kafka.bootstrap.servers=<broker_host_1_FQDN>:9091,...,<broker_host_N_FQDN>:9091 # Producer settings database.history.producer.security.protocol=SSL database.history.producer.ssl.truststore.location=/etc/debezium/keystore.jks database.history.producer.ssl.truststore.password=<JKS_password> database.history.producer.sasl.mechanism=SCRAM-SHA-512 database.history.producer.security.protocol=SASL_SSL database.history.producer.sasl.jaas.config=org.apache.kafka.common.security.scram.ScramLoginModule required username="debezium" password="<debezium_user_password>"; # Consumer settings database.history.consumer.security.protocol=SSL database.history.consumer.ssl.truststore.location=/etc/debezium/keystore.jks database.history.consumer.ssl.truststore.password=<JKS_password> database.history.consumer.sasl.mechanism=SCRAM-SHA-512 database.history.consumer.security.protocol=SASL_SSL database.history.consumer.sasl.jaas.config=org.apache.kafka.common.security.scram.ScramLoginModule required username="debezium" password="<debezium_user_password>";Where:
-
name: Logical name of the Debezium connector. It is used for the connector’s internal needs. -
database.hostname: Special FQDN for connecting to the master host of the source cluster.You can get the cluster ID with the list of clusters in the folder.
-
database.user: MySQL® username. -
database.dbname: MySQL® database name. -
database.server.name: Name of the database server that Debezium will use when choosing a topic for sending messages. -
table.include.list: Names of tables for which Debezium will capture changes. Specify full names that include the database name (db1). Debezium will use values from this field when choosing a topic for sending messages. -
heartbeat.interval.msandheartbeat.topics.prefix: Heartbeat settings required for Debezium. -
database.history.kafka.topic: Name of the service topic where the connector publishes notifications about schema changes in the source cluster.
-
Set up the target cluster
-
Create a topic to store data from the source cluster:
-
Name:
mmy.db1.measurements.Data topic names follow
the<server_name>.<database_name>.<table_name>convention.According to the Debezium configuration file:
database.server.namespecifies the server name,mmy.table.include.listspecifies the database name,db1, along with the table name,measurements.
If you need to track data changes in multiple tables, create a separate topic for each one.
-
-
Create a service topic for tracking the connector status:
-
Name:
__debezium-heartbeat.mmy.Service topic names follow
the<prefix_for_heartbeat>.<server_name>convention.According to the Debezium configuration file:
heartbeat.topics.prefixspecifies the prefix,__debezium-heartbeat.database.server.namespecifies the server name,mmy.
-
Cleanup policy:
Compact.
If you need to capture data from multiple source clusters, create a separate service topic for each one.
-
-
Create a service topic for tracking to data format schema changes:
- Name:
dbhistory.mmy. - Cleanup policy:
Delete. - Number of partitions:
1.
- Name:
-
Create a user named
debezium. -
Grant
debeziumtheACCESS_ROLE_CONSUMERandACCESS_ROLE_PRODUCERpermissions for the topics you created.
Run the Debezium connector
-
Create a file with Debezium worker settings:
/etc/debezium/worker.conf# AdminAPI connect properties bootstrap.servers=<broker_host_1_FQDN>:9091,...,<broker_host_N_FQDN>:9091 sasl.mechanism=SCRAM-SHA-512 security.protocol=SASL_SSL ssl.truststore.location=/etc/debezium/keystore.jks ssl.truststore.password=<JKS_password> sasl.jaas.config=org.apache.kafka.common.security.scram.ScramLoginModule required username="debezium" password="<debezium_user_password>"; # Producer connect properties producer.sasl.mechanism=SCRAM-SHA-512 producer.security.protocol=SASL_SSL producer.ssl.truststore.location=/etc/debezium/keystore.jks producer.ssl.truststore.password=<JKS_password> producer.sasl.jaas.config=org.apache.kafka.common.security.scram.ScramLoginModule required username="debezium" password="<debezium_user_password>"; # Worker properties plugin.path=/etc/debezium/plugins/ key.converter=org.apache.kafka.connect.json.JsonConverter value.converter=org.apache.kafka.connect.json.JsonConverter key.converter.schemas.enable=true value.converter.schemas.enable=true offset.storage.file.filename=/etc/debezium/worker.offset -
In a separate terminal, run the connector:
sudo /opt/kafka/bin/connect-standalone.sh \ /etc/debezium/worker.conf \ /etc/debezium/mdb-connector.properties
Check that Debezium works properly
-
In a separate terminal, run
kafkacatin consumer mode:kafkacat \ -C \ -b <broker_host_1_FQDN>:9091,...,<broker_host_N_FQDN>:9091 \ -t mmy.db1.measurements \ -X security.protocol=SASL_SSL \ -X sasl.mechanisms=SCRAM-SHA-512 \ -X sasl.username=debezium \ -X sasl.password=<password> \ -X ssl.ca.location=/usr/local/share/ca-certificates/Yandex/YandexInternalRootCA.crt \ -Z \ -K:The output will return the data format schema of the
db1.measurementstable and information about the previously added rows.Message snippet example
{ "schema": { ... }, "payload": { "before": null, "after": { "device_id": "iv9a94th6rzt********", "datetime": 1591378020000000, "latitude": 55.70329, "longitude": 37.65472, "altitude": 427.5, "speed": 0.0, "battery_voltage": 23.5, "cabin_temperature": 17.0, "fuel_level": null }, "source": { "version": "1.8.1.Final", "connector": "mysql", "name": "mmy", "ts_ms": 1628245046882, "snapshot": "true", "db": "db1", "sequence": "[null,\"4328525512\"]", "table": "measurements", "txId": 8861, "lsn": 4328525328, "xmin": null }, "op": "r", "ts_ms": 1628245046893, "transaction": null } } -
Connect to the source cluster and add another row to the
measurementstable:INSERT INTO measurements VALUES ('iv7b74th678t********', '2020-06-08 17:45:00', 53.70987913, 36.62549834, 378.0, 20.5, 5.3, 20, NULL); -
Make sure the terminal running
kafkacatdisplays details about the added row.
Delete the resources you created
Delete the resources you no longer need to avoid paying for them:
-
If you reserved a public static IP address for the virtual machine, release and delete it.
-
Delete the clusters: