From 0ec8538a30c279b087eaa9933c221b51e789fb3c Mon Sep 17 00:00:00 2001 From: agapple Date: Tue, 19 Mar 2013 04:45:43 -0700 Subject: [PATCH] Created AdminGuide (markdown) --- AdminGuide.md | 440 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 440 insertions(+) create mode 100644 AdminGuide.md diff --git a/AdminGuide.md b/AdminGuide.md new file mode 100644 index 0000000..c06c260 --- /dev/null +++ b/AdminGuide.md @@ -0,0 +1,440 @@ + +

环境要求

+

1. 操作系统

+

a. 纯java开发，windows/linux均可支持

+

b. jdk建议使用1.6.25以上的版本，稳定可靠，目前阿里巴巴使用基本为此版本.

+

+

2. mysql要求

+

a. 目前canal支持mysql 5.5版本以下，对mysql5.6暂不支持，(mysql4.x版本没有经过严格测试，理论上是可以兼容)

+

b. canal的原理是基于mysql binlog技术，所以这里一定需要开启mysql的binlog写入功能，并且配置binlog模式为row.

+
[mysqld]  
+log-bin=mysql-bin #添加这一行就ok  
+binlog-format=ROW #选择row模式  
+server_id=1 #配置mysql replaction需要定义，不能和canal的slaveId重复
+
c. canal的原理是模拟自己为mysql slave，所以这里一定需要做为mysql slave的相关权限 
CREATE USER canal IDENTIFIED BY 'canal';    
+GRANT SELECT, REPLICATION SLAVE, REPLICATION CLIENT ON *.* TO 'canal'@'%';  
+-- GRANT ALL PRIVILEGES ON *.* TO 'canal'@'%' ;  
+FLUSH PRIVILEGES;
+ 针对已有的账户可通过grants查询权限：
show grants for 'canal'
+
+

+

部署

+

1. 获取发布包

+

方法1： (直接下载)

+

访问：https://github.com/alibaba/canal/tree/gh-pages/download ，会列出所有历史的发布版本包

+

下载方式，比如以1.0.2版本为例子：

+
wget https://raw.github.com/alibaba/canal/gh-pages/download/canal.deployer-1.0.2.tar.gz
+

方法2: (自己编译)

+
git clone git@github.com:alibaba/canal.git
+git co canal-$version #切换到对应的版本上
+mvn clean install -Denv=release
+

执行完成后，会在canal工程根目录下生成一个target目录，里面会包含一个 canal.deployer-$verion.tar.gz

+

+

2. 目录结构

+

解压缩发布包后，可得如下目录结构：

+
drwxr-xr-x 2 jianghang jianghang  136 2013-03-19 15:03 bin
+drwxr-xr-x 4 jianghang jianghang  160 2013-03-19 15:03 conf
+drwxr-xr-x 2 jianghang jianghang 1352 2013-03-19 15:03 lib
+drwxr-xr-x 2 jianghang jianghang   48 2013-03-19 15:03 logs
+

+

3. 启动/停止

+

linux启动 :

+
sh startup.sh
+

linux带debug方式启动：(默认使用suspend=y，阻塞等待你remote debug链接成功)

+
sh startup.sh debug 9099
+

linux停止：

+
sh stop.sh
+

+

几点注意：

+
    +
  1. linux启动完成后，会在bin目录下生成canal.pid，stop.sh会读取canal.pid进行进程关闭
    2. +
  2. startup.sh默认读取系统环境变量中的which java获得JAVA执行路径，需要设置PATH=$JAVA_HOME/bin环境变量
    3. +
+

-------------

+

windows启动：(windows支持相对比较弱)

+
startup.bat
+

windows停止：直接关闭终端即可

+

+

配置

+

介绍配置之前，先了解下canal的配置加载方式：

+

+

+

canal配置方式有两种：

+
    +
  1. ManagerCanalInstanceGenerator： 基于manager管理的配置方式，目前alibaba内部配置使用这种方式。大家可以实现CanalConfigClient，连接各自的管理系统，即可完成接入。
    2. +
  2. SpringCanalInstanceGenerator：基于本地spring xml的配置方式，目前开源版本已经自带该功能所有代码，建议使用
    3. +
+

Spring配置

+

spring配置的原理是将整个配置抽象为两部分：

+ +

通过spring的PropertyPlaceholderConfigurer通过机制将其融合，生成一份instance实例对象，每个instance对应的组件都是相互独立的，互不影响

+

+

properties配置文件

+

properties配置分为两部分：

+ +

canal.properties介绍：

+

+

canal配置主要分为两部分定义：

+

1. instance列表定义 (列出当前server上有多少个instance，每个instance的加载方式是spring/manager等)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名字参数说明默认值
canal.destinations当前server上部署的instance列表无
canal.conf.dirconf/目录所在的路径../conf
canal.auto.scan开启instance自动扫描
如果配置为true，canal.conf.dir目录下的instance配置变化会自动触发：
a. instance目录新增： 触发instance配置载入，lazy为true时则自动启动
b. instance目录删除：卸载对应instance配置，如已启动则进行关闭
c. instance.properties文件变化：reload instance配置，如已启动自动进行重启操作		true
canal.auto.scan.intervalinstance自动扫描的间隔时间，单位秒5
canal.stopInstanceAsPossiblecanal client出现disconnet时，是否需要关闭instancetrue
canal.instance.global.mode全局配置加载方式spring
canal.instance.global.lazy全局lazy模式false
canal.instance.global.manager.address全局的manager配置方式的链接信息无
canal.instance.global.spring.xml全局的spring配置方式的组件文件classpath:spring/memory-instance.xml
(spring目录相对于canal.conf.dir)
canal.instance.example.mode
canal.instance.example.lazy
canal.instance.example.spring.xml
.....		instance级别的配置定义，如有配置，会自动覆盖全局配置定义模式
命名规则：canal.instance.{name}.xxx		无
+

+

+

2. common参数定义，比如可以将instance.properties的公用参数，抽取放置到这里，这样每个instance启动的时候就可以共享. 【instance.properties配置定义优先级高于canal.properties】

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名字参数说明默认值
canal.id每个canal server实例的唯一标识，暂无实际意义1
canal.ipcanal server绑定的本地IP信息，如果不配置，默认选择一个本机IP进行启动服务无
canal.portcanal server提供socket服务的端口11111
canal.zkServerscanal server链接zookeeper集群的链接信息
例子：10.20.144.22:2181,10.20.144.51:2181		无
canal.zookeeper.flush.periodcanal持久化数据到zookeeper上的更新频率，单位毫秒1000
canal.instance.memory.batch.modecanal内存store中数据缓存模式
1. ITEMSIZE : 根据buffer.size进行限制，只限制记录的数量
2. MEMSIZE : 根据buffer.size * buffer.memunit的大小，限制缓存记录的大小		MEMSIZE
canal.instance.memory.buffer.sizecanal内存store中可缓存buffer记录数，需要为2的指数16384
canal.instance.memory.buffer.memunit内存记录的单位大小，默认1KB，和buffer.size组合决定最终的内存使用大小1024
canal.instance.transactionn.size最大事务完整解析的长度支持
超过该长度后，一个事务可能会被拆分成多次提交到canal store中，无法保证事务的完整可见性		1024
canal.instance.fallbackIntervalInSecondscanal发生mysql切换时，在新的mysql库上查找binlog时需要往前查找的时间，单位秒
说明：mysql主备库可能存在解析延迟或者时钟不统一，需要回退一段时间，保证数据不丢		60
canal.instance.detecting.enable是否开启心跳检查false
canal.instance.detecting.sql心跳检查sqlinsert into retl.xdual values(1,now()) on duplicate key update x=now()
canal.instance.detecting.interval.time心跳检查频率，单位秒3
canal.instance.detecting.retry.threshold心跳检查失败重试次数3
canal.instance.detecting.heartbeatHaEnable心跳检查失败后，是否开启自动mysql自动切换
说明：比如心跳检查失败超过阀值后，如果该配置为true，canal就会自动链到mysql备库获取binlog数据		false
canal.instance.network.receiveBufferSize网络链接参数，SocketOptions.SO_RCVBUF16384
canal.instance.network.sendBufferSize网络链接参数，SocketOptions.SO_SNDBUF16384
canal.instance.network.soTimeout网络链接参数，SocketOptions.SO_TIMEOUT30
+

+

instance.properties介绍：

+

a. 在canal.properties定义了canal.destinations后，需要在canal.conf.dir对应的目录下建立同名的文件

+

比如：

+

+
canal.destinations = example1,example2
+ 这时需要创建example1和example2两个目录，每个目录里各自有一份instance.properties. +

+

ps. canal自带了一份instance.properties demo，可直接复制conf/example目录进行配置修改

+

+
cp -R example example1/
+cp -R example example2/
+ +

+

b. 如果canal.properties未定义instance列表，但开启了canal.auto.scan时

+ +

一个标准的conf目录结果：

+

+
jianghang@jianghang-laptop:~/work/canal/deployer/target/canal$ ls -l conf/
+总用量 8
+-rwxrwxrwx 1 jianghang jianghang 1677 2013-03-19 15:03 canal.properties  ##系统配置
+drwxr-xr-x 2 jianghang jianghang   88 2013-03-19 15:03 example  ## instance配置
+-rwxrwxrwx 1 jianghang jianghang 1840 2013-03-19 15:03 logback.xml ## 日志文件
+drwxr-xr-x 2 jianghang jianghang  168 2013-03-19 17:04 spring  ## spring instance莫把呢
+
+ +

+

instance.properties参数列表：

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名字参数说明默认值
canal.instance.mysql.slaveIdmysql集群配置中的serverId概念，需要保证和当前mysql集群中id唯一1234
canal.instance.master.addressmysql主库链接地址127.0.0.1:3306
canal.instance.master.journal.namemysql主库链接时起始的binlog文件无
canal.instance.master.positionmysql主库链接时起始的binlog偏移量无
canal.instance.master.timestampmysql主库链接时起始的binlog的时间戳无
canal.instance.dbUsernamemysql数据库帐号canal
canal.instance.dbPasswordmysql数据库密码canal
canal.instance.defaultDatabaseNamemysql链接时默认schema
canal.instance.connectionCharsetmysql 数据解析编码UTF-8
canal.instance.filter.regexmysql 数据解析关注的表，Perl正则表达式.*\\..*
+

+

几点说明：

+

1. mysql链接时的起始位置

+ +

2. mysql解析关注表定义

+ +

3. mysql链接的编码

+ +

+

instance.xml配置文件

+

目前默认支持的instance.xml有以下几种：

+
    +
  1. spring/memory-instance.xml
    2. +
  2. spring/default-instance.xml
    3. +
  3. spring/group-instance.xml
    4. +
+

在介绍instance配置之前，先了解一下canal如何维护一份增量订阅&消费的关系信息：

+ +

对应的两个位点组件，目前都有几种实现：

+ +

-------------------

+

memory-instance.xml介绍：

+

所有的组件(parser , sink , store)都选择了内存版模式，记录位点的都选择了memory模式，重启后又会回到初始位点进行解析

+

特点：速度最快，依赖最少(不需要zookeeper)

+

场景：一般应用在quickstart，或者是出现问题后，进行数据分析的场景，不应该将其应用于生产环境

+

+

default-instance.xml介绍：

+

所有的组件(parser , sink , store)都选择了持久化模式，目前持久化的方式主要是写入zookeeper，保证数据集群共享.

+

特点：支持HA

+

场景：生产环境，集群化部署.

+

+

group-instance.xml介绍：

+

主要针对需要进行多库合并时，可以将多个物理instance合并为一个逻辑instance，提供客户端访问。

+

场景：分库业务。 比如产品数据拆分了4个库，每个库会有一个instance，如果不用group，业务上要消费数据时，需要启动4个客户端，分别链接4个instance实例。使用group后，可以在canal server上合并为一个逻辑instance，只需要启动1个客户端，链接这个逻辑instance即可.

+

+

instance.xml设计初衷：

+

允许进行自定义扩展，比如实现了基于数据库的位点管理后，可以自定义一份自己的instance.xml，整个canal设计中最大的灵活性在于此

+

+

HA模式配置

+

1. 机器准备

+

a. 运行canal的机器： 10.20.144.22 , 10.20.144.51.

+

b. zookeeper地址为10.20.144.51:2181

+

c. mysql地址：10.20.144.15:3306

+

2. 按照部署和配置，在单台机器上各自完成配置，演示时instance name为example

+

a. 修改canal.properties，加上zookeeper配置

+

+
canal.zkServers=10.20.144.51:2181
+canal.instance.global.spring.xml = classpath:spring/default-instance.xml
+

b. 创建example目录，并修改instance.properties

+
canal.instance.mysql.slaveId = 1234 ##另外一台机器改成1235，保证slaveId不重复即可
+canal.instance.master.address = 10.20.144.15:3306
+

+

注意： 两台机器上的instance目录的名字需要保证完全一致，HA模式是依赖于instance name进行管理，同时必须都选择default-instance.xml配置

+

3. 启动两台机器的canal

+
-------
+ssh 10.20.144.51
+sh bin/startup.sh
+--------
+ssh 10.20.144.22
+sh bin/startup.sh
+

启动后，你可以查看logs/example/example.log，只会看到一台机器上出现了启动成功的日志。

+

+

比如我这里启动成功的是10.20.144.51

+
2013-03-19 18:18:20.590 [main] INFO  c.a.o.c.i.spring.support.PropertyPlaceholderConfigurer - Loading properties file from class path resource [canal.properties]
+2013-03-19 18:18:20.596 [main] INFO  c.a.o.c.i.spring.support.PropertyPlaceholderConfigurer - Loading properties file from class path resource [example/instance.properties]
+2013-03-19 18:18:20.831 [main] INFO  c.a.otter.canal.instance.spring.CanalInstanceWithSpring - start CannalInstance for 1-example 
+2013-03-19 18:18:20.845 [main] INFO  c.a.otter.canal.instance.spring.CanalInstanceWithSpring - start successful...
+

+

查看一下zookeeper中的节点信息，也可以知道当前工作的节点为10.20.144.51:11111

+
[zk: localhost:2181(CONNECTED) 15] get /otter/canal/destinations/example/running  
+{"active":true,"address":"10.20.144.51:11111","cid":1}
+

+

4. 客户端链接, 消费数据

+

a. 可以直接指定zookeeper地址和instance name，canal client会自动从zookeeper中的running节点，获取当前服务的工作节点，然后与其建立链接：

+
CanalConnector connector = CanalConnectors.newClusterConnector("10.20.144.51:2181", "example", "", "");
+

b. 链接成功后，canal server会记录当前正在工作的canal client信息，比如客户端ip，链接的端口信息等 (聪明的你，应该也可以发现，canal client也可以支持HA功能)

+
[zk: localhost:2181(CONNECTED) 17] get /otter/canal/destinations/example/1001/running
+{"active":true,"address":"10.12.48.171:50544","clientId":1001}
+

c. 数据消费成功后，canal server会在zookeeper中记录下当前最后一次消费成功的binlog位点. (下次你重启client时，会从这最后一个位点继续进行消费)

+
[zk: localhost:2181(CONNECTED) 16] get /otter/canal/destinations/example/1001/cursor
+{"@type":"com.alibaba.otter.canal.protocol.position.LogPosition","identity":{"slaveId":-1,"sourceAddress":{"address":"10.20.144.15","port":3306}},"postion":{"included":false,"journalName":"mysql-bin.002253","position":2574756,"timestamp":1363688722000}}
+
+

+

5. 重启一下canal server

+

停止正在工作的10.20.144.51的canal server

+
ssh 10.20.144.51 
+sh bin/stop.sh
+

这时10.20.144.22会立马启动example instance，提供新的数据服务

+
[zk: localhost:2181(CONNECTED) 19] get /otter/canal/destinations/example/running
+{"active":true,"address":"10.20.144.22:11111","cid":1}
+
+

与此同时，客户端也会随着canal server的切换，通过获取zookeeper中的最新地址，与新的canal server建立链接，继续消费数据，整个过程自动完成

+

+ + \ No newline at end of file