MysqlsMom: 同步mysql数据到elasticsearch的利器

原文链接

https://www.jianshu.com/p/fb96ab7fbde9

把Mysql的数据同步到Elasticsearch是个很常见的需求，但在Github里找到的同步工具用起来或多或少都有些别扭。
例如：某记录内容为"aaa|bbb|ccc"，将其按|分割成数组同步到es，这样的简单任务都难以实现，再加上配置繁琐，文档语焉不详...
所以我写了个同步工具MysqlsMom：力求用最简单的配置完成复杂的同步任务。目前除了我所在的部门，也有越来越多的互联网公司在生产环境中使用该工具了。
欢迎各位大佬进行试用并提出意见，任何建议、鼓励、批评都受到欢迎。
github: https://github.com/m358807551/mysqlsmom

MysqlsMom.jpeg

简介：同步mysql数据到elasticsearch的工具；
QQ、微信：358807551

特点

1. 纯Python编写；
2. 有全量、增量更新两种模式；
3. 全量更新只占用少量内存；支持通过sql语句同步数据；
4. 增量更新自动断点续传；
5. 取自mysql的数据可经过一系列自定义函数的处理后再同步至elasticsearch；
6. 能用非常简单的配置完成复杂的同步任务；

环境

• python2.7；
• 如需增量同步，需要mysql开启binlog（binlog-format=row）且本地开启redis；

快速开始

全量同步MySql数据到es

1. clone 项目到本地；

2. 安装依赖；

   cd mysqlsmom
   pip install -r requirements.txt
   

   默认支持 elasticsearch-2.4版本，支持其它版本请运行（将5.4换成需要的elasticsearch版本）

   pip install --upgrade elasticsearch==5.4
   

3. 编辑 ./config/example_init.py，按注释提示修改配置；

   # coding=utf-8
   STREAM = "INIT"
   # 修改数据库连接
   CONNECTION = {
       'host': '127.0.0.1',
       'port': 3306,
       'user': 'root',
       'passwd': ''
   }
   # 修改elasticsearch节点
   NODES = [{"host": "127.0.0.1", "port": 9200}]
   TASKS = [
       {
           "stream": {
               "database": "test_db",  # 在此数据库执行sql语句
               "sql": "select * from person"  # 将该sql语句选中的数据同步到 elasticsearch
           },
           "jobs": [
               {
                   "actions": ["insert", "update"],
                   "pipeline": [
                       {"set_id": {"field": "id"}}  # 默认设置 id字段的值 为elasticsearch中的文档id
                   ],
                   "dest": {
                       "es": {
                           "action": "upsert",
                           "index": "test_index",   # 设置 index
                           "type": "test",          # 设置 type
                           "nodes": NODES
                       }
                   }
               }
           ]
       }
   ]
   

4. 运行

cd mysqlsmom
python mysqlsmom.py ./config/example_init.py

等待同步完成即可；

增量同步MySql数据到es

1. 确保要增量同步的MySql数据库开启binlog，且本地开启redis(为了存储最后一次读到的binlog文件名及读到的位置。未来可能支持本地文件存储该信息。)

2. 下载项目到本地，且安装好依赖后，编辑 ./config/example_init.py，按注释提示修改配置；

   # coding=utf-8
   STREAM = "BINLOG"
   SERVER_ID = 99  # 确保每个用于binlog同步的配置文件的SERVER_ID不同；
   SLAVE_UUID = __name__
   # 配置开启binlog权限的MySql连接
   BINLOG_CONNECTION = {
       'host': '127.0.0.1',
       'port': 3306,
       'user': 'root',
       'passwd': ''
   }
   # 配置es节点
   NODES = [{"host": "127.0.0.1", "port": 9200}]
   TASKS = [
       {
           "stream": {
               "database": "test_db",  # [table]所在的数据库
               "table": "person"  # 监控该表的binlog
           },
           "jobs": [
               {
                   "actions": ["insert", "update"],
                   "pipeline": [
                       {"only_fields": {"fields": ["id", "name", "age"]}},  # 只同步这些字段到es，注释掉该行则同步全部字段的值到es
                       {"set_id": {"field": "id"}}  # 设置es中文档_id的值取自 id(或根据需要更改)字段
                   ],
                   "dest": {
                       "es": {
                           "action": "upsert",
                           "index": "test_index",  # 设置 index
                           "type": "test",         # 设置 type
                           "nodes": NODES
                       }
                   }
               }
           ]
       }
   ]
   

3. 运行

   cd mysqlsmom
   python mysqlsmom.py ./config/example_binlog.py
   

   该进程会一直运行，实时同步新增和更改后的数据到elasticsearch；

   注意：第一次运行该进程时不会同步MySql中已存在的数据，从第二次运行开始，将接着上次同步停止时的位置继续同步；

   同步旧数据请看全量同步MySql数据到es；

组织架构

all.png

Pipeline

如果需要从Mysql获取数据再进行特殊处理再同步到elasticsearch，pipeline组件会派上用场。

无论数据来自于全量同步的Sql语句或是通过实时分析binlog。

例如：

• 只同步某些字段到es

  "pipeline": [
    {"only_fields": {"fields": ["id", "name"]}}, # 只同步 id 和 name字段
      ...
  ]
  

• 重命名字段

  "pipeline": [
    {"replace_fields": {"name": ["name1", "name2"]}}, # 将name重命名为name1和name2
      ...
  ]
  

• 甚至可以执行跨库数据库查询

  "pipeline": [
    {
        "do_sql": {
            "database": "db2",
            "connection": CONNECTION2,
            "sql": "select company, personid from company_manager where personid = {id}"  # id 的值会自动替换
        }
    }
      ...
  ]
  

支持编写自定义函数，只需在 row_handlers.py 中加入，之后可在pipeline中配置调用。

row_handlers.py中预定义了一些数据处理函数，但可能需要自定义的情况更多。

常见问题

能否把数据同步到多个es索引？

目前增量同步支持，只需修改配置文件中的[dest]

"dest": [
        {
            "es": {
            "action": "upsert",
            "index": "index1",  # 同步到 es index1.type1
            "type": "type1",
            "nodes": NODES
            }
        },
        {
            "es": {
            "action": "upsert",
            "index": "index2",  # 同时同步到 es index1.type1
            "type": "type2",
            "nodes": NODES
            }
        }
 ]

全量同步很快会支持该功能；

为什么我的增量同步不及时？

1. 连接本地数据库增量同步不及时

   该情况暂未收到过反馈，如能复现请联系作者。

2. 连接线上数据库发现增量同步不及时

   2.1 推荐使用内网IP连接数据库。连接线上数据库（如开启在阿里、腾讯服务器上的Mysql）时，推荐使用内网IP地址，因为外网IP会受到带宽等限制导致获取binlog数据速度受限，最终可能造成同步延时。

待改进

1. 据部分用户反馈，全量同步百万级以上的数据性能不佳。

未完待续

文档近期会大幅度更新完善，任何问题、建议都收到欢迎，请在issues留言，会在24小时内回复；或联系QQ、微信: 358807551；