长期支持版本

    社区创新版本

      安装sysSentry

      操作系统

      openEuler-22.03-LTS-SP4

      环境准备

      • 安装openEuler-22.03-LTS-SP4系统,安装方法参考 《安装指南》。
      • 安装sysSentry需要使用root权限。

      配置yum源

      在/etc/yum.repos.d/创建.repo文件(eg. /etc/yum.repos.d/openEuler.repo),使用编辑器打开.repo文件添加如下内容:

      aarch64架构:

      [openEuler-22.03-LTS-SP4]
      name=openEuler-22.03-LTS-SP4
      baseurl=http://repo.openeuler.org/openEuler-22.03-LTS-SP4/everything/aarch64/
      enabled=1
      gpgcheck=1
      gpgkey=http://repo.openeuler.org/openEuler-22.03-LTS-SP4/everything/aarch64/RPM-GPG-KEY-openEuler
      
      [openEuler-22.03-LTS-SP4-update]
      name=openEuler-22.03-LTS-SP4-update
      baseurl=http://repo.openeuler.org/openEuler-22.03-LTS-SP4/update/aarch64/
      enabled=1
      gpgcheck=0
      

      x86_64架构:

      [openEuler-22.03-LTS-SP4]
      name=openEuler-22.03-LTS-SP4
      baseurl=http://repo.openeuler.org/openEuler-22.03-LTS-SP4/everything/x86_64/
      enabled=1
      gpgcheck=1
      gpgkey=http://repo.openeuler.org/openEuler-22.03-LTS-SP4/everything/x86_64/RPM-GPG-KEY-openEuler
      
      [openEuler-22.03-LTS-SP4-update]
      name=openEuler-22.03-LTS-SP4-update
      baseurl=http://repo.openeuler.org/openEuler-22.03-LTS-SP4/update/x86_64/
      enabled=1
      gpgcheck=0
      

      安装sysSentry

      yum install sysSentry libxalarm -y
      

      使用sysSentry

      启动巡检框架

      systemctl start sysSentry
      systemctl start xalarmd
      # 执行成功后可通过status命令查看状态为running
      systemctl status sysSentry
      systemctl status xalarmd
      

      配置巡检任务

      sysSentry巡检框架以巡检模块(module)的形式管理巡检任务,每个巡检模块由/etc/sysSentry/tasks/目录下对应的.mod配置文件定义,巡检模块的名称即为.mod文件的名称,.mod配置文件用于配置巡检任务的运行参数。

      管理巡检任务

      • 启动指定巡检任务
      sentryctl start <module_name>
      
      • 终止指定巡检任务
      sentryctl stop <module_name>
      
      • 列出所有已加载的巡检任务及状态
      sentryctl list
      

      例如:

      输入图片说明

      • 查询指定巡检任务的状态
      sentryctl status <module_name>
      

      巡检状态回显信息:

      状态描述
      RUNNING巡检任务正在运行
      WAITING仅period类型巡检任务可设置此状态,表示period巡检任务等待下一次被调度执行
      EXITED巡检任务尚未执行,或者oneshot类型的巡检任务执行结束处于此状态
      FAILED巡检任务未拉起成功,或者巡检任务未正常退出
      • 重载指定任务配置
      sentryctl reload <module_name>
      
      • 查询指定巡检任务的巡检结果
      sentryctl get_result <module_name>
      

      回显信息格式为json格式,内容格式如下:

      {
          "result": "xxx",
          "start_time": "YY-mm-DD HH:MM:SS",
          "end_time": "YY-mm-DD HH:MM:SS",
          "error_msg" : "xxx",
          "details":{}  # detail信息因巡检任务不同而不同,具体信息由巡检模块提供
      }
      

      "result"和"error_msg"对应关系如下:

      result对应error_msg信息
      PASS""
      SKIP"not supported.maybe some rpm package not be installed."
      FAIL"FAILED. config may be incorrect or the command may be invalid/killed!"
      MINOR_ALM"the command output shows that the status is 'INFO' or 'GENERAL_WARN'."
      MAJOR_ALM"the command output shows that the status is 'WARN' or 'IMPORTANT_WARN'."
      CRITICAL_ALM"the command output shows that the status is 'FAIL' or 'EMERGENCY_WARN'."

      常见问题Q&A

      • 短时间内频繁启动并关闭sysSentry服务,查看服务启动日志会出现RuntimeError: reentrant call inside <_io.BufferedWriter name='</var/run/sysSentry/sysSentry.pid>'> 错误信息,这对功能是否受影响?

        启动sysSentry服务又短时间内停止sysSentry服务导致sysSentry初始化流程未结束就接收到终止信号,可能会触发两次sig_handler流程。如果第一次流程正好执行到close()的时候触发了第二次sig_handler流程,这就会引发RuntimeError。该问题不影响正常功能,建议用户启动sysSentry服务后不要立即关闭sysSentry服务。

      文档捉虫

      “有虫”文档片段

      问题描述

      提交类型 issue

      有点复杂...

      找人问问吧。

      PR

      小问题,全程线上修改...

      一键搞定!

      问题类型
      规范和低错类

      ● 错别字或拼写错误;标点符号使用错误;

      ● 链接错误、空单元格、格式错误;

      ● 英文中包含中文字符;

      ● 界面和描述不一致,但不影响操作;

      ● 表述不通顺,但不影响理解;

      ● 版本号不匹配:如软件包名称、界面版本号;

      易用性

      ● 关键步骤错误或缺失,无法指导用户完成任务;

      ● 缺少必要的前提条件、注意事项等;

      ● 图形、表格、文字等晦涩难懂;

      ● 逻辑不清晰,该分类、分项、分步骤的没有给出;

      正确性

      ● 技术原理、功能、规格等描述和软件不一致,存在错误;

      ● 原理图、架构图等存在错误;

      ● 命令、命令参数等错误;

      ● 代码片段错误;

      ● 命令无法完成对应功能;

      ● 界面错误,无法指导操作;

      风险提示

      ● 对重要数据或系统存在风险的操作,缺少安全提示;

      内容合规

      ● 违反法律法规,涉及政治、领土主权等敏感词;

      ● 内容侵权;

      您对文档的总体满意度

      非常不满意
      非常满意
      提交
      根据您的反馈,会自动生成issue模板。您只需点击按钮,创建issue即可。
      文档捉虫
      编组 3备份