From 869054135df0eab5f35cd116d14e7bff501b1841 Mon Sep 17 00:00:00 2001 From: gaoruoshu Date: Mon, 28 Oct 2024 01:41:33 +0000 Subject: [PATCH] update readme Signed-off-by: gaoruoshu --- README.md | 109 +++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 91 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 76e6167..d857162 100644 --- a/README.md +++ b/README.md @@ -4,34 +4,107 @@ sysSentry is a system inspection framework used to manage system inspection tasks. #### 软件架构 -软件架构说明 +1. 框架：支持x86和aarch64架构 +2. 插件：不同的差距支持架构不同，请参考docs.openeuler.org中的内容 #### 安装教程 -1. xxxx -2. xxxx -3. xxxx +1. 安装巡检框架 +```shell +[root@openEuler ~]# yum install -y sysSentry +``` +2. 启动巡检框架 +```shell +[root@openEuler ~]# systemctl start sentryCollector +[root@openEuler ~]# systemctl start xalarmd +[root@openEuler ~]# systemctl start sysSentry +``` +3. 安装&重载巡检插件 +step1. 安装用户需要的巡检插件 +```shell +yum install <插件名> +``` +当前支持插件有： +- cpu_sentry -- cpu巡检，支持22.03-LTS-SP4版本，aarch64架构，920F芯片使用 +- avg_block_io -- 平均阈值慢io检测，支持20.03-LTS-SP4版本，x86及aarch64架构 +- ai_block_io -- AI阈值慢io检测，支持20.03-LTS-SP4版本，x86及aarch64架构 + +step2. 重载巡检插件 +```shell +[root@openEuler ~]# sentryctl reload <插件名> +``` #### 使用说明 -1. xxxx -2. xxxx -3. xxxx +sysSentry提供了用于管理巡检插件的命令 -- sentryctl，可以用于启动/停止巡检插件任务、查看巡检插件运行状态、查看巡检插件上报信息等功能。 + +1. 启动指定巡检任务 + + ```shell + [root@openEuler ~]# sentryctl start + ``` + +2. 终止指定巡检任务 + + ```shell + [root@openEuler ~]# sentryctl stop + ``` + +3. 列出所有已加载的巡检任务及状态 + + ```shell + [root@openEuler ~]# sentryctl list + ``` + +4. 查询指定巡检任务的状态 + + ```shell + [root@openEuler ~]# sentryctl status + ``` + + 巡检任务共存在四种状态，每种状态的回显信息及对应介绍如下： + + | 状态 | 描述 | + | ------- | ------------------------------------------------------------ | + | RUNNING | 巡检任务正在运行 | + | WAITING | 仅period类型巡检任务可设置此状态，表示period巡检任务等待下一次被调度执行 | + | EXITED | 巡检任务尚未执行，或者oneshot类型的巡检任务执行结束处于此状态 | + | FAILED | 巡检任务未拉起成功，或者巡检任务未正常退出 | + +5. 重载指定巡检任务的配置 + + 当用户修改了巡检任务的配置文件/etc/sysSentry/tasks/.mod时，可通过以下命令重载配置文件： + + ```shell + [root@openEuler ~]# sentryctl reload + ``` + +6. 查询指定任务的告警信息 + + ```shell + [root@openEuler ~]# sentryctl get_alarm [options] + ``` + + options可选参数及释义如下： + + | 参数 | 描述 | + | -------------------------------------- | ------------------------------------------------------------ | + | -s TIME_RANGE, --time_range TIME_RANGE | 展示用户指定时间长度内的告警信息，TIME_RANGE为整形，单位秒，范围为1~15 | + | -d, --detailed | 打印详细告警信息 | + +7. 查询指定巡检任务的巡检结果 + + ```shell + sentryctl get_result + ``` + + + #### 参与贡献 1. Fork 本仓库 2. 新建 Feat_xxx 分支 3. 提交代码 -4. 新建 Pull Request - - -#### 特技 - -1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +4. 新建 Pull Request \ No newline at end of file