ob_admin 简介

ob_admin 是 OceanBase 数据库的配套运维工具之一，本文介绍了 ob_admin 的安装步骤以及功能介绍。

ob_admin 安装

通过 YUM 命令安装

您可以通过 YUM 命令直接安装工具集成包（OceanBase Utils），进行 ob_admin 的使用。

1. 通过 YUM 命令安装 OceanBase Utils。

   yum-config-manager --add-repo https://mirrors.aliyun.com/oceanbase/OceanBase.repo
   yum install oceanbase-ce-utils
   

2. 安装成功后，可以使用 ob_admin 包含的相关功能。

   以查看 dumpsst 的帮助说明为例，命令如下：

   ob_admin dumpsst -h
   

通过 ob_utils 安装包

您可以通过安装工具集成包（OceanBase Utils），进行 ob_admin 的使用。

1. 访问 OceanBase 软件下载中心 页面，搜索 OceanBase Utils，下载需要的版本到本地。

2. 在文件目录里执行以下命令安装 OceanBase Utils。

   rpm -ivh  oceanbase-ce-utils-<version>
   

   如果您只需要 ob_admin，可使用 rpm2cpio 命令来获取 ob_admin。

   rpm2cpio oceanbase-ce-utils-<version> | cpio -idmv ./usr/bin/ob_admin
   cp usr/bin/ob_admin /usr/local/bin
   

3. 安装成功后，可以使用 ob_admin 包含的相关功能。

   以查看 dumpsst 的帮助说明为例，命令如下：

   ob_admin dumpsst -h
   

通过源码编译

您可通过 OceanBase 数据库的源码自行编译。

1. 克隆 OceanBase 数据库 的开源代码到本地。

   git clone https://github.com/oceanbase/oceanbase
   

2. 两种模式编译 ob_admin。

   • Debug 模式

     bash build.sh debug --init
     cd build_debug
     make ob_admin
     cp tools/ob_admin/src/ob_admin /usr/local/bin
     

     ob_admin 的编译产物默认存储在 DEBUG_BUILD_DIR/tools/ob_admin/src/ob_admin 中。其中，DEBUG_BUILD_DIR 表示编译目录，在本示例中是 build_debug。

   • Release 模式

     bash build.sh release --init
     cd build_release
     make ob_admin
     cp tools/ob_admin/src/ob_admin /usr/local/bin
     

     ob_admin 的编译产物默认存储在 RELEASE_BUILD_DIR/tools/ob_admin/src/ob_admin 中。其中，RELEASE_BUILD_DIRR 表示编译目录，在本示例中是 build_release。

3. 安装成功后，可以使用 ob_admin 包含的相关功能。

   以查看 dumpsst 的帮助说明为例，命令如下：

   ob_admin dumpsst -h
   

常见问题

ob_admin 使用过程中如果遇到缺少动态库 libmariadb.so.3 ，可以通过如下方法进行解决。

1. 错误示例。

   $ ob_admin dumpsst -h
   ob_admin: error while loading shared libraries: libmariadb.so.3: cannot open shared object file: No such file or directory
   

2. OceanBase 数据库自带 libmariadb.so.3，通过 find 命令找到该路径。

   本示例中，OceanBase 数据库的安装路径是 /home/admin/observer。

   $ find / -name libmariadb.so.3
   /home/admin/observer/lib/libmariadb.so.3
   

3. 给环境变量 LD_LIBRARY_PATH 指定的动态库搜索路径。

   $ export LD_LIBRARY_PATH=/home/admin/observer/lib
   

4. 再进行 ob_admin 相关功能的使用。

   $ ob_admin dumpsst -h
   

ob_admin 功能介绍

ob_admin 提供了 slog_tool、log_tool、dumpsst 和 dump_backup 功能，主要用于排查数据不一致、丢数据、错误数据等问题。下面分别从各个子功能来简要介绍一下 ob_admin。

slog_tool

slog_tool 目前只有一个功能，即显示输出 slog 文件中的日志内容。命令格式如下：

$./ob_admin slog_tool -f ../store/slog/1

clog 日志

通常 clog 文件中包含多种类型的日志，其中 OB_LOG_SUBMIT 为主要的日志类型，表示对应的 clog 日志记录为其他模块（非 clog 模块）提交的日志记录，包含事务模块向 clog 提交的事务日志。

log_tool

log_tool 主要具有以下功能：

• 提供 dump clog 文件中的日志内容。
• 统计 clog 文件中各模块占比。
• 指定字段查找日志。

具体用法请参见 clog_tool。

dumpsst

dumpsst 用来显示 block_file 文件中的内容，例如 super block，macro block，macro block meta，sstable， sstable meta 等。通常用于线上问题调查追溯，定位数据问题等。具体用法请参见 dumpsst。

dump_backup

dump_backup 功能可解析用于物理备份的数据备份内容。具体用法请参见 dump_backup。