mysql數據實時同步到Elasticsearch

　　　　　　　　　　　　　　　　　　　　　　　　mysql數據實時同步到Elasticsearch


業務需要把mysql的數據實時同步到ES，實現低延遲的檢索到ES中的數據或者進行其它數據分析處理。本文給出以同步mysql binlog的方式實時同步數據到ES的思路, 實踐並驗證該方式的可行性，以供參考。

mysql binlog日志
mysql的binlog日志主要用於數據庫的主從復制與數據恢復。binlog中記錄了數據的增刪改查操作，主從復制過程中，主庫向從庫同步binlog日志，從庫對binlog日志中的事件進行重放，從而實現主從同步。
mysql binlog日志有三種模式，分別為：

    ROW: 記錄每一行數據被修改的情況，但是日志量太大
    STATEMENT: 記錄每一條修改數據的SQL語句，減少了日志量，但是SQL語句使用函數或觸發器時容易出現主從不一致
    MIXED: 結合了ROW和STATEMENT的優點，根據具體執行數據操作的SQL語句選擇使用ROW或者STATEMENT記錄日志
要通過mysql binlog將數據同步到ES集群，只能使用ROW模式，因為只有ROW模式才能知道mysql中的數據的修改內容。

以UPDATE操作為例，ROW模式的binlog日志內容示例如下：

    SET TIMESTAMP=1527917394/*!*/;
    BEGIN
    /*!*/;
    # at 3751
    #180602 13:29:54 server id 1  end_log_pos 3819 CRC32 0x8dabdf01     Table_map: `webservice`.`building` mapped to number 74
    # at 3819
    #180602 13:29:54 server id 1  end_log_pos 3949 CRC32 0x59a8ed85     Update_rows: table id 74 flags: STMT_END_F
    
    BINLOG '
    UisSWxMBAAAARAAAAOsOAAAAAEoAAAAAAAEACndlYnNlcnZpY2UACGJ1aWxkaW5nAAYIDwEPEREG
    wACAAQAAAAHfq40=
    UisSWx8BAAAAggAAAG0PAAAAAEoAAAAAAAEAAgAG///A1gcAAAAAAAALYnVpbGRpbmctMTAADwB3
    UkRNbjNLYlV5d1k3ajVbD64WWw+uFsDWBwAAAAAAAAtidWlsZGluZy0xMAEPAHdSRE1uM0tiVXl3
    WTdqNVsPrhZbD64Whe2oWQ==
    '/*!*/;
    ### UPDATE `webservice`.`building`
    ### WHERE
    ###   @1=2006 /* LONGINT meta=0 nullable=0 is_null=0 */
    ###   @2='building-10' /* VARSTRING(192) meta=192 nullable=0 is_null=0 */
    ###   @3=0 /* TINYINT meta=0 nullable=0 is_null=0 */
    ###   @4='wRDMn3KbUywY7j5' /* VARSTRING(384) meta=384 nullable=0 is_null=0 */
    ###   @5=1527754262 /* TIMESTAMP(0) meta=0 nullable=0 is_null=0 */
    ###   @6=1527754262 /* TIMESTAMP(0) meta=0 nullable=0 is_null=0 */
    ### SET
    ###   @1=2006 /* LONGINT meta=0 nullable=0 is_null=0 */
    ###   @2='building-10' /* VARSTRING(192) meta=192 nullable=0 is_null=0 */
    ###   @3=1 /* TINYINT meta=0 nullable=0 is_null=0 */
    ###   @4='wRDMn3KbUywY7j5' /* VARSTRING(384) meta=384 nullable=0 is_null=0 */
    ###   @5=1527754262 /* TIMESTAMP(0) meta=0 nullable=0 is_null=0 */
    ###   @6=1527754262 /* TIMESTAMP(0) meta=0 nullable=0 is_null=0 */
    # at 3949
    #180602 13:29:54 server id 1  end_log_pos 3980 CRC32 0x58226b8f     Xid = 182
    COMMIT/*!*/;
STATEMENT模式下binlog日志內容示例為：

    SET TIMESTAMP=1527919329/*!*/;
    update building set Status=1 where Id=2000
    /*!*/;
    # at 688
    #180602 14:02:09 server id 1  end_log_pos 719 CRC32 0x4c550a7d  Xid = 200
    COMMIT/*!*/;
從ROW模式和STATEMENT模式下UPDATE操作的日志內容可以看出，ROW模式完整地記錄了要修改的某行數據更新前的所有字段的值以及更改后所有字段的值，而STATEMENT模式只單單記錄了UPDATE操作的SQL語句。我們要將mysql的數據實時同步到ES， 只能選擇ROW模式的binlog, 獲取並解析binlog日志的數據內容，執行ES document api，將數據同步到ES集群中。

mysqldump工具
mysqldump是一個對mysql數據庫中的數據進行全量導出的一個工具.
mysqldump的使用方式如下：

mysqldump -uelastic -p'Elastic_123' --host=172.16.32.5 -F webservice > dump.sql
上述命令表示從遠程數據庫172.16.32.5:3306中導出database:webservice的所有數據，寫入到dump.sql文件中，指定-F參數表示在導出數據后重新生成一個新的binlog日志文件以記錄后續的所有數據操作。
dump.sql中的文件內容如下：

-- MySQL dump 10.13  Distrib 5.6.40, for Linux (x86_64)
--
-- Host: 172.16.32.5    Database: webservice
-- ------------------------------------------------------
-- Server version   5.5.5-10.1.9-MariaDBV1.0R012D002-20171127-1822
 
/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
/*!40101 SET NAMES utf8 */;
/*!40103 SET @OLD_TIME_ZONE=@@TIME_ZONE */;
/*!40103 SET TIME_ZONE='+00:00' */;
/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;
/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;
/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;
 
--
-- Table structure for table `building`
--
 
DROP TABLE IF EXISTS `building`;
/*!40101 SET @saved_cs_client     = @@character_set_client */;
/*!40101 SET character_set_client = utf8 */;
CREATE TABLE `building` (
  `Id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT 'ID',
  `BuildingId` varchar(64) NOT NULL COMMENT '虛擬建築Id',
  `Status` tinyint(4) NOT NULL DEFAULT '0' COMMENT '虛擬建築狀態：0、處理中；1、正常；-1，停止；-2，銷毀中；-3，已銷毀',
  `BuildingName` varchar(128) NOT NULL DEFAULT '' COMMENT '虛擬建築名稱',
  `CreateTime` timestamp NOT NULL DEFAULT '2017-12-03 16:00:00' COMMENT '創建時間',
  `UpdateTime` timestamp NOT NULL DEFAULT '2017-12-03 16:00:00' COMMENT '更新時間',
  PRIMARY KEY (`Id`),
  UNIQUE KEY `BuildingId` (`BuildingId`)
) ENGINE=InnoDB AUTO_INCREMENT=2010 DEFAULT CHARSET=utf8 COMMENT='虛擬建築表';
/*!40101 SET character_set_client = @saved_cs_client */;
 
--
-- Dumping data for table `building`
--
 
LOCK TABLES `building` WRITE;
/*!40000 ALTER TABLE `building` DISABLE KEYS */;
INSERT INTO `building` VALUES (2000,'building-2',0,'6YFcmntKrNBIeTA','2018-05-30 13:28:31','2018-05-30 13:28:31'),(2001,'building-4',0,'4rY8PcVUZB1vtrL','2018-05-30 13:28:34','2018-05-30 13:28:34'),(2002,'building-5',0,'uyjHVUYrg9KeGqi','2018-05-30 13:28:37','2018-05-30 13:28:37'),(2003,'building-7',0,'DNhyEBO4XEkXpgW','2018-05-30 13:28:40','2018-05-30 13:28:40'),(2004,'building-1',0,'TmtYX6ZC0RNB4Re','2018-05-30 13:28:43','2018-05-30 13:28:43'),(2005,'building-6',0,'t8YQcjeXefWpcyU','2018-05-30 13:28:49','2018-05-30 13:28:49'),(2006,'building-10',0,'WozgBc2IchNyKyE','2018-05-30 13:28:55','2018-05-30 13:28:55'),(2007,'building-3',0,'yJk27cmLOVQLHf1','2018-05-30 13:28:58','2018-05-30 13:28:58'),(2008,'building-9',0,'RSbjotAh8tymfxs','2018-05-30 13:29:04','2018-05-30 13:29:04'),(2009,'building-8',0,'IBOMlhaXV6k226m','2018-05-30 13:29:31','2018-05-30 13:29:31');
/*!40000 ALTER TABLE `building` ENABLE KEYS */;
UNLOCK TABLES;
 
/*!40103 SET TIME_ZONE=@OLD_TIME_ZONE */;
 
/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;
/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;
/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;
/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;
/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;
 
-- Dump completed on 2018-06-02 14:23:51
從以上內容可以看出，mysqldump導出的sql文件包含create table, drop table以及插入數據的sql語句，但是不包含create database建庫語句。

使用go-mysql-elasticsearch開源工具同步數據到ES
go-mysql-elasticsearch是用於同步mysql數據到ES集群的一個開源工具，項目github地址：https://github.com/siddontang/go-mysql-elasticsearch

go-mysql-elasticsearch的基本原理是：如果是第一次啟動該程序，首先使用mysqldump工具對源mysql數據庫進行一次全量同步，通過elasticsearch client執行操作寫入數據到ES；然后實現了一個mysql client,作為slave連接到源mysql,源mysql作為master會將所有數據的更新操作通過binlog event同步給slave， 通過解析binlog event就可以獲取到數據的更新內容，之后寫入到ES.

另外，該工具還提供了操作統計的功能，每當有數據增刪改操作時，會將對應操作的計數加1，程序啟動時會開啟一個http服務，通過調用http接口可以查看增刪改操作的次數。

使用限制：
    1. MySQL supported version < 8.0
    2. ES supported version < 6.0
    3. mysql binlog必須是ROW模式
    4. 要同步的mysql數據表必須包含主鍵，否則直接忽略，這是因為如果數據表沒有主鍵，UPDATE和DELETE操作就會因為在ES中找不到對應的document而無法進行同步
    5. 不支持程序運行過程中修改表結構
    6. 要賦予用於連接mysql的賬戶RELOAD權限以及REPLICATION權限, SUPER權限：
       GRANT REPLICATION SLAVE ON *.* TO 'elastic'@'172.16.32.44';
       GRANT RELOAD ON *.* TO 'elastic'@'172.16.32.44';
       UPDATE mysql.user SET Super_Priv='Y' WHERE user='elastic' AND host='172.16.32.44';
使用方式：
git clone https://github.com/siddontang/go-mysql-elasticsearch
cd go-mysql-elasticsearch/src/github.com/siddontang/go-mysql-elasticsearch
make，耐心等待
vi etc/river.toml, 修改配置文件，同步172.16.0.101:3306數據庫中的webservice.building表到ES集群172.16.32.64:9200的building index(更詳細的配置文件說明可以參考項目文檔)
    # MySQL address, user and password
    # user must have replication privilege in MySQL.
    my_addr = "172.16.0.101:3306"
    my_user = "bellen"
    my_pass = "Elastic_123"
    my_charset = "utf8"
    
    # Set true when elasticsearch use https
    #es_https = false
    # Elasticsearch address
    es_addr = "172.16.32.64:9200"
    # Elasticsearch user and password, maybe set by shield, nginx, or x-pack
    es_user = ""
    es_pass = ""
    
    # Path to store data, like master.info, if not set or empty,
    # we must use this to support breakpoint resume syncing.
    # TODO: support other storage, like etcd.
    data_dir = "./var"
    
    # Inner Http status address
    stat_addr = "127.0.0.1:12800"
    
    # pseudo server id like a slave
    server_id = 1001
    
    # mysql or mariadb
    flavor = "mariadb"
    
    # mysqldump execution path
    # if not set or empty, ignore mysqldump.
    mysqldump = "mysqldump"
    
    # if we have no privilege to use mysqldump with --master-data,
    # we must skip it.
    #skip_master_data = false
    
    # minimal items to be inserted in one bulk
    bulk_size = 128
    
    # force flush the pending requests if we don't have enough items >= bulk_size
    flush_bulk_time = "200ms"
    
    # Ignore table without primary key
    skip_no_pk_table = false
    
    # MySQL data source
    [[source]]
    schema = "webservice"
    tables = ["building"]
    [[rule]]
    schema = "webservice"
    table = "building"
    index = "building"
    type = "buildingtype"
在ES集群中創建building index, 因為該工具並沒有使用ES的auto create index功能，如果index不存在會報錯

執行命令：./bin/go-mysql-elasticsearch -config=./etc/river.toml

控制台輸出結果：

2018/06/02 16:13:21 INFO  create BinlogSyncer with config {1001 mariadb 172.16.0.101 3306 bellen   utf8 false false <nil> false false 0 0s 0s 0}
2018/06/02 16:13:21 INFO  run status http server 127.0.0.1:12800
2018/06/02 16:13:21 INFO  skip dump, use last binlog replication pos (mysql-bin.000001, 120) or GTID %!s(<nil>)
2018/06/02 16:13:21 INFO  begin to sync binlog from position (mysql-bin.000001, 120)
2018/06/02 16:13:21 INFO  register slave for master server 172.16.0.101:3306
2018/06/02 16:13:21 INFO  start sync binlog at binlog file (mysql-bin.000001, 120)
2018/06/02 16:13:21 INFO  rotate to (mysql-bin.000001, 120)
2018/06/02 16:13:21 INFO  rotate binlog to (mysql-bin.000001, 120)
2018/06/02 16:13:21 INFO  save position (mysql-bin.000001, 120)
測試：向mysql中插入、修改、刪除數據，都可以反映到ES中
使用體驗
go-mysql-elasticsearch完成了最基本的mysql實時同步數據到ES的功能，業務如果需要更深層次的功能如允許運行中修改mysql表結構，可以進行自行定制化開發。
異常處理不足，解析binlog event失敗直接拋出異常
該項目並沒有被其應用於生產環境中，所以使用過程中建議通讀源碼，知其利弊。