OpsAny巡检模板使用说明

OpsAny的智能巡检SaaS中，用户可以根据自己所需创建对应的巡检模板，自定义巡检指标，巡检脚本，以及报告模板，本文档主要讲解一个巡检模板的创建过程。

巡检模板创建流程

• 1. 新建模板：
• 访问：https://domain/o/auto/#/patrolManage/patrolTemplate 点击新建按钮，填写您模板的名称/唯一标识，注：唯一标识一旦输入就无法更改。

• 点击您刚才创建的模板，进入详情页。

• 1. 指标管理
• 说明：
  • 指标分为指标组以及指标，其中每一个唯一标识都是有作用的，并且创建完成后无法修改的。
  • 指标的类型代表着不同的数据类型，以及数据结构，其中只有指标类型为单一值的情况下，才可以对对应的指标设置阈值。
  • 阈值设置中，可以对单个指标设置多个不同等级的阈值。
  • 指标与巡检脚本的输出是息息相关的。

• 创建指标和指标分组：

  • 点击巡检详情页中，右上角部分，新建指标组，填写您的指标组名称，唯一标识，点击添加指标按钮，添加您的指标。并点击确定。如图：
  • 创建完成后：
• 1. 书写巡检脚本：

• 巡检脚本的书写不限制您任何的书写风格，但是要求您的输出需要满足以下输出格式：（非常重要）

  ----------------start------------------
  {"return": []}                  # 注意此处一定是key为return，value为一个list
  -----------------end-------------------
  

• 以本文创建的指标为例：

  #!/usr/bin/env python3
  # -*- coding: utf8 -*-
  
  def info():
      res = {"return": [{"key": "Testone", "value": 1},{"key": "Testtwo", "value": 80},{"key": "Testthree", "value": "INFO"},{"key": "Testfour", "value": [{"item": "count_one", "count": 1},{"item": "count_two", "count": 2},{"item": "count_three", "count": 3}]}]}
      print("----------------start------------------")
      print(res)
      print("-----------------end-------------------")
  
  if __name__ == '__main__':
      info()
  

• 填写脚本名称，填写脚本内容，点击保存。

• 测试脚本：

• 执行结果：

• 注意事项：脚本中输出的内容中，return对应的列表里放着一个个字典，每一个字典的key需要是指标的唯一标识，value则为该指标的值。value值的类型取决于指标的类型，如果指标的类型为：数值类型，则value的类型需要是int/float形式，如果是字符串则value的类型需要为string类型。需要特别注意的是，多个值，需要返回以下数据结构：

  [
      {"item": "xx", "count": 1}
  ]
  

• 在执行结果中可以看到对应的指标抽取到的值，每个指标均获取到了正确的值，那么您的脚本就书写完成了。

• 创建报告模板：

• 点击新建模板，填写您的模板名称以及模板描述并点击下一步。

• 设计您的模板：
• 设计完成后点击确定。

巡检模板使用

• 以快速巡检为例：
• 注：您也可以在此处点击设置阈值，重新设置本次巡检的阈值。
• 点击执行就完成了本次执行的巡检工作。
• 在巡检历史中可以查看您本次巡检任务的内容，在结果统计标签页中可以查看每个主机的报告以及原始的输出。