元数据同步工具

MariaDB 的架构使集群中的多个 MariaDB 实例均为主机模式，都可对外提供读写服务。由于各实例的元数据均只存储在该实例本身，MariaDB 实例组件提供了元数据同步工具，用来保证 MariaDB 服务的高可用。当一个 MariaDB 实例退出后，连接该实例的应用可以切换到其它实例，获得对等的读写服务。

Note:

在 v3.4.2 及以上版本的 MariaDB 实例组件中，引入实例组功能，用于替代元数据同步工具，以更快捷的方式搭建高可用集群。

逻辑架构

MariaDB 元数据同步工具的基本原理是 MariaDB 服务进程通过审计插件输出审计日志，元数据同步工具从审计日志中提取 SQL 语句，连接到其它 MariaDB 实例执行，以达到元数据同步的目的。包含元数据同步工具的集群架构如下：

在上图中，meta_sync 即同步工具进程，每一个 MariaDB 实例都有一个对应的同步工具在运行。该进程独立于 MariaDB 服务进程运行，用于对 MariaDB 的审计日志文件 server_audit.log 进行分析处理。由于用户的业务数据存储于底层的 SequoiaDB 数据库集群中，因此只要 MariaDB 层的元数据在各实例间完成同步，连接 MariaDB 实例的客户端就可以访问到一致的数据，实现了 MariaDB 服务的高可用能力。

工具适用范围

本工具需要与 MariaDB 实例组件配套使用，可与常见的 DDL 和 DCL 命令进行同步。由于审计插件的特定限制，该工具的使用存在如下约束：

不支持在不同实例上并发对相同数据库对象进行 DDL 操作，会造成一致性问题，如修改同一张表的属性
由于同步工具需要过滤掉其它同步工具同步到本实例的操作，因此所有通过其它实例所在主机连接到本实例执行的操作产生的审计日志，都会被过滤掉（审计日志中会记录发起命令的客户端所在主机地址），包括用户或其它程序在其它实例所在主机连接到本实例执行的操作
不支持在 DDL 语句中使用'\r\n'、'\n'及'\t'，会造成实例间元数据不一致
不支持在语句内部使用注释，如在行末使用"--"增加注释
只同步审计日志中标识返回码为 0 的操作，因此如果操作中涉及到多个数据库对象，且在部分对象上操作失败，导致最终返回码非 0，则该操作不会被同步，如同时 drop 多个表，但其中有些表并不存在
目前不支持一台主机上多个 MariaDB 实例间同步，且所有主机上的 MariaDB 实例需使用相同的服务端口
需要在每个 MariaDB 环境中部署审计插件及同步工具
MariaDB 实例服务器之间需要使用主机名互通
支持同步 ALTER、CREATE、DECLARE、GRANT、REVOKE 和 FLUSH 操作，其它操作暂不支持
支持 python2.7+ 版本，不支持 python3 版本
需要使用 v3.4 或以上版本的 MariaDB 实例组件

安装

MariaDB 元数据同步工具以 python 脚本的形式随 MariaDB 实例组件的安装包一起发布，在安装 MariaDB 实例组件的过程中会被一同安装，工具路径在 MariaDB 实例组件安装路径下的 tools 目录下，目录结构如下：

tools/
└── metaSync
    ├── config.sample
    ├── keywords.py
    ├── log.config.sample
    ├── meta_sync.py
    └── README.md

其中，meta_sync.py 为同步工具主程序，config.sample 为工具配置文件样例，log.config.sample 为日志配置文件样例。MariaDB 实例组件安装目录下 lib/plugin 中已经存在动态库 server_audit.so ，无需额外安装，只需检测下是否存在即可。

配置审计插件

配置审计插件之前，需要先完成 MariaDB 环境的搭建及实例启动，之后再重启 MariaDB 服务。所有的 MariaDB 环境都需要完成该插件配置。具体的配置步骤如下：

切换到 MariaDB 实例组件安装用户（默认为 sdbadmin）
```
$ su - sdbadmin
$ cd /opt/sequoiasql/mariadb
```
登录 MariaDB 客户端，在所有 MariaDB 实例上创建用于同步元数据的 MariaDB 用户并授予所有权限，用户名与密码在所有实例上保持一致
```
MariaDB [(none)]> CREATE USER 'sdbadmin'@'%' IDENTIFIED BY 'sdbadmin';
MariaDB [(none)]> GRANT all on *.* TO 'sdbadmin'@'%' with grant option;
```
Note:
- 登录 MariaDB 客户端步骤可参考连接章节。
- 示例中使用的密码'sdbadmin'仅为示例，用户可根据需要自行设置安全的密码。
创建审计日志存储目录，如下以端口为 6101 的 MariaDB 实例为例，创建 auditlog 目录：
```
$ mkdir database/6101/auditlog
```

修改 MariaDB 实例的配置文件

$ vi database/6101/auto.cnf

在[mysqld]部分添加以下内容：

# 加载审计插件
plugin-load=server_audit=server_audit.so
# 审计记录的审计，建议只记录需要同步的DCL和DDL操作
server_audit_events=CONNECT,QUERY_DDL,QUERY_DCL
# 开启审计
server_audit_logging=ON
# 审计日志路径及文件名
server_audit_file_path=/opt/sequoiasql/mariadb/database/6101/auditlog/server_audit.log
# 强制切分审计日志文件
server_audit_file_rotate_now=OFF
# 审计日志文件大小10MB，超过该大小进行切割，单位为byte
server_audit_file_rotate_size=10485760
# 审计日志保留个数，超过后会丢弃最旧的
server_audit_file_rotations=999
# 输出类型为文件
server_audit_output_type=file
# 限制每行查询日志的大小为100kb，若表比较复杂，对应的操作语句比较长，建议增大该值
server_audit_query_log_limit=102400

重启 MariaDB 实例
```
$ sdb_maria_ctl restart myinst
```
检查审计日志文件目录，确保已生成审计日志文件 server_audit.log

至此，元数据同步工具的环境配置已完成。

使用

在完成安装后，用户还需要对其进行工具及日志的配置。以下各操作步骤均需要在 MariaDB 实例组件安装用户（默认为 sdbadmin）下完成。

工具配置项

工具使用的配置文件名为 config。如果是全新安装，开始该文件是不存在的，需要从 config.sample 进行拷贝。如果是升级，则该文件应当已经存在。配置项如下：

[mysql]
# mariadb节点主机名，只能填主机名
hosts = sdb1,sdb2,sdb3
# mariadb服务端口
port = 3306
# 密码类型，0代表密码为明文，1代表密码为密文，初次使用配置为 0，密码使用明文，工具启动后会自动加密并更新此处配置
mysql_password_type = 0
# mariadb用户
mysql_user = sdbadmin
# mariadb密码
mysql_password = sdbadmin
# mariadb安装目录
install_dir = /opt/sequoiasql/mariadb
# 审计日志存储目录
audit_log_directory = /opt/sequoiasql/mariadb/database/auditlog
# 审计日志文件名
audit_log_file_name = server_audit.log

[execute]
# 同步间隔，取值范围：[1,3600]
interval_time = 5
# 出错时是否忽略，如为 false，会一直重试
ignore_error = true
# 出错的情况下，忽略前的重试次数，取值范围：[1,1000]
max_retry_times = 5

在该配置文件中，需要根据实际情况修改[mysql]下各配置的值，[execute]下的各配置通常使用默认值即可。

日志配置项

同步工具使用 python 的 logging 模块输出日志，配置文件为 log.config。如果是全新安装，开始该文件是不存在的，需要从 log.config.sample 拷贝。配置项如下（日志目录会自动创建）：

[loggers]
keys=root,ddlLogger
[handlers]
keys=rotatingFileHandler
[formatters]
keys=loggerFormatter
[logger_root]
level=INFO
handlers=rotatingFileHandler
[logger_ddlLogger]
level=INFO
handlers=rotatingFileHandler
qualname=ddlLogger
propagate=0

[handler_rotatingFileHandler]
class=logging.handlers.RotatingFileHandler
# 日志级别，支持ERROR,INFO,DEBUG
level=INFO
# 日志格式
formatter=loggerFormatter
# 第一个参数为运行日志文件名，路径对应的目录必须已存在
# 第二个参数为写入模式，值为'a+',不建议修改
# 第三个参数为日志文件大小，单位为 byte
# 第四个参数为备份日志文件，即日志文件总数为 10+1
args=('logs/run.log', 'a+', 104857600, 10)

[formatter_loggerFormatter]
format=%(asctime)s [%(levelname)s] [%(filename)s:%(lineno)s] %(message)s
datefmt=

通常情况下，该配置文件中的各配置项均使用默认值即可。

启动工具

在完成所有配置后，在各实例所在主机的 sdbadmin 用户下，执行以下命令在后台启动同步工具

python /opt/sequoiasql/mariadb/tools/metaSync/meta_sync.py &

完成环境配置后，可通过在各实例进行少量 DDL 操作，进行简单的同步验证，验证完成后清理掉验证数据。

可以通过配置定时任务提供基本的同步工具监控，定期检查程序是否在运行，若进程退出则会被自动拉起，配置命令如下：

crontab -e
#每一分钟运行一次
*/1 * * * * /usr/bin/python /opt/sequoiasql/mariadb/tools/metaSync/meta_sync.py >/dev/null 2>&1 &

其中 /opt/sequoiasql/mariadb/tools/metaSync 为同步工具默认路径，/usr/bin/python 为系统 python 路径，用户可根据实际情况修改。配置完成后，观察同步脚本是否能定时被拉起。

状态文件

工具在正常运行后，会在与 config 文件相同的目录下，创建名为 sync.stat 的文本文件，用于记录同步状态，以便工具在重启后，能接着之前的处理进度继续工作。状态文件的内容如下：

[status]
# 最后扫描文件的审计日志文件的 inode
file_inode = 4589549
# 文件中最后处理的行号
last_parse_row = 123

以上各值为示例值，会在运行过程中自动刷新。

Note：

在工具正常运行期间，禁止手动修改该文件，否则可能造成同步中断。

收起

建议反馈

本页导航