通过 obdiag check 巡检 OceanBase 数据库集群

本文适用于独立部署 obdiag 的场景，使用 obdiag check 命令可帮助 OceanBase 数据库集群相关状态巡检，目前支持从系统内核参数、内部表等方式对 OceanBase 的集群进行分析，发现已存在或可能会导致集群出现异常问题的原因分析并提供运维建议。

前提条件

请确保已经安装 obdiag，详细信息，请参见 安装 obdiag 。

check 命令组

语法

obdiag check [options]

options 说明：

示例如下：

obdiag check --cases=test

'cat ./check_report/check_report_2023-10-30-16:15:52.table', export type is table
For more details, please run cmd 'cat ./check_report/check_report_2023-10-30-16:15:52.table'
If you want to view detailed obdiag logs, please run:'obdiag display-trace --trace_id a7674ecb-0d99-36fe-b584-3b707b4647bc'

task 编写教程

task 是一个独立的巡检场景，可以理解为一个专业的，用 yaml 编写的，用 obdiag 识别的脚本文件。

task 会包含一些用于巡检的前置声明，用于实现对 OceanBase 进行更为专业的巡检。

开始编写前

在编写 test.yaml 文件前，需要先确认 test.yaml 文件的存放位置。

test.yaml 文件必须存放在 config.yml 文件中设置的 CHECK.tasks_base_path 所标识的目录内，在该目录下，分析编写的巡检场景是否属于已有的大类，若没有则创建一个文件夹用于声明这个大类。

例：

#先进入${CHECK.tasks_base_path}，然后创建一个文件夹 test，并创建示例文件 test.yaml
cd ~/.obdiag/tasks/
mkdir test
cd test
touch test.yaml

编写 task 脚本

task 的作用是声明巡检执行的步骤，其基础结构是一个 list，用于兼容不同版本可能导致步骤的出入或者该巡检项目无法使用。

task 文件的示例如下：

info: testinfo
task:
  - obversion: "[3.1.0,3.2.4]"
    steps:
      {steps_object}
  - obversion: "[4.2.0.0,4.3.0.0]"
    steps:
      {steps_object}

参数说明：

steps 介绍

steps 也是一个 list，用来表示具体的多个执行流程。

steps 的一个元素的结构即单个流程，如下

各种类型示例如下，step: 仅为一个标记，无实际作用。

• get_system_parameter

  steps:
  - type: get_system_parameter
    parameter_name: parameter
    result:
      set_value: servervm.max_map_count
  

• ssh

  远程执行指令并获取对应的返回值

  steps:
  - type: ssh
    ssh: wc -l /proc/${task_OBServer_pid}/maps | awk '{print $1}'
    result:
      set_value: observerMaps
  

• sql

  执行 SQL 并获取对应的值。

  steps:
  - type: sql
    sql: select tenant_name from oceanbase.table_name from where tenant_id=${taskTenantId};
    result:
      set_value: tenant_name
  

result & verify 功能

这个字段也是 verify 功能的主要依赖字段，用于对 task 获取结果的验证。

其格式如下：

result:
      set_value: {set_value}
      verify_type: {verify_type}
      report_type: {report_type}
      verify: {verify}
      err_msg: {err_msg}

参数说明：

verify_type 支持的类型：

目前 verify_type 支持的类型，除了 base 外的类型仅适用于 int 类型。

• between：判断 set_value 的值是否在 verify 提供的范围内。
• max：判断 set_value 的值是否小于 verify 提供的值。
• min：判断 set_value 的值是否大于 verify 提供的值。
• equal：判断 set_value 的值是否等于 verify 提供的值。

关于 base 的说明

verify 表达式会用于替换如下 shell 式子中的 new_expr 内进行执行验证，在编写 verify 时可以手动在本地进行逻辑验证。

if ${new_expr}; then
    echo "true"
else
    echo "false"
fi

关于 task 的手动更新

为了更好地提供更有效的检测项任务，我们会不定时更新 task 的数量和质量，用户可以在 obdiag 的代码仓库 中复制 ${code_path}/handler/check/tasks 文件夹来替换原有文件夹 ~/.obdiag/tasks，同时需要的还有 check_package.yaml(~/.obdiag/check_package.yaml)。