ArkDB Inception 数据库审核平台安装指南

ArkDB Inception 数据库审核平台安装指南

项目概述

ArkDB Inception 是一个开源的数据库审核平台，主要用于 MySQL 数据库的 SQL 审核和执行。它可以帮助 DBA 和开发人员在数据库变更前进行 SQL 语句的审核，避免潜在的问题和风险。本文将详细介绍如何从源码编译安装 Inception 服务。

编译环境准备

在开始编译 Inception 之前，需要确保系统已安装必要的编译工具和依赖库。不同操作系统环境下所需的依赖可能略有差异。

通用依赖项

1. Bison：语法分析器生成器，建议使用 2.6 之前的版本
2. CMake：跨平台的编译工具
3. ncurses：终端处理库
4. OpenSSL：安全通信库
5. G++：C++编译器

Ubuntu 系统特别说明

对于 Ubuntu 用户，可以通过以下命令安装所需依赖：

sudo apt-get update
sudo apt-get install -y cmake libncurses5-dev libssl-dev g++

Bison 需要从源码编译安装，建议从官方渠道下载 2.6 以下版本的源码包。

源码编译步骤

Inception 提供了便捷的编译脚本 inception_build.sh，位于源码根目录下。编译过程非常简单：

1. 进入源码根目录
2. 执行编译命令：

sh inception_build.sh debug [Xcode]

参数说明：

• debug：指定编译目录名称
• Xcode：可选参数，指定为 Xcode 平台编译（MacOS 环境）

编译完成后，所有生成文件将位于指定的编译目录（如 debug）下，可执行文件 Inception 通常位于 debug/sql/Debug/ 目录中。

重要提示：如果编译过程中出现错误，建议删除整个编译目录后重新执行编译命令，以避免残留文件导致的问题。

配置文件说明

Inception 服务启动需要一个配置文件（通常命名为 inc.cnf），以下是一个典型配置示例：

[inception]
general_log=1
general_log_file=inception.log
port=6669
socket=/path/to/inc.socket
character-set-client-handshake=0
character-set-server=utf8
inception_remote_system_password=root
inception_remote_system_user=wzf1
inception_remote_backup_port=3306
inception_remote_backup_host=127.0.0.1
inception_support_charset=utf8mb4
inception_enable_nullable=0
inception_check_primary_key=1
inception_check_column_comment=1
inception_check_table_comment=1
inception_osc_min_table_size=1
inception_osc_bin_dir=/data/temp
inception_osc_chunk_time=0.1
inception_enable_blob_type=1
inception_check_column_default_value=1

配置项说明：

• port：指定服务监听端口
• socket：指定 Unix 域套接字文件路径
• inception_remote_*：配置远程备份数据库连接信息
• inception_check_*：设置各种审核规则开关
• inception_osc_*：配置在线表结构变更(OSC)相关参数

服务启动方式

Inception 支持两种启动方式：

1. 使用配置文件启动：

/path/to/Inception --defaults-file=inc.cnf

2. 仅指定端口启动（使用默认配置）：

/path/to/Inception --port=6669

重要注意事项： Inception 的 OSC 功能依赖于 pt-online-schema-change 工具。目前版本如果以后台方式(&)启动服务，可能会导致 OSC 操作完成后进程卡死。建议使用以下方式启动：

nohup /path/to/Inception --defaults-file=inc.cnf &

服务验证

启动成功后，可以通过 MySQL 客户端连接验证服务是否正常运行：

mysql -uroot -h127.0.0.1 -P6669

连接成功后执行以下命令查看所有系统变量：

inception get variables;

如果能够正常返回变量列表，说明 Inception 服务已成功启动并运行。

常见问题处理

1. 编译失败：

   • 确保所有依赖库已正确安装
   • 检查 Bison 版本是否符合要求
   • 清理编译目录后重新编译

2. 启动失败：

   • 检查端口是否被占用
   • 确认配置文件路径和权限正确
   • 查看日志文件获取详细错误信息

3. OSC 功能异常：

   • 确保 pt-online-schema-change 工具已安装并可执行
   • 检查 inception_osc_bin_dir 配置是否正确

通过以上步骤，您应该能够顺利完成 ArkDB Inception 的安装和基本配置。后续使用中，可以根据实际需求调整审核规则和系统参数，以更好地满足您的数据库管理需求。