二次开发指南 ​

sysSentry作为一款巡检任务管理框架，除了管理已提供的插件外，也支持对用户开发的插件进行管理，想要开发一款新的插件并通过sysSentry框架进行管理，需要实现以下能力：

1. 编写插件管理配置文件
2. 完成插件功能开发

本文档将详细介绍如何使用sysSentry提供的对外接口开发新的插件。

插件管理配置文件 ​

用户编写的新插件可以通过sysSentry进行管理，为了达到此目的，需要用户为新插件增加对应的配置文件，该文件应放置在/etc/sysSentry/tasks/目录下，文件名为[插件名].mod，插件名仅支持字母、数字和下划线。所有配置项需写在[common]段下。假设插件名为test，配置文件参考：

oneshot类型任务的配置示例：

[root@openEuler ~]# cat /etc/sysSentry/tasks/test.mod
[common]
enabled=yes                         # 必选，是否加载插件
task_start=/usr/bin/test            # 必选，插件启动命令
task_stop=pkill -f /usr/bin/test    # 必选，插件停止命令
type=oneshot                        # 必选，插件任务类型
onstart=yes                         # 可选，插件随sysSentry服务启动时自动启动

period类型任务的配置示例：

[root@openEuler ~]# cat /etc/sysSentry/tasks/test.mod
[common]
enabled=yes                         # 必选，是否加载插件
task_start=/usr/bin/test            # 必选，插件启动命令
task_stop=kill $pid                 # 必选，插件停止命令
type=period                         # 必选，插件任务类型
interval=10                         # 可选，周期执行间隔（仅period类型生效）
heartbeat_interval=120              # 可选，心跳检测间隔
onstart=yes                         # 可选，插件随sysSentry服务启动时自动启动

配置项说明 ​

各配置项的详细说明如下：

说明：

1. 缺失必选配置项（enabled、type、task_start、task_stop）或取值非法时，整个配置文件加载失败，插件不会被管理。
2. type字段不支持动态修改，通过sentryctl reload重新加载配置时，如果type值发生变化则重新加载失败。
3. task_pre命令失败会阻止插件启动；task_post命令失败仅记录警告日志，不会阻止插件停止流程。

插件功能开发 ​

插件使用限制 ​

用户开发的新插件需满足如下要求：

1. 插件开发语言无限制，但建议用户优选python或c语言开发，目前sysSentry仅提供python和c语言的二次开发接口；
2. 所有插件必须为可执行文件；
3. 所有插件必须包含停止命令，执行该命令可准确的停止插件任务而不影响系统上其他程序的运行；

获取采集数据（可选） ​

如果用户希望通过sentryCollector采集服务获取系统数据，请参考对接sentryCollector采集服务章节。

插件事件告警上报 ​

用户可通过告警上报接口将插件的告警信息上报到xalarmd服务，并通过get_alarm接口查看告警内容：

[root@openEuler ~]# sentryctl get_alarm <插件名>

sysSentry提供python与c两种语言的对外接口。

告警上报使用限制 ​

1. 告警上报仅支持告警id的范围为1001-1128共128种，已使用告警ID见下表。

   常量	值	描述
   MEMORY_ALARM_ID	1001	内存巡检告警ID
   SLOW_IO_ALARM_ID	1002	慢IO告警事件ID
   ALARM_REBOOT_EVENT	1003	BMC下电事件告警ID
   ALARM_REBOOT_ACK_EVENT	1004	BMC下电ack事件告警ID
   ALARM_OOM_EVENT	1005	OOM事件告警ID
   ALARM_OOM_ACK_EVENT	1006	OOM ack事件告警ID
   ALARM_PANIC_EVENT	1007	Panic事件告警ID
   ALARM_PANIC_ACK_EVENT	1008	Panic ack事件告警ID
   ALARM_KERNEL_REBOOT_EVENT	1009	内核重启事件告警ID
   ALARM_KERNEL_REBOOT_ACK_EVENT	1010	内核重启ack事件告警ID
   ALARM_UBUS_MEM_EVENT	1013	UBUS内存故障事件告警ID
   ALARM_LINK_EVENT	1016	链路（link）事件告警ID
   ALARM_RAS_SENTRY_EVENT	1015	BMC RAS告警事件告警ID
   SYSSENTRY_DOWN_ALARM_ID	1128	sysSentry服务停止告警告警ID

   上面告警ID已被插件占用，用户新增插件不可复用，并且1011,1012和1014也不可使用（预留）。

2. 告警上报最大支持8191个字符。

python实现插件告警上报 ​

需要安装pysentry_notify软件包：

[root@openEuler ~]# yum install -y pysentry_notify

接口 告警信息上报

慢IO上报json格式说明：

示例：

from xalarm.sentry_notify import (
    xalarm_report,
    MAJOR_ALM,
    ALARM_TYPE_OCCUR
)

ALARM_ID = 1002
ALARM_MSG = """
{
"alarm_info": {
            "alarm_source": "avg_block_io",
            "driver_name": "sda",
            "io_type": "write",
            "reason": "IO press",
            "block_stack": "bio,wbt",
            "alarm_type": "latency",
            "details": {
                "latency": "gettag: [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], rq_driver: [0,0,0,0,0,437.9,0,0,0,0,517,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], bio: [0,0,0,0,0,521.1,0,0,0,0,557.8,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], wbt: [0,0,0,0,0,0,8.5,0,0,0,0,12.0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]",
                "iodump": "gettag: [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], rq_driver: [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], bio: [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], wbt: [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]"
            }
}
}
"""

if __name__ == "__main__":
    ret = xalarm_report(ALARM_ID, MAJOR_ALM, ALARM_TYPE_OCCUR, ALARM_MSG)
    if ret == -1:
        print("send failed.")

c语言实现插件告警上报 ​

需要安装libxalarm软件包：

[root@openEuler ~]# yum install -y libxalarm

开发环境还需要安装libxalarm-devel包（构建依赖，非运行依赖）：

[root@openEuler ~]# yum install -y libxalarm-devel

单向通信接口 ​

单向通信接口，是向xalarmd服务上报事件告警的接口。

接口信息 ​

使用示例 ​

[root@openEuler ~]# cat send_alarm.c
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <xalarm/register_xalarm.h>

#define ALARMID 1002

int main(int argc, char **argv)
{
    int alarmId = ALARMID;
    int level = MAJOR_ALM;
    int type = ALARM_TYPE_OCCUR;
    unsigned char *msg = "{\""
                            "alarm_info\": {"
                                "\"alarm_source\": \"avg_block_io\","
                                "\"driver_name\": \"sda\","
                                "\"io_type\": \"write\","
                                "\"reason\": \"IO press\","
                                "\"block_stack\": \"bio,wbt\","
                                "\"alarm_type\": \"latency\","
                                "\"details\": {"
                                    "\"latency\": \"gettag: [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], rq_driver: [0,0,0,0,0,437.9,0,0,0,0,517,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], bio: [0,0,0,0,0,521.1,0,0,0,0,557.8,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], wbt: [0,0,0,0,0,0,8.5,0,0,0,0,12.0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]\","
                                    "\"iodump\": \"gettag: [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], rq_driver: [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], bio: [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], wbt: [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]\""
                                    "}"
                                "}"
                            "}\0";

    int ret = xalarm_Report(alarmId, level, type, msg);
    
    if (ret == -1) {
        printf("send failed.\n");
    }

    return 0;
}
[root@openEuler ~]# gcc send_alarm.c -o send_alarm -lxalarm

双向通信接口 ​

双向通信接口，是指既可以向xalarmd服务上报事件消息，又可以对消息进行回复。

接口信息 ​

使用示例 ​

#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include <xalarm/register_xalarm.h>

#define SLEEP_TIME 10
#define ID_LIST_LENGTH 1
#define TIME_UNIT_MILLISECONDS 1000

void process_alarm_info(struct alarm_msg* param)
{
    int alarmid;
    long long alarmtime;
    char *pucParas;

    alarmid = (param == NULL ? 0 : param->usAlarmId);
    alarmtime = (param == NULL ? 0 : ((long long)param->AlarmTime.tv_sec) * TIME_UNIT_MILLISECONDS + (long long)(param->AlarmTime.tv_usec / TIME_UNIT_MILLISECONDS));
    pucParas = (param == NULL ? NULL : param->pucParas);
    printf("plugin notified with [alarmid:%d], [alarmtime: %lld ms], [msg:%s]\n", alarmid, alarmtime, pucParas);
    return;
}

int main(int argc, char **argv)
{
    struct alarm_msg* msg;
    struct alarm_register* register_info;
    struct alarm_subscription_info id_filter;

    id_filter.id_list[0] = ALARM_REBOOT_EVENT;
    id_filter.len = ID_LIST_LENGTH;

    int ret = xalarm_register_event(&register_info, id_filter);
    if (ret < 0) {
        perror("Failed to register xalarm\n");
        return 1;
    }

    printf("Waiting for plugin msg ... \n");

    ret = xalarm_get_event(msg, register_info);
    if (ret < 0) {
        perror("Failed to get msg\n");
        return 1;
    }

    process_alarm_info(msg);
    sleep(SLEEP_TIME);

    ret = xalarm_report_event(ALARM_REBOOT_ACK_EVENT, "Reboot ACK", strlen("Reboot ACK"));
    if (ret < 0) {
        perror("Failed to send msg\n");
        return 1;
    }

    xalarm_unregister_event(&register_info);

    return 0;
}

插件事件告警订阅 ​

sysSentry内置的告警转发子系统xalarmd通过收集巡检任务巡检过程中产生的告警信息，并将告警信息转发给订阅此类告警的用户。

python接口 ​

告警订阅接口（回调模式） ​

xalarm_register ​

xalarm_unregister ​

xalarm_upgrade ​

xalarm_getid ​

xalarm_getlevel ​

xalarm_gettype ​

xalarm_gettime ​

xalarm_getdesc ​

使用示例 ​

以下示例展示如何注册告警回调函数并处理接收到的告警信息：

import time
from xalarm.register_xalarm import (
    xalarm_register,
    xalarm_unregister,
    xalarm_getid,
    xalarm_getlevel,
    xalarm_gettype,
    xalarm_gettime,
    xalarm_getdesc
)

ALARM_RAS_SENTRY_EVENT = 1015

def alarm_handler(alarm_info):
    alarm_id = xalarm_getid(alarm_info)
    alarm_level = xalarm_getlevel(alarm_info)
    alarm_type = xalarm_gettype(alarm_info)
    alarm_time = xalarm_gettime(alarm_info)
    alarm_desc = xalarm_getdesc(alarm_info)

    print(f"收到告警:")
    print(f"  ID: {alarm_id}")
    print(f"  级别: {alarm_level}")
    print(f"  类型: {alarm_type}")
    print(f"  时间: {alarm_time} ms")
    print(f"  描述: {alarm_desc}")

if __name__ == "__main__":
    # 创建ID过滤器，只订阅特定告警ID的告警信息
    id_filter = [False] * 128
    id_filter[ALARM_RAS_SENTRY_EVENT - 1001] = True # 启用BMC RAS告警事件

    client_id = xalarm_register(alarm_handler, id_filter)
    if client_id != 0:
        print("告警注册失败")
        exit(1)

    print("告警注册成功，等待接收告警...")
    time.sleep(100)

    # 程序退出时注销
    xalarm_unregister(client_id)

C接口 ​

安装相关软件包 ​

libxalarm是sysSentry提供的C语言告警上报和订阅库，用于与xalarmd服务进行通信。使用前需要安装相关软件包：

[root@openEuler ~]# yum install -y libxalarm

开发环境还需要安装libxalarm-devel包（构建依赖，非运行依赖）：

[root@openEuler ~]# yum install -y libxalarm-devel

头文件引用 ​

使用libxalarm接口时，需要包含以下头文件：

#include <xalarm/register_xalarm.h>

编译时需要链接libxalarm库：

gcc your_program.c -o your_program -lxalarm

数据结构说明 ​

alarm_info结构体 ​

告警信息结构体，用于socket通信格式。

struct alarm_info {
    unsigned short usAlarmId;       // 告警ID
    unsigned char ucAlarmLevel;     // 告警级别
    unsigned char ucAlarmType;      // 告警类别
    struct timeval AlarmTime;       // 告警生成时间戳
    char pucParas[ALARM_INFO_MAX_PARAS_LEN];  // 告警描述信息
};

alarm_msg结构体 ​

告警消息结构体，用于事件订阅获取告警信息。

struct alarm_msg {
    unsigned short usAlarmId;       // 告警ID
    struct timeval AlarmTime;       // 告警生成时间戳
    char pucParas[ALARM_INFO_MAX_PARAS_LEN];  // 告警描述信息
};

alarm_subscription_info结构体 ​

告警订阅信息结构体，用于指定订阅的告警ID列表。

struct alarm_subscription_info {
    int id_list[MAX_NUM_OF_ALARM_ID];  // 订阅的告警ID列表
    unsigned int len;                   // 列表长度
};

告警订阅接口（回调模式） ​

xalarm_Register ​

回调函数类型定义：

typedef void (*alarm_callback_func)(struct alarm_info *palarm);

xalarm_UnRegister ​

xalarm_Upgrade ​

xalarm_getid ​

xalarm_getlevel ​

xalarm_gettype ​

xalarm_gettime ​

xalarm_getdesc ​

使用示例 ​

#include <stdio.h>
#include <xalarm/register_xalarm.h>

void alarm_handler(struct alarm_info *palarm)
{
    printf("Received alarm id: %d\n", xalarm_getid(palarm));
    printf("Alarm level: %d\n", xalarm_getlevel(palarm));
    printf("Alarm message: %s\n", xalarm_getdesc(palarm));
}

int main(int argc, char **argv)
{
    struct alarm_subscription_info id_filter;
    id_filter.id_list[0] = ALARM_OOM_EVENT;
    id_filter.id_list[1] = ALARM_PANIC_EVENT;
    id_filter.len = 2;

    int client_id = xalarm_Register(alarm_handler, id_filter);
    if (client_id != 0) {
        printf("register failed.\n");
        return -1;
    }

    // 等待接收告警...
    sleep(60);

    // 动态更新订阅列表
    struct alarm_subscription_info new_filter;
    new_filter.id_list[0] = ALARM_OOM_EVENT;
    new_filter.id_list[1] = ALARM_KERNEL_REBOOT_EVENT;
    new_filter.len = 2;

    bool ret = xalarm_Upgrade(new_filter, client_id);
    if (!ret) {
        printf("upgrade failed.\n");
    } else {
        // 等待接收新的事件告警...
        sleep(60);
    }

    xalarm_UnRegister(client_id);
    return 0;
}

日志记录 ​

sysSentry框架运行过程中产生的日志保存在在/var/log/sysSentry/sysSentry.log中，可通过查看该日志获取框架运行详情。

插件日志记录位置和格式 ​

开发巡检插件时，推荐插件运行过程中产生的日志保存在/var/log/sysSentry/目录下，文件名命名为[插件名].log；日志文件名称推荐和插件名称一致。

日志记录相关信息时，推荐日志格式为：<时间戳> - <日志级别> - [<文件名:行号>] - <日志消息> 其中时间戳格式为：YYYY-MM-DD HH:MM:SS,FF , 时间戳示例为：2006-01-02 15:04:05.99

日志级别可选项为：debug/info/warning/error/critical。 选项的含义如下：

• debug：最低级别，用于记录详细的技术信息，帮助开发调试。
• info：记录程序的正常运行信息，如启动和关闭状态。
• warning：记录可能引起问题的情况，但不影响程序运行。
• error：记录严重问题，导致功能失败或程序中断。
• critical：最高级别，记录非常严重的问题，可能导致程序完全停止运行。

推荐程序正常运行时，日志级别设为info。

插件日志轮转配置 ​

sysSentry框架及插件的日志会基于logrotate机制进行自动轮转。日志轮转是一种系统管理技术，用于管理日志文件的大小和数量，以防止日志文件占用过多的磁盘空间。

系统每次触发logrotate时会对sysSentry框架及插件的日志文件大小进行判断，如果日志文件超过4096k，则进行logrotate，一个插件/服务的日志最多轮转两次，轮转日志会被压缩。

插件日志轮转配置示例 ​

日志轮转配置可参考/etc/logrotate.d/sysSentry文件进行配置。 当前/etc/logrotate.d/sysSentry的配置内容如下：

/var/log/sysSentry/*.log{
    compress
    missingok
    notifempty
    copytruncate
    rotate 2
    size +4096k
    hourly
}

其中各项配置项含义为：

• /var/log/sysSentry/*.log表明对哪些日志文件进行转储，*为通配符，表示所有/var/log/sysSentry/目录下以.log结尾的日志文件。
• compress表明默认将日志文件进行压缩，节省内存空间。也可配置为nocompress，表明不压缩日志文件。推荐此项默认配置为compress。
• missingok表明如果日志缺失，logrotate不会报错，也不会停止处理其他日志文件。推荐此配置项默认配置。
• notifempty表明如果日志文件为空，则不进行转储。推荐此配置项默认配置。
• copytruncate表明在日志转储时，先将当前的日志文件复制一份，然后将日志文件清空，再将复制的文件进行压缩。这通常用于正在被系统进程使用的日志文件，确保进程可以继续写入新的日志。推荐此配置项默认配置。
• rotate 2表明在轮转操作后保留2个旧的日志文件。一旦旧的文件数量超过2个，logrotate会自动删除旧的日志文件为新的日志文件腾出空间。可根据需求自行定义所需日志数量大小。
• size +4096k表明当日志文件大小超过4096k时，将自动触发日志转储操作。可根据需求自行定义所需日志文件大小。
• hourly表明日志轮转的频率是每小时。可配置项有hourly/daily/weekly/monthly等。示例中表明logrotate每小时轮转日志文件。推荐此项默认配置为hourly。

更改插件日志轮转配置 ​

对新增插件：

1. 可更改/etc/logrotate.d/sysSentry已有的配置项内容（注：此举会更改所有/var/log/sysSentry/目录下以.log结尾的日志文件配置）.

2. 若想对/var/log/sysSentry/目录下不同的日志文件设置不同配置，可在/etc/logrotate.d/sysSentry对每一个日志文件进行单独配置，如下所示：

   shell

   /var/log/sysSentry/`[日志名一]`.log{
       # 所需配置项等
   }
   /var/log/sysSentry/`[日志名二]`.log{
       # 所需配置项等
   }

请不要对同一日志，设置不同配置。如下例所示：

# A BAD EXAMPLE
/var/log/sysSentry/*.log{
    compress
}
/var/log/sysSentry/example.log{
    nocompress
}

在该示例中，*为通配符，表示所有/var/log/sysSentry/目录下以.log结尾的日志文件，已经包含了example.log，设置为轮转日志需要压缩；但配置文件中又单独设置example.log不需要压缩。该做法可能会造成预期之外的行为。

如果手动修改了/etc/logrotate.d/sysSentry文件，可通过logrotate -f /etc/logrotate.d/sysSentry手动触发日志轮转。 logrotate的其他使用方法请参考https://linux.die.net/man/8/logrotate

结果上报 ​

用户可通过sysSentry提供的接口将插件巡检结果上报给sysSentry服务，并通过get_result命令查看结果：

[root@openEuler ~]# sentryctl get_result <插件名>

提供python与c两种语言的对外接口。

结果上报使用限制 ​

1. 结果上报接口应在巡检插件运行结束前被调用。
2. 巡检插件的一个生命中期内仅应上报一次巡检结果。
3. 巡检插件运行成功或失败均应该上报巡检结果。

python巡检结果上报接口 ​

结构体 ResultLevel

class ResultLevel(Enum):
    """result level for report_result"""
    PASS = 0    # 巡检任务正常运行结束，无异常
    FAIL = 1    # 因缺少依赖、环境不支持等原因跳过/未执行巡检任务
    SKIP = 2    # 因执行命令错误等原因，巡检任务执行失败
    MINOR_ALM = 3   # 巡检任务结束，存在系统存在异常，并且已经尝试自动隔离等方式完成修复
    MAJOR_ALM = 4   # 巡检任务结束，系统存在异常，需要通过重启等方式修复
    CRITICAL_ALM = 5    # 巡检任务结束，致命告警，系统或硬件存在无法修复问题，建议更换

接口 结果上报

示例：

[root@openEuler ~]# python3
Python 3.7.9 (default, Dec 11 2023, 19:40:40) 
[GCC 7.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import json
>>> from syssentry.result import ResultLevel, report_result
>>> report_result("test", ResultLevel.PASS, json.dumps({}))
0

c巡检结果上报接口 ​

需要安装libxalarm软件包：

[root@openEuler ~]# yum install -y libxalarm

开发环境还需要安装libxalarm-devel包（构建依赖，非运行依赖）：

[root@openEuler ~]# yum install -y libxalarm-devel

结构体 RESULT_LEVEL

enum RESULT_LEVEL {
    RESULT_LEVEL_PASS = 0,  // 巡检任务正常运行结束，无异常
    RESULT_LEVEL_FAIL = 1,  // 因缺少依赖、环境不支持等原因跳过/未执行巡检任务
    RESULT_LEVEL_SKIP = 2,  // 因执行命令错误等原因，巡检任务执行失败
    RESULT_LEVEL_MINOR_ALM = 3, // 巡检任务结束，存在系统存在异常，并且已经尝试自动隔离等方式完成修复
    RESULT_LEVEL_MAJOR_ALM = 4, // 巡检任务结束，系统存在异常，需要通过重启等方式修复
    RESULT_LEVEL_CRITICAL_ALM = 5,  // 巡检任务结束，致命告警，系统或硬件存在无法修复问题，建议更换
};

接口：结果上报

示例：

[root@openEuler ~]# cat report_res.c
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <xalarm/register_xalarm.h>

int main(int argc, char *argv[]) {
    enum RESULT_LEVEL result_lv = 0;
    result_lv = RESULT_LEVEL_PASS;
    details = "{\"a\": 1, \"b\": 2}";
    int res = report_result(task_name, result_lv, details);
    if (res == -1) {
        printf("failed send result to sysSentry\n");
    }

    return 0;
}
[root@openEuler ~]# gcc report_res.c -o report_res -lxalarm

对接sentryCollector采集服务 ​

sysSentry软件中包含用来做数据采集的服务：sentryCollector，用户可通过sentryCollector服务定期采集系统数据。

采集使用限制 ​

1. 当前仅支持对系统io数据进行采集，并提供ebpf采集和内核无锁采集两种方案；
2. 仅支持对nvme ssd（nvme固态硬盘）、sata ssd（sata固态硬盘）、sata hdd（sata机械硬盘）三种磁盘的数据进行采集；
3. sentryCollector的io数据采集默认使用ebpf采集，如需使用内核无锁采集，请参考常见问题解决方法 - Q1进行部署。

io数据采集 ​

sentryCollector支持按周期采集指定磁盘的数据，并提供两种采集方式：

• 内核无锁采集 -- 由内核进行数据采集，并将采集结果上报给用户态读取，需要重编内核实现。
• ebpf采集 -- 通过使用ebpf向内核打点的方式进行采集，无需重编内核。

内核无锁采集和ebpf采集的差异 ​

内存无锁采集和ebpf采集在以下几个方面存在区别：

1. 支持采集的阶段不同

   将一个io从发生到结束分成多个不同的阶段，以下是两种采集方式支持的阶段类型：

   阶段	bio	rq_driver	throtl	wbt	gettag	plug	deadline	bpf	requeue	hctx
   内核无锁采集	支持	支持	支持	支持	支持	支持	支持	支持	支持	支持
   ebpf采集	支持	支持	不支持	支持	支持	不支持	不支持	不支持	不支持	不支持

2. 支持采集的IO类型不同

   IO类型	内核无锁采集	ebpf采集	数据含义
   read	支持	支持	读IO
   write	支持	支持	写IO
   flush	支持	不支持	flush IO
   discard	支持	不支持	discard IO

除以上两个差异之外，内核无锁采集和ebpf采集方案可采的数据类型、支持系统等数据均相同：

1. 两种采集方案均支持4.19内核，x86_64和aarch64架构。
2. 两种采集方案均支持采集nvme ssd（nvme固态硬盘）、sata ssd（sata固态硬盘）和sata hdd（sata机械硬盘）三种盘的数据。
3. 两种采集方案均支持对latency、iodump、iolength、iops数据的采集：
   • latency -- 指定周期内的时延数据；
   • iodump -- 指定周期内超时未完成的io数量，如io运行超过1秒未完成即为超时；
   • iolength -- io队列长度
   • iops -- 每秒内完成的io数量

对外接口 ​

当前仅提供python语言的接口，需要用户安装pysentry_collect软件包：

[root@openEuler ~]# yum install -y pysentry_collect

接口一 查看磁盘类型

示例：

[root@openEuler ~]# python3
Python 3.7.9 (default, Dec 11 2023, 19:40:40) 
[GCC 7.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from sentryCollector.collect_plugin import get_disk_type, Disk_Type
>>> res = get_disk_type("sda")
>>> res
{'ret': 0, 'message': '1'}
>>> curr_disk_type = int(res['message'])
>>> curr_disk_type
1
>>> Disk_Type[curr_disk_type]
'sata_ssd'

接口二 查询采集是否合法

示例：

[root@openEuler ~]# python3
Python 3.7.9 (default, Dec 11 2023, 19:40:40) 
[GCC 7.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from sentryCollector.collect_plugin import is_iocollect_valid
>>> is_iocollect_valid(1, ["sda"])
{'ret': 0, 'message': '{"sda": ["throtl", "wbt", "gettag", "plug", "deadline", "hctx", "requeue", "rq_driver", "bio"]}'}

接口三 查询指定数据

示例：

[root@openEuler ~]# python3
Python 3.7.9 (default, Dec 11 2023, 19:40:40) 
[GCC 7.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from sentryCollector.collect_plugin import get_io_data
>>> get_io_data(1, ["sda"], ["bio"], ["read"])
{'ret': 0, 'message': '{"sda": {"bio": {"read": [0, 0, 0, 0]}}}'}