【Canal源码分析】配置项
2018-05-30 本文已影响274人
端木轩
本文讲解canal中的一些配置含义。
一、配置加载图
配置加载.png
二、配置文件canal.properties
2.1 common参数定义
比如可以将instance.properties的公用参数，抽取放置到这里，这样每个instance启动的时候就可以共享. 【instance.properties配置定义优先级高于canal.properties】
| 参数名 | 含义 | 默认值 |
|---|---|---|
| canal.id | 每个canal server实例的唯一标识，暂无实际意义 | 1 |
| canal.ip | canal server绑定的本地IP信息，如果不配置，默认选择一个本机IP进行启动服务 | 无 |
| canal.port | canal server提供socket服务的端口 | 11111 |
| canal.zkServers | canal server链接zookeeper集群的链接信息，例子：127.0.0.1:2181,127.0.0.1:2182 | 无 |
| canal.zookeeper.flush.period | canal持久化数据到zookeeper上的更新频率，单位毫秒 | 1000 |
| canal.file.data.dir | canal持久化数据到file上的目录 | ../conf (默认和instance.properties为同一目录，方便运维和备份)，如果想要HA，不需要配置这个，因为无法通过文件实现高可用 |
| canal.file.flush.period | canal持久化数据到file上的更新频率，单位毫秒 | 1000 |
| canal.instance.memory.batch.mode | canal内存store中数据缓存模式：1. ITEMSIZE : 根据buffer.size进行限制，只限制记录的数量；2. MEMSIZE : 根据buffer.size * buffer.memunit的大小，限制缓存记录的大小 | MEMSIZE |
| canal.instance.memory.buffer.size | canal内存store中可缓存buffer记录数，需要为2的指数 | 16384 |
| canal.instance.memory.buffer.memunit | 内存记录的单位大小，默认1KB，和buffer.size组合决定最终的内存使用大小 | 1024 |
| canal.instance.transactionn.size | 最大事务完整解析的长度支持,超过该长度后，一个事务可能会被拆分成多次提交到canal store中，无法保证事务的完整可见性 | 1024 |
| canal.instance.fallbackIntervalInSeconds | canal发生mysql切换时，在新的mysql库上查找binlog时需要往前查找的时间，单位秒。说明：mysql主备库可能存在解析延迟或者时钟不统一，需要回退一段时间，保证数据不丢 | 60 |
| canal.instance.detecting.enable | 是否开启心跳检查 | false |
| canal.instance.detecting.sql | 心跳检查sql | insert 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_RCVBUF | 16384 |
| canal.instance.network.sendBufferSize | 网络链接参数，SocketOptions.SO_SNDBUF | 16384 |
| canal.instance.network.soTimeout | 网络链接参数，SocketOptions.SO_TIMEOUT | 30 |
| canal.instance.filter.query.dcl | 是否忽略DCL的query语句，比如grant/create user等 | false |
| canal.instance.filter.query.dml | 是否忽略DML的query语句，比如insert/update/delete table.(mysql5.6的ROW模式可以包含statement模式的query记录) | false |
| canal.instance.filter.query.ddl | 是否忽略DDL的query语句，比如create table/alater table/drop table/rename table/create index/drop index. (目前支持的ddl类型主要为table级别的操作，create databases/trigger/procedure暂时划分为dcl类型) | false |
| canal.instance.filter.druid.ddl | v1.0.25版本新增，是否启用druid的DDL parse的过滤，基于sql的完整parser可以解决之前基于正则匹配补全的问题，默认为true | true |
| canal.instance.get.ddl.isolation | ddl语句是否隔离发送，开启隔离可保证每次只返回发送一条ddl数据，不和其他dml语句混合返回.(otter ddl同步使用) | false |
| canal.instance.binlog.format | 支持的binlogFormat,如果设置会执行强校验 | 无，可以设置ROW,STATEMENT,MIXED |
| canal.instance.binlog.image | 支持的binlogImage,如果设置会执行强校验 | 无，可以设置为FULL,MINIMAL,NOBLOB |
2.2 instance参数定义
| 参数名 | 含义 | 默认值 |
|---|---|---|
| canal.destinations | 当前server上部署的instance列表 | 无，如果要动态生效，不需要进行配置 |
| canal.conf.dir | conf/目录所在的路径 | ../conf |
| canal.auto.scan | 开启instance自动扫描，如果开启后，会扫描conf目录下的文件，进行instance的自动重启、新增、删除等动作 | true |
| canal.auto.scan.interval | instance自动扫描的间隔时间，单位秒 | 5 |
| canal.instance.global.mode | 全局配置加载方式 | spring |
| canal.instance.global.lazy | 全局lazy模式 | false |
| canal.instance.global.manager.address | 全局的manager配置方式的链接信息 | 无，目前加载方式全部为spring，此配置无用 |
| canal.instance.global.spring.xml | 全局的spring配置方式的组件文件 | classpath:spring/file-instance.xml (spring目录相对于canal.conf.dir)，我们应该使用default那个xml |
| canal.instance.example.mode；canal.instance.example.lazy；canal.instance.example.spring.xml；... | instance级别的配置定义，如有配置，会自动覆盖全局配置定义模式。命名规则：canal.instance.{name}.xxx | 无 |
| canal.instance.tsdb.spring.xml | v1.0.25版本新增,全局的tsdb配置方式的组件文件 | classpath:spring/tsdb/h2-tsdb.xml (spring目录相对于canal.conf.dir)，我们应该用mysql那个 |
三、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时
server第一次启动时，会自动扫描conf目录下，将文件名做为instance name，启动对应的instance
server运行过程中，会根据canal.auto.scan.interval定义的频率，进行扫描
- 发现目录有新增，启动新的instance
- 发现目录有删除，关闭老的instance
- 发现对应目录的instance.properties有变化，重启instance
| 参数名 | 含义 | 默认值 |
|---|---|---|
| canal.instance.mysql.slaveId | mysql集群配置中的serverId概念，需要保证和当前mysql集群中id唯一 | 1234 |
| canal.instance.master.address | mysql主库链接地址 | 127.0.0.1:3306 |
| canal.instance.master.journal.name | mysql主库链接时起始的binlog文件 | 无，默认不需要配置，只有在指定需要重复消费的时候，才需要进行配置 |
| canal.instance.master.position | mysql主库链接时起始的binlog偏移量 | 无，同上一个配置 |
| canal.instance.master.timestamp | mysql主库链接时起始的binlog的时间戳 | 无，同上一个配置 |
| canal.instance.master.gtid | gtid的值 | 无 |
| canal.instance.dbUsername | mysql数据库帐号 | canal |
| canal.instance.dbPassword | mysql数据库密码 | canal |
| canal.instance.defaultDatabaseName | mysql链接时默认schema | |
| canal.instance.connectionCharset | mysql 数据解析编码 | UTF-8 |
| canal.instance.filter.regex | mysql 数据解析关注的表，Perl正则表达式.多个正则之间以逗号(,)分隔，转义符需要双斜杠(\) 。注意：此过滤条件只针对row模式的数据有效。 | 全部表 |
| canal.instance.tsdb.enable | v1.0.25版本新增,是否开启table meta的时间序列版本记录功能 | true |
| canal.instance.tsdb.dir | v1.0.25版本新增,table meta的时间序列版本的本地存储路径，默认为instance目录 | ${canal.file.data.dir:../conf}/${canal.instance.destination:} |
| canal.instance.tsdb.url | v1.0.25版本新增,table meta的时间序列版本存储的数据库链接串，比如例子为本地嵌入式数据库 | jdbc:h2:${canal.instance.tsdb.dir}/h2;CACHE_SIZE=1000;MODE=MYSQL;应该改为mysql |
| canal.instance.tsdb.dbUsername | v1.0.25版本新增,table meta的时间序列版本存储的数据库链接账号 | canal |
| canal.instance.tsdb.dbUsername | v1.0.25版本新增,table meta的时间序列版本存储的数据库链接密码 | canal |
| canal.instance.gtidon | 是否是GTID模式 | false |
