gs_check用户自定义检查项示例

用户自定义检查项

1. 新增巡检项配置，修改script/gspylib/inspection/config/items.xml文件，格式如下：

<checkitem id="10010" name="CheckCPU">
<title>
<zh>检查CPU占用率</zh>
<en>Check CPU Idle and I/O wait</en>
</title>
<threshold>
StandardCPUIdle=30;
StandardWIO=30
</threshold>
<suggestion>
<zh>如果idle不足 CPU负载过高，请扩容CPU节点，如果iowait过高，则磁盘为瓶颈，更换高性能磁盘</zh>
</suggestion>
<standard>
<zh>检查主机CPU占用率，如果idle大于30%并且iowait小于30%，则检查项通过，否则检查项不通过</zh>
</standard>
<category>os</category>
<permission>user</permission>
<scope>all</scope>
<analysis>default</analysis>
</checkitems>

• id：巡检项id。

• name：巡检项脚本名， 和巡检项脚本文件名相同。

• title: 巡检项描述名称 （支持多语言）。

• ：中文版检查内容。

• ：英文版检查内容。

• standard：巡检项标准说明（支持多语言）。

• suggestion： 巡检项修复建议说明（支持多语言）。

• threshold：巡检项阈值定义，多值之间使用分号隔开，示例Key1=Value1;Key2=Value2。

• category： 巡检项分类，可选参数：os，device，network，cluster，database，other。

• permission： 巡检项需要的执行权限，可选参数：root，user默认为user（普通用户）。

• scope：巡检项执行的节点范围，可选参数：cn-仅在数据库主节点执行，local-仅在当前节点执行，all-在GBase 8c所有节点执行，默认为all。

• analysis：巡检项执行结果分析方式，default-检查每个节点的结果，所有节点检查项通过，则最终检查通过，consistent-openGauss内所有节点一致性检查，单节点仅返回结果，各个节点结果一致则判定检查通过，custom-自定义结果分析方式，默认为default。

注意

• 用户需自行保证自定义xml的正确性

2. 新建检查脚本，脚本名称格式遵循CheckXXXX.py，必须以Check开头，脚本放置在script/gspylib/inspection/items目录下，该目录下脚本安装巡检项分类组织，每个分类一个单独的文件夹，巡检项脚本放置在对应的分类文件夹中。格式如下：

class CheckCPU(BaseItem):
def __init__(self):
super(CheckCPU, self).__init__(self.__class__.__name__)
self.idle = None
self.wio = None
self.standard = None

def preCheck(self):
# check the threshold was set correctly
if (not self.threshold.has_key('StandardCPUIdle')
or not self.threshold.has_key('StandardWIO')):
raise Exception("threshold can not be empty")
self.idle = self.threshold['StandardCPUIdle']
self.wio = self.threshold['StandardWIO']

# format the standard by threshold
self.standard = self.standard.format(idle=self.idle, iowait=self.wio)

def doCheck(self):
cmd = "sar 1 5 2>&1"
output = SharedFuncs.runShellCmd(cmd)
self.result.raw = output
# check the result with threshold
d = next(n.split() for n in output.splitlines() if "Average" in n)
iowait = d[-3]
idle = d[-1]
rst = ResultStatus.OK
vals = []
if (iowait > self.wio):
rst = ResultStatus.NG
vals.append("The %s actual value %s is greater than expected value %s" % ("IOWait", iowait, self.wio))
if (idle < self.idle):
rst = ResultStatus.NG
vals.append("The %s actual value %s is less than expected value %s" % ("Idle", idle, self.idle))
self.result.rst = rst
if (vals):
self.result.val = "\n".join(vals)

所有脚本基于BaseItem基类开发，基类定义的通用的检查流程，通用的检查结果分析方法，默认的结果输出格式。可扩展方法：

• doCheck: 该方法包含该检查项具体的检查方法，检查结果格式如下：

result.rst — 检查结果状态，可选参数:

• OK --检查项完成，结果通过。

• NA --当前节点不涉及该检查项。

• NG --检查项完成，结果不通过。

• WARNING --检查项完成，结果警告。

• ERROR --检查项发生内部错误，未完成检查。

• preCheck: 检查前条件判定，内置两种实现：

  • cnPreCheck --用于检查当前执行节点是否包含数据库主节点实例，

  • localPreCheck --用于检查当前执行节点是否指定节点。可通过巡检项配置文件中的scope参数进行配置。 可重载该方法实现自定义的前置检查

• postAnalysis：检查结果分析方法，内置两种实现：default、consistent。可通过巡检项配置文件中的analysis参数进行配置。可重载该方法实现自定义的结果分析。

注意

用户自定义的检查项名称不得与已有检查项名称相同，同时用户需保证自定义检查项脚本的规范性。

1. 将此脚本分发至所有的执行节点。

2. 以gbase用户登录，执行以下命令，查看结果。

本地执行：

gs_check -i CheckXXX  -L

非本地执行：

gs_check  -i  CheckXXX