TiDBBinlogクラスタの展開

このドキュメントでは、 Binary パッケージを使用して TiDB Binlogをデプロイするについて説明します。

ハードウェア要件

PumpとDrainer は、 Intel x86-64アーキテクチャを備えた 64 ビット ユニバーサル ハードウェアサーバープラットフォーム上で展開され、動作します。

開発、テスト、および本番の環境では、サーバーハードウェアの要件は次のとおりです。

TiUP を使用して TiDB Binlogをデプロイ

TiUP を使用して TiDB Binlogをデプロイすることをお勧めします。そのためには、 TiUPを使用して TiDB をデプロイするときに、TiDB Binlogのdrainerとpumpのノード情報をTiDB Binlog展開トポロジに追加する必要があります。詳細なデプロイメント情報については、 TiUPを使用して TiDBクラスタをデプロイを参照してください。

バイナリ パッケージを使用して TiDB Binlogをデプロイ

公式バイナリパッケージをダウンロード

TiDB Binlogのバイナリ パッケージは、 TiDB Toolkitに含まれています。 TiDB Toolkitをダウンロードするには、 TiDB ツールをダウンロードを参照してください。

使用例

PD ノードが 3 つ、TiDB ノードが 1 つ、 Pumpノードが 2 つ、 Drainerノードが 1 つあるとすると、各ノードの情報は次のようになります。

次の部分では、上記のノードに基づいてPumpとDrainerを使用する方法を示します。

1. バイナリを使用してPumpをデプロイ。

   • Pumpのコマンド ライン パラメータを表示するには、 ./pump -helpを実行します。

     Usage of Pump:
     -L string
         the output information level of logs: debug, info, warn, error, fatal ("info" by default)
     -V
         the print version information
     -addr string
         the RPC address through which Pump provides the service (-addr="192.168.0.11:8250")
     -advertise-addr string
         the RPC address through which Pump provides the external service (-advertise-addr="192.168.0.11:8250")
     -config string
         the path of the configuration file. If you specify the configuration file, Pump reads the configuration in the configuration file first. If the corresponding configuration also exits in the command line parameters, Pump uses the configuration of the command line parameters to cover that of the configuration file.
     -data-dir string
         the path where the Pump data is stored
     -gc int
         the number of days to retain the data in Pump ("7" by default)
     -heartbeat-interval int
         the interval of the heartbeats Pump sends to PD (in seconds)
     -log-file string
         the file path of logs
     -log-rotate string
         the switch frequency of logs (hour/day)
     -metrics-addr string
         the Prometheus Pushgateway address. If not set, it is forbidden to report the monitoring metrics.
     -metrics-interval int
         the report frequency of the monitoring metrics ("15" by default, in seconds)
     -node-id string
         the unique ID of a Pump node. If you do not specify this ID, the system automatically generates an ID based on the host name and listening port.
     -pd-urls string
         the address of the PD cluster nodes (-pd-urls="http://192.168.0.16:2379,http://192.168.0.15:2379,http://192.168.0.14:2379")
     -fake-binlog-interval int
         the frequency at which a Pump node generates fake binlog ("3" by default, in seconds)
     

   • 例として「192.168.0.11」にPumpをデプロイすると、Pump構成ファイルは次のようになります。

     # Pump Configuration
     
     # the bound address of Pump
     addr = "192.168.0.11:8250"
     
     # the address through which Pump provides the service
     advertise-addr = "192.168.0.11:8250"
     
     # the number of days to retain the data in Pump ("7" by default)
     gc = 7
     
     # the directory where the Pump data is stored
     data-dir = "data.pump"
     
     # the interval of the heartbeats Pump sends to PD (in seconds)
     heartbeat-interval = 2
     
     # the address of the PD cluster nodes (each separated by a comma with no whitespace)
     pd-urls = "http://192.168.0.16:2379,http://192.168.0.15:2379,http://192.168.0.14:2379"
     
     # [security]
     # This section is generally commented out if no special security settings are required.
     # The file path containing a list of trusted SSL CAs connected to the cluster.
     # ssl-ca = "/path/to/ca.pem"
     # The path to the X509 certificate in PEM format that is connected to the cluster.
     # ssl-cert = "/path/to/drainer.pem"
     # The path to the X509 key in PEM format that is connected to the cluster.
     # ssl-key = "/path/to/drainer-key.pem"
     
     # [storage]
     # Set to true (by default) to guarantee reliability by ensuring binlog data is flushed to the disk
     # sync-log = true
     
     # When the available disk capacity is less than the set value, Pump stops writing data.
     # 42 MB -> 42000000, 42 mib -> 44040192
     # default: 10 gib
     # stop-write-at-available-space = "10 gib"
     # The LSM DB settings embedded in Pump. Unless you know this part well, it is usually commented out.
     # [storage.kv]
     # block-cache-capacity = 8388608
     # block-restart-interval = 16
     # block-size = 4096
     # compaction-L0-trigger = 8
     # compaction-table-size = 67108864
     # compaction-total-size = 536870912
     # compaction-total-size-multiplier = 8.0
     # write-buffer = 67108864
     # write-L0-pause-trigger = 24
     # write-L0-slowdown-trigger = 17
     

   • Pumpを起動する例:

     ./pump -config pump.toml
     

     コマンド ライン パラメータが構成ファイル パラメータと同じ場合、コマンド ライン パラメータの値が使用されます。

2. バイナリを使用してDrainerをデプロイ。

   • Drainerのコマンド ライン パラメータを表示するには、 ./drainer -helpを実行します。

     Usage of Drainer:
     -L string
         the output information level of logs: debug, info, warn, error, fatal ("info" by default)
     -V
         the print version information
     -addr string
         the address through which Drainer provides the service (-addr="192.168.0.13:8249")
     -c int
         the number of the concurrency of the downstream for replication. The bigger the value, the better throughput performance of the concurrency ("1" by default).
     -cache-binlog-count int
         the limit on the number of binlog items in the cache ("8" by default)
         If a large single binlog item in the upstream causes OOM in Drainer, try to lower the value of this parameter to reduce memory usage.
     -config string
         the directory of the configuration file. Drainer reads the configuration file first.
         If the corresponding configuration exists in the command line parameters, Drainer uses the configuration of the command line parameters to cover that of the configuration file.
     -data-dir string
         the directory where the Drainer data is stored ("data.drainer" by default)
     -dest-db-type string
         the downstream service type of Drainer
         The value can be "mysql", "tidb", "kafka", and "file". ("mysql" by default)
     -detect-interval int
         the interval of checking the online Pump in PD ("10" by default, in seconds)
     -disable-detect
         whether to disable the conflict monitoring
     -disable-dispatch
         whether to disable the SQL feature of splitting a single binlog file. If it is set to "true", each binlog file is restored to a single transaction for replication based on the order of binlogs.
         It is set to "False", when the downstream is MySQL.
     -ignore-schemas string
         the db filter list ("INFORMATION_SCHEMA,PERFORMANCE_SCHEMA,mysql,test" by default)
         It does not support the Rename DDL operation on tables of `ignore schemas`.
     -initial-commit-ts
         If Drainer does not have the related breakpoint information, you can configure the related breakpoint information using this parameter. ("-1" by default)
         If the value of this parameter is `-1`, Drainer automatically obtains the latest timestamp from PD.
     -log-file string
         the path of the log file
     -log-rotate string
         the switch frequency of log files, hour/day
     -metrics-addr string
         the Prometheus Pushgateway address
         It it is not set, the monitoring metrics are not reported.
     -metrics-interval int
         the report frequency of the monitoring metrics ("15" by default, in seconds)
     -node-id string
         the unique ID of a Drainer node. If you do not specify this ID, the system automatically generates an ID based on the host name and listening port.
     -pd-urls string
         the address of the PD cluster nodes (-pd-urls="http://192.168.0.16:2379,http://192.168.0.15:2379,http://192.168.0.14:2379")
     -safe-mode
         Whether to enable safe mode so that data can be written into the downstream MySQL/TiDB repeatedly.
         This mode replaces the `INSERT` statement with the `REPLACE` statement and splits the `UPDATE` statement into `DELETE` plus `REPLACE`.
     -txn-batch int
         the number of SQL statements of a transaction which are output to the downstream database ("1" by default)
     

   • 「192.168.0.13」にDrainerをデプロイする場合を例にとると、 Drainer の構成ファイルは次のようになります。

     # Drainer Configuration.
     
     # the address through which Drainer provides the service ("192.168.0.13:8249")
     addr = "192.168.0.13:8249"
     
     # the address through which Drainer provides the external service
     advertise-addr = "192.168.0.13:8249"
     
     # the interval of checking the online Pump in PD ("10" by default, in seconds)
     detect-interval = 10
     
     # the directory where the Drainer data is stored "data.drainer" by default)
     data-dir = "data.drainer"
     
     # the address of the PD cluster nodes (each separated by a comma with no whitespace)
     pd-urls = "http://192.168.0.16:2379,http://192.168.0.15:2379,http://192.168.0.14:2379"
     
     # the directory of the log file
     log-file = "drainer.log"
     
     # Drainer compresses the data when it gets the binlog from Pump. The value can be "gzip". If it is not configured, it will not be compressed
     # compressor = "gzip"
     
     # [security]
     # This section is generally commented out if no special security settings are required.
     # The file path containing a list of trusted SSL CAs connected to the cluster.
     # ssl-ca = "/path/to/ca.pem"
     # The path to the X509 certificate in PEM format that is connected to the cluster.
     # ssl-cert = "/path/to/pump.pem"
     # The path to the X509 key in PEM format that is connected to the cluster.
     # ssl-key = "/path/to/pump-key.pem"
     
     # Syncer Configuration
     [syncer]
     # If the item is set, the sql-mode will be used to parse the DDL statement.
     # If the downstream database is MySQL or TiDB, then the downstream sql-mode
     # is also set to this value.
     # sql-mode = "STRICT_TRANS_TABLES,NO_ENGINE_SUBSTITUTION"
     
     # the number of SQL statements of a transaction that are output to the downstream database ("20" by default)
     txn-batch = 20
     
     # the number of the concurrency of the downstream for replication. The bigger the value,
     # the better throughput performance of the concurrency ("16" by default)
     worker-count = 16
     
     # whether to disable the SQL feature of splitting a single binlog file. If it is set to "true",
     # each binlog file is restored to a single transaction for replication based on the order of binlogs.
     # If the downstream service is MySQL, set it to "False".
     disable-dispatch = false
     
     # In safe mode, data can be written into the downstream MySQL/TiDB repeatedly.
     # This mode replaces the `INSERT` statement with the `REPLACE` statement and replaces the `UPDATE` statement with `DELETE` plus `REPLACE` statements.
     safe-mode = false
     
     # the downstream service type of Drainer ("mysql" by default)
     # Valid value: "mysql", "tidb", "file", and "kafka".
     db-type = "mysql"
     
     # If `commit ts` of the transaction is in the list, the transaction is filtered and not replicated to the downstream.
     ignore-txn-commit-ts = []
     
     # the db filter list ("INFORMATION_SCHEMA,PERFORMANCE_SCHEMA,mysql,test" by default)
     # Does not support the Rename DDL operation on tables of `ignore schemas`.
     ignore-schemas = "INFORMATION_SCHEMA,PERFORMANCE_SCHEMA,mysql"
     
     # `replicate-do-db` has priority over `replicate-do-table`. When they have the same `db` name,
     # regular expressions are supported for configuration.
     # The regular expression should start with "~".
     
     # replicate-do-db = ["~^b.*","s1"]
     
     # [syncer.relay]
     # It saves the directory of the relay log. The relay log is not enabled if the value is empty.
     # The configuration only comes to effect if the downstream is TiDB or MySQL.
     # log-dir = ""
     # the maximum size of each file
     # max-file-size = 10485760
     
     # [[syncer.replicate-do-table]]
     # db-name ="test"
     # tbl-name = "log"
     
     # [[syncer.replicate-do-table]]
     # db-name ="test"
     # tbl-name = "~^a.*"
     
     # Ignore the replication of some tables
     # [[syncer.ignore-table]]
     # db-name = "test"
     # tbl-name = "log"
     
     # the server parameters of the downstream database when `db-type` is set to "mysql"
     [syncer.to]
     host = "192.168.0.13"
     user = "root"
     # If you do not want to set a cleartext `password` in the configuration file, you can create `encrypted_password` using `./binlogctl -cmd encrypt -text string`.
     # When you have created an `encrypted_password` that is not empty, the `password` above will be ignored, because `encrypted_password` and `password` cannot take effect at the same time.
     password = ""
     encrypted_password = ""
     port = 3306
     
     [syncer.to.checkpoint]
     # When the checkpoint type is "mysql" or "tidb", this option can be
     # enabled to change the database that saves the checkpoint
     # schema = "tidb_binlog"
     # Currently only the "mysql" and "tidb" checkpoint types are supported
     # You can remove the comment tag to control where to save the checkpoint
     # The default method of saving the checkpoint for the downstream db-type:
     # mysql/tidb -> in the downstream MySQL or TiDB database
     # file/kafka -> file in `data-dir`
     # type = "mysql"
     # host = "127.0.0.1"
     # user = "root"
     # password = ""
     # `encrypted_password` is encrypted using `./binlogctl -cmd encrypt -text string`.
     # When `encrypted_password` is not empty, the `password` above will be ignored.
     # encrypted_password = ""
     # port = 3306
     
     # the directory where the binlog file is stored when `db-type` is set to `file`
     # [syncer.to]
     # dir = "data.drainer"
     
     # the Kafka configuration when `db-type` is set to "kafka"
     # [syncer.to]
     # only one of kafka-addrs and zookeeper-addrs is needed. If both are present, the program gives priority
     # to the kafka address in zookeeper
     # zookeeper-addrs = "127.0.0.1:2181"
     # kafka-addrs = "127.0.0.1:9092"
     # kafka-version = "0.8.2.0"
     # The maximum number of messages (number of binlogs) in a broker request. If it is left blank or a value smaller than 0 is configured, the default value 1024 is used.
     # kafka-max-messages = 1024
     # The maximum size of a broker request (unit: byte). The default value is 1 GiB and the maximum value is 2 GiB.
     # kafka-max-message-size = 1073741824
     
     # the topic name of the Kafka cluster that saves the binlog data. The default value is <cluster-id>_obinlog.
     # To run multiple Drainers to replicate data to the same Kafka cluster, you need to set different `topic-name`s for each Drainer.
     # topic-name = ""
     

   • Drainerの開始:

     ノート：

     ダウンストリームが MySQL/TiDB の場合、データの整合性を保証するために、 initial-commit-ts値を取得し、データの完全なバックアップを作成して、 Drainerの最初の起動前にデータを復元する必要があります。

     初めてDrainerを開始するときは、 initial-commit-tsパラメーターを使用します。

     ./drainer -config drainer.toml -initial-commit-ts {initial-commit-ts}
     

     コマンド ライン パラメータと構成ファイル パラメータが同じ場合、コマンド ラインのパラメータ値が使用されます。

3. TiDBサーバーの起動:

   • PumpとDrainerを起動したら、TiDBサーバーの構成ファイルに次のセクションを追加して、 binlogを有効にして TiDBサーバーを起動します。

     [binlog]
     enable=true
     

   • TiDBサーバーは、登録されたポンプのアドレスを PD から取得し、それらすべてにデータをストリーミングします。登録されたPumpインスタンスがない場合、TiDBサーバーは起動を拒否するか、Pumpインスタンスがオンラインになるまで起動をブロックします。

ノート：

• TiDB が実行されている場合、少なくとも 1 つのPumpが正常に実行されていることを保証する必要があります。
• TiDBサーバーで TiDB Binlogサービスを有効にするには、TiDB で-enable-binlog起動パラメーターを使用するか、TiDBサーバー構成ファイルの [ binlog ] セクションに enable=true を追加します。
• 同じクラスター内のすべての TiDB インスタンスで TiDB Binlogサービスが有効になっていることを確認してください。そうしないと、データのレプリケーション中にアップストリームとダウンストリームのデータの不整合が発生する可能性があります。 TiDB Binlogサービスが有効になっていない TiDB インスタンスを一時的に実行する場合は、TiDB 構成ファイルでrun_ddl=falseを設定します。
• Drainer は、 ignore schemasのテーブル (フィルター リスト内のスキーマ) に対するrename DDL 操作をサポートしていません。
• 既存の TiDB クラスターでDrainerを開始する場合は、通常、クラスター データの完全バックアップを作成し、スナップショット タイムスタンプを取得し、データをターゲット データベースにインポートしてから、 Drainerを開始して、対応するスナップショットから増分データを複製する必要があります。タイムスタンプ。
• ダウンストリーム データベースが TiDB または MySQL の場合、アップストリーム データベースとダウンストリーム データベースのsql_modeが一致していることを確認してください。つまり、各 SQL ステートメントが上流で実行され、下流に複製される場合、 sql_mode同じである必要があります。アップストリームとダウンストリームでそれぞれselect @@sql_mode;ステートメントを実行して、 sql_modeを比較できます。
• DDL ステートメントがアップストリームでサポートされていても、ダウンストリームと互換性がない場合、 Drainer はデータの複製に失敗します。例として、ダウンストリーム データベース MySQL が InnoDB エンジンを使用する場合にCREATE TABLE t1(a INT) ROW_FORMAT=FIXED;ステートメントをレプリケートします。この場合、 Drainerでトランザクションのスキップ構成し、下流のデータベースで互換性のあるステートメントを手動で実行できます。