• TiDB Binlog 教程
    • TiDB Binlog 简介
    • 架构
    • 安装
    • 配置
    • 启动程序
    • 连接
    • binlogctl
    • 清理
    • 总结

    TiDB Binlog 教程

    本文档主要介绍如何使用 TiDB Binlog 将数据从 TiDB 推送到 MariaDB 实例。文中的 TiDB Binlog 集群包含 Pump 和 Drainer 的单个节点，TiDB 集群包含 TiDB、TiKV 和 Placement Driver (PD) 各组件的单个节点。

    希望上手实践 TiDB Binlog 工具的用户需要对 TiDB 架构有一定的了解，最好有创建过 TiDB 集群的经验。该文档也有助于简单快速了解 TiDB Binlog 架构以及相关概念。

    警告：

    该文档中部署 TiDB 的操作指导不适用于在生产或研发环境中部署 TiDB 的情况。

    该文档假设用户使用的是现代 Linux 发行版本中的 x86-64。示例中使用的是 VMware 中运行的 CentOS 7 最小化安装。建议在一开始就进行清洁安装，以避免受现有环境中未知情况的影响。如果不想使用本地虚拟环境，也可以使用云服务启动 CentOS 7 VM。

    TiDB Binlog 简介

    TiDB Binlog 用于收集 TiDB 中二进制日志数据、提供实时数据备份和同步以及将 TiDB 集群的数据增量同步到下游。

    TiDB Binlog 支持以下功能场景：

    • 增量备份，将 TiDB 集群中的数据增量同步到另一个集群，或通过 Kafka 增量同步到选择的下游。
    • 当使用 TiDB DM (Data Migration) 将数据从上游 MySQL 或者 MariaDB 迁移到 TiDB 集群时，可使用 TiDB Binlog 保持 TiDB 集群与其一个独立下游 MySQL 或 MariaDB 实例或集群同步。当 TiDB 集群上游数据迁移过程中出现问题，下游数据同步过程中可使用 TiDB Binlog 恢复数据到原先的状态。

    更多信息参考 TiDB Binlog Cluster 版本用户文档。

    架构

    TiDB Binlog 集群由 Pump 和 Drainer 两个组件组成。一个 Pump 集群中有若干个 Pump 节点。TiDB 实例连接到各个 Pump 节点并发送 binlog 数据到 Pump 节点。Pump 集群连接到 Drainer 节点，Drainer 将接收到的更新数据转换到某个特定下游（例如 Kafka、另一个 TiDB 集群或 MySQL 或 MariaDB Server）指定的正确格式。

    TiDB Binlog architecture

    Pump 的集群架构能确保 TiDB 或 Pump 集群中有新的实例加入或退出时更新数据不会丢失。

    安装

    由于 RHEL/CentOS 7 的默认包装库中包括 MariaDB Server，本示例选择的是 MariaDB Server。后续除了安装服务器，也需要安装客户端。安装指令如下：

    1. sudo yum install -y mariadb-server

    预期输出：

    1. [kolbe@localhost ~]$ curl -LO http://download.pingcap.org/tidb-latest-linux-amd64.tar.gz | tar xzf -
    2.   % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
    3.                                  Dload  Upload   Total   Spent    Left  Speed
    4. 100  368M  100  368M    0     0  8394k      0  0:00:44  0:00:44 --:--:-- 11.1M
    5. [kolbe@localhost ~]$ cd tidb-latest-linux-amd64
    6. [kolbe@localhost tidb-latest-linux-amd64]$

    配置

    通过执行以下步骤配置一个 TiDB 集群，该集群包括 pd-server、tikv-server 和 tidb-server 各组件的单个实例。

    1. 填充配置文件：

      1.  printf > pd.toml %s\\n 'log-file="pd.log"' 'data-dir="pd.data"'
      2.  printf > tikv.toml %s\\n 'log-file="tikv.log"' '[storage]' 'data-dir="tikv.data"' '[pd]' 'endpoints=["127.0.0.1:2379"]' '[rocksdb]' max-open-files=1024 '[raftdb]' max-open-files=1024 
      3.  printf > pump.toml %s\\n 'log-file="pump.log"' 'data-dir="pump.data"' 'addr="127.0.0.1:8250"' 'advertise-addr="127.0.0.1:8250"' 'pd-urls="http://127.0.0.1:2379"'
      4.  printf > tidb.toml %s\\n 'store="tikv"' 'path="127.0.0.1:2379"' '[log.file]' 'filename="tidb.log"' '[binlog]' 'enable=true'
      5.  printf > drainer.toml %s\\n 'log-file="drainer.log"' '[syncer]' 'db-type="mysql"' '[syncer.to]' 'host="127.0.0.1"' 'user="root"' 'password=""' 'port=3306'

    2. 查看配置细节：

      1.  for f in *.toml; do echo "$f:"; cat "$f"; echo; done

      预期输出：

      1.  drainer.toml:
      2.  log-file="drainer.log"
      3.  [syncer]
      4.  db-type="mysql"
      5.  [syncer.to]
      6.  host="127.0.0.1"
      7.  user="root"
      8.  password=""
      9.  port=3306
      11.  pd.toml:
      12.  log-file="pd.log"
      13.  data-dir="pd.data"
      15.  pump.toml:
      16.  log-file="pump.log"
      17.  data-dir="pump.data"
      18.  addr="127.0.0.1:8250"
      19.  advertise-addr="127.0.0.1:8250"
      20.  pd-urls="http://127.0.0.1:2379"
      22.  tidb.toml:
      23.  store="tikv"
      24.  path="127.0.0.1:2379"
      25.  [log.file]
      26.  filename="tidb.log"
      27.  [binlog]
      28.  enable=true
      30.  tikv.toml:
      31.  log-file="tikv.log"
      32.  [storage]
      33.  data-dir="tikv.data"
      34.  [pd]
      35.  endpoints=["127.0.0.1:2379"]
      36.  [rocksdb]
      37.  max-open-files=1024
      38.  [raftdb]
      39.  max-open-files=1024

    启动程序

    现在可启动各个组件。推荐启动顺序依次为 Placement Driver (PD)、TiKV、Pump（TiDB 发送 binlog 日志必须连接 Pump 服务）、TiDB。

    1. 启动所有服务：

      1.  ./bin/pd-server --config=pd.toml &>pd.out &
      2.  ./bin/tikv-server --config=tikv.toml &>tikv.out &
      3.  ./bin/pump --config=pump.toml &>pump.out &
      4.  sleep 3
      5.  ./bin/tidb-server --config=tidb.toml &>tidb.out &

      预期输出：

      1.  [kolbe@localhost tidb-latest-linux-amd64]$ ./bin/pd-server --config=pd.toml &>pd.out &
      2.  [1] 20935
      3.  [kolbe@localhost tidb-latest-linux-amd64]$ ./bin/tikv-server --config=tikv.toml &>tikv.out &
      4.  [2] 20944
      5.  [kolbe@localhost tidb-latest-linux-amd64]$ ./bin/pump --config=pump.toml &>pump.out &
      6.  [3] 21050
      7.  [kolbe@localhost tidb-latest-linux-amd64]$ sleep 3
      8.  [kolbe@localhost tidb-latest-linux-amd64]$ ./bin/tidb-server --config=tidb.toml &>tidb.out &
      9.  [4] 21058

    2. 如果执行 jobs，可以看到后台正在运行的程序，列表如下：

      1.  [kolbe@localhost tidb-latest-linux-amd64]$ jobs
      2.  [1]   Running                 ./bin/pd-server --config=pd.toml &>pd.out &
      3.  [2]   Running                 ./bin/tikv-server --config=tikv.toml &>tikv.out &
      4.  [3]-  Running                 ./bin/pump --config=pump.toml &>pump.out &
      5.  [4]+  Running                 ./bin/tidb-server --config=tidb.toml &>tidb.out &

      如果有服务启动失败（例如出现 “Exit 1” 而不是 “Running”），尝试重启单个组件。

    连接

    按以上步骤操作后，TiDB 的 4 个组件开始运行。接下来可以使用以下 MariaDB 或 MySQL 命令行客户端，通过 4000 端口连接到 TiDB 服务：

    1. mysql -h 127.0.0.1 -P 4000 -u root -e 'select tidb_version()\G'

    预期输出：

    1. [kolbe@localhost tidb-latest-linux-amd64]$ mysql -h 127.0.0.1 -P 4000 -u root -e 'select tidb_version()\G'
    2. *************************** 1. row ***************************
    3. tidb_version(): Release Version: v3.0.0-beta.1-154-gd5afff70c
    4. Git Commit Hash: d5afff70cdd825d5fab125c8e52e686cc5fb9a6e
    5. Git Branch: master
    6. UTC Build Time: 2019-04-24 03:10:00
    7. GoVersion: go version go1.12 linux/amd64
    8. Race Enabled: false
    9. TiKV Min Version: 2.1.0-alpha.1-ff3dd160846b7d1aed9079c389fc188f7f5ea13e
    10. Check Table Before Drop: false

    连接后TiDB 集群已开始运行，pump 读取集群中的 binlog 数据，并在其数据目录中将 binlog 数据存储为 relay log。下一步是启动一个可供 drainer 写入的 MariaDB Server。

    1. 启动 drainer：

      1.  sudo systemctl start mariadb
      2.  ./bin/drainer --config=drainer.toml &>drainer.out &

      如果你的操作系统更易于安装 MySQL，只需保证监听 3306 端口。另外，可使用密码为空的 “root” 用户连接到 MySQL，或调整 drainer.toml 连接到 MySQL。

      1.  mysql -h 127.0.0.1 -P 3306 -u root
      1.  show databases;

      预期输出：

      1.  [kolbe@localhost ~]$ mysql -h 127.0.0.1 -P 3306 -u root
      2.  Welcome to the MariaDB monitor.  Commands end with ; or \g.
      3.  Your MariaDB connection id is 20
      4.  Server version: 5.5.60-MariaDB MariaDB Server
      6.  Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others.
      8.  Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
      10.  MariaDB [(none)]> show databases;
      11.  +--------------------+
      12.  | Database           |
      13.  +--------------------+
      14.  | information_schema |
      15.  | mysql              |
      16.  | performance_schema |
      17.  | test               |
      18.  | tidb_binlog        |
      19.  +--------------------+
      20.  5 rows in set (0.01 sec)

      如下表格是包含 checkpoint 表格的 tidb_binlog 数据库。drainer 使用 checkpoint 表格，记录 TiDB 集群中的 binlog 已经更新到了哪个位置。

      1.  MariaDB [tidb_binlog]> use tidb_binlog;
      2.  Database changed
      3.  MariaDB [tidb_binlog]> select * from checkpoint;
      4.  +---------------------+---------------------------------------------+
      5.  | clusterID           | checkPoint                                  |
      6.  +---------------------+---------------------------------------------+
      7.  | 6678715361817107733 | {"commitTS":407637466476445697,"ts-map":{}} |
      8.  +---------------------+---------------------------------------------+
      9.  1 row in set (0.00 sec)

      打开另一个连接到 TiDB 的客户端，创建一个表格并插入几行数据。建议在 GNU Screen 软件中操作，从而同时打开多个客户端。

      1.  mysql -h 127.0.0.1 -P 4000 --prompt='TiDB [\d]> ' -u root
      1.  create database tidbtest;
      2.  use tidbtest;
      3.  create table t1 (id int unsigned not null auto_increment primary   key);
      4.  insert into t1 () values (),(),(),(),();
      5.  select * from t1;

      预期输出：

      1.  TiDB [(none)]> create database tidbtest;
      2.  Query OK, 0 rows affected (0.12 sec)
      4.  TiDB [(none)]> use tidbtest;
      5.  Database changed
      6.  TiDB [tidbtest]> create table t1 (id int unsigned not null auto_increment primary key);
      7.  Query OK, 0 rows affected (0.11 sec)
      9.  TiDB [tidbtest]> insert into t1 () values (),(),(),(),();
      10.  Query OK, 5 rows affected (0.01 sec)
      11.  Records: 5  Duplicates: 0  Warnings: 0
      13.  TiDB [tidbtest]> select * from t1;
      14.  +----+
      15.  | id |
      16.  +----+
      17.  |  1 |
      18.  |  2 |
      19.  |  3 |
      20.  |  4 |
      21.  |  5 |
      22.  +----+
      23.  5 rows in set (0.00 sec)

      切换回 MariaDB 客户端可看到新的数据库、新的表格和最近插入的行数据。

      1.  use tidbtest;
      2.  show tables;
      3.  select * from t1;

      预期输出：

      1.  MariaDB [(none)]> use tidbtest;
      2.  Reading table information for completion of table and column names
      3.  You can turn off this feature to get a quicker startup with -A
      5.  Database changed
      6.  MariaDB [tidbtest]> show tables;
      7.  +--------------------+
      8.  | Tables_in_tidbtest |
      9.  +--------------------+
      10.  | t1                 |
      11.  +--------------------+
      12.  1 row in set (0.00 sec)
      14.  MariaDB [tidbtest]> select * from t1;
      15.  +----+
      16.  | id |
      17.  +----+
      18.  |  1 |
      19.  |  2 |
      20.  |  3 |
      21.  |  4 |
      22.  |  5 |
      23.  +----+
      24.  5 rows in set (0.00 sec)

      可看到查询 MariaDB 时插入到 TiDB 相同的行数据，表明 TiDB Binlog 安装成功。

    binlogctl

    加入到集群的 Pump 和 Drainer 的数据存储在 Placement Driver (PD) 中。binlogctl 可用于查询和修改状态信息。更多信息请参考 binlogctl guide。

    使用 binlogctl 查看集群中 Pump 和 Drainer 的当前状态：

    1. ./bin/binlogctl -cmd drainers
    2. ./bin/binlogctl -cmd pumps

    预期输出：

    1. [kolbe@localhost tidb-latest-linux-amd64]$ ./bin/binlogctl -cmd drainers
    2. [2019/04/11 17:44:10.861 -04:00] [INFO] [nodes.go:47] ["query node"] [type=drainer] [node="{NodeID: localhost.localdomain:8249, Addr: 192.168.236.128:8249, State: online, MaxCommitTS: 407638907719778305, UpdateTime: 2019-04-11 17:44:10 -0400 EDT}"]
    4. [kolbe@localhost tidb-latest-linux-amd64]$ ./bin/binlogctl -cmd pumps
    5. [2019/04/11 17:44:13.904 -04:00] [INFO] [nodes.go:47] ["query node"] [type=pump] [node="{NodeID: localhost.localdomain:8250, Addr: 192.168.236.128:8250, State: online, MaxCommitTS: 407638914024079361, UpdateTime: 2019-04-11 17:44:13 -0400 EDT}"]

    如果结束 Drainer 进程，集群会改进程设置“已暂停（即集群等待 Drainer 重新加入）”的状态。

    1. pkill drainer
    2. ./bin/binlogctl -cmd drainers

    预期输出：

    1. [kolbe@localhost tidb-latest-linux-amd64]$ pkill drainer
    2. [kolbe@localhost tidb-latest-linux-amd64]$ ./bin/binlogctl -cmd drainers
    3. [2019/04/11 17:44:22.640 -04:00] [INFO] [nodes.go:47] ["query node"] [type=drainer] [node="{NodeID: localhost.localdomain:8249, Addr: 192.168.236.128:8249, State: paused, MaxCommitTS: 407638915597467649, UpdateTime: 2019-04-11 17:44:18 -0400 EDT}"]

    使用 binlogctl 的 “NodeIDs” 可控制单个对应节点。在该情况下，Drainer 的节点 ID 是 “localhost.localdomain:8249”，Pump 的节点 ID 是 “localhost.localdomain:8250”。

    本文档中的 binlogctl 主要用于集群重启。如果在 TiDB 集群中终止并尝试重启所有的进程，由于 Pump 无法连接 Drainer 且认为 Drainer 依旧“在线”，Pump 会拒绝启动。这里的进程并不包括下游的 MySQL 或 MariaDB 或 Drainer。

    以下有三个方案可解决上述问题：

    • 使用 binlogctl 停止 Drainer，而不是结束进程：

      1.   ./bin/binlogctl --pd-urls=http://127.0.0.1:2379 --cmd=drainers
      2.   ./bin/binlogctl --pd-urls=http://127.0.0.1:2379 --cmd=pause-drainer --node-id=localhost.localdomain:8249

    • 在启动 Pump 之前先启动 Drainer。

    • 在启动 PD 之后但在启动 Drainer 和 Pump 之前，使用 binlogctl 更新已暂定 Drainer 的状态。

      1.   ./bin/binlogctl --pd-urls=http://127.0.0.1:2379 --cmd=update-drainer --node-id=localhost.localdomain:8249 --state=paused

    清理

    在 shell 终端里可启动创建集群的所有进程（pd-server 、tikv-server、pump、tidb-server、drainer）。可通过在 shell 终端中执行 pkill -P $$ 停止 TiDB 集群服务和 TiDB Binlog 进程。按一定的顺序停止这些进程有利于留出足够的时间彻底关闭每个组件。

    1. for p in tidb-server drainer pump tikv-server pd-server; do pkill "$p"; sleep 1; done

    预期输出：

    1. kolbe@localhost tidb-latest-linux-amd64]$ for p in tidb-server drainer pump tikv-server pd-server; do pkill "$p"; sleep 1; done
    2. [4]-  Done                    ./bin/tidb-server --config=tidb.toml &>tidb.out
    3. [5]+  Done                    ./bin/drainer --config=drainer.toml &>drainer.out
    4. [3]+  Done                    ./bin/pump --config=pump.toml &>pump.out
    5. [2]+  Done                    ./bin/tikv-server --config=tikv.toml &>tikv.out
    6. [1]+  Done                    ./bin/pd-server --config=pd.toml &>pd.out

    如果需要所有服务退出后重启集群，可以使用一开始启动服务的命令。如以上 binlogctl 部分所述，需要先启动 Drainer 再启动 Pump，最后启动 tidb-server。

    1. ./bin/pd-server --config=pd.toml &>pd.out &
    2. ./bin/tikv-server --config=tikv.toml &>tikv.out &
    3. ./bin/drainer --config=drainer.toml &>drainer.out &
    4. sleep 3
    5. ./bin/pump --config=pump.toml &>pump.out &
    6. sleep 3
    7. ./bin/tidb-server --config=tidb.toml &>tidb.out &

    如果有组件启动失败，请尝试单独重启该组件。

    总结

    本文档介绍了如何通过设置 TiDB Binlog，使用单个 Pump 和 Drainer 组成的集群同步 TiDB 集群数据到下游的 MariaDB。可以发现，TiDB Binlog 是用于获取处理 TiDB 集群中更新数据的综合性平台工具。

    在更稳健的开发、测试或生产部署环境中，可以使用多个 TiDB 服务以实现高可用性和扩展性。使用多个 Pump 实例可以避免 Pump 集群中的问题影响发送到 TiDB 实例的应用流量。或者可以使用增加的 Drainer 实例同步数据到不同的下游或实现数据增量备份。