准备

  • 对于自建 MySQL , 需要先开启 Binlog 写入功能，配置 binlog-format 为 ROW 模式，my.cnf 中配置如下

    1. [mysqld]
    2. log-bin=mysql-bin # 开启 binlog
    3. binlog-format=ROW # 选择 ROW 模式
    4. server_id=1 # 配置 MySQL replaction 需要定义，不要和 canal 的 slaveId 重复
    • 注意：针对阿里云 RDS for MySQL , 默认打开了 binlog , 并且账号默认具有 binlog dump 权限 , 不需要任何权限或者 binlog 设置,可以直接跳过这一步

  • 授权 canal 链接 MySQL 账号具有作为 MySQL slave 的权限, 如果已有账户可直接 grant

    1. CREATE USER canal IDENTIFIED BY 'canal';  
    2. GRANT SELECT, REPLICATION SLAVE, REPLICATION CLIENT ON *.* TO 'canal'@'%';
    3. -- GRANT ALL PRIVILEGES ON *.* TO 'canal'@'%' ;
    4. FLUSH PRIVILEGES;

启动

  • 下载 canal, 访问 release 页面 , 选择需要的包下载, 如以 1.0.17 版本为例

    1. wget https://github.com/alibaba/canal/releases/download/canal-1.0.17/canal.deployer-1.0.17.tar.gz

  • 解压缩

    1. mkdir /tmp/canal
    2. tar zxvf canal.deployer-$version.tar.gz  -C /tmp/canal
    • 解压完成后，进入 /tmp/canal 目录，可以看到如下结构
      1. drwxr-xr-x 2 jianghang jianghang  136 2013-02-05 21:51 bin
      2. drwxr-xr-x 4 jianghang jianghang  160 2013-02-05 21:51 conf
      3. drwxr-xr-x 2 jianghang jianghang 1.3K 2013-02-05 21:51 lib
      4. drwxr-xr-x 2 jianghang jianghang   48 2013-02-05 21:29 logs

  • 配置修改

    1. vi conf/example/instance.properties
    1. ## mysql serverId
    2. canal.instance.mysql.slaveId = 1234
    3. #position info，需要改成自己的数据库信息
    4. canal.instance.master.address = 127.0.0.1:3306 
    5. canal.instance.master.journal.name = 
    6. canal.instance.master.position = 
    7. canal.instance.master.timestamp = 
    8. #canal.instance.standby.address = 
    9. #canal.instance.standby.journal.name =
    10. #canal.instance.standby.position = 
    11. #canal.instance.standby.timestamp = 
    12. #username/password，需要改成自己的数据库信息
    13. canal.instance.dbUsername = canal  
    14. canal.instance.dbPassword = canal
    15. canal.instance.defaultDatabaseName =
    16. canal.instance.connectionCharset = UTF-8
    17. #table regex
    18. canal.instance.filter.regex = .\*\\\\..\*
    • canal.instance.connectionCharset 代表数据库的编码方式对应到 java 中的编码类型，比如 UTF-8，GBK , ISO-8859-1
    • 如果系统是1个 cpu，需要将 canal.instance.parser.parallel 设置为 false

  • 启动

    1. sh bin/startup.sh

  • 查看 server 日志

    1. vi logs/canal/canal.log</pre>
    1. 2013-02-05 22:45:27.967 [main] INFO  com.alibaba.otter.canal.deployer.CanalLauncher - ## start the canal server.
    2. 2013-02-05 22:45:28.113 [main] INFO  com.alibaba.otter.canal.deployer.CanalController - ## start the canal server[10.1.29.120:11111]
    3. 2013-02-05 22:45:28.210 [main] INFO  com.alibaba.otter.canal.deployer.CanalLauncher - ## the canal server is running now ......

  • 查看 instance 的日志

    1. vi logs/example/example.log
    1. 2013-02-05 22:50:45.636 [main] INFO  c.a.o.c.i.spring.support.PropertyPlaceholderConfigurer - Loading properties file from class path resource [canal.properties]
    2. 2013-02-05 22:50:45.641 [main] INFO  c.a.o.c.i.spring.support.PropertyPlaceholderConfigurer - Loading properties file from class path resource [example/instance.properties]
    3. 2013-02-05 22:50:45.803 [main] INFO  c.a.otter.canal.instance.spring.CanalInstanceWithSpring - start CannalInstance for 1-example 
    4. 2013-02-05 22:50:45.810 [main] INFO  c.a.otter.canal.instance.spring.CanalInstanceWithSpring - start successful....

  • 关闭

    1. sh bin/stop.sh

其他方式

  • canal 的 docker 模式快速启动，参考：[[Docker QuickStart]]
  • canal 链接 Aliyun RDS for MySQL，参考：[[Aliyun RDS QuickStart]]
  • canal 消息投递给 kafka/RocketMQ，参考：[[Canal-Kafka-RocketMQ-QuickStart]]