event
版本信息
| 项目 | 内容 |
|---|---|
| 组件版本 | 0.0.111(event_mgmt) |
| 首发版本 | openUBMC 26.09 |
| 文档作者 | mkdlf |
| 最后更新 | 2026-11-03 |
版本信息表中的“首发版本”指
event_mgmt组件首次随openUBMC发布的版本;各接口表中的“首发版本”指bmc.kepler.Systems.Events接口在mdb_interface中首次发布的版本。
1. 组件概述
1.1 组件简介
event组件主要用于承载BMC的事件管理,通过SEL日志记录事件消息,例如硬件错误、故障、告警等,并维护告警数量等信息以表征当前系统健康状态。
说明:本文档描述C++重构版本
event_mgmt的接口行为。event_mgmt与原Lua版event组件功能基本一致,仅组件包名不同,D-Bus服务名仍为bmc.kepler.event。稳定前event与event_mgmt同步新增特性;稳定后event仅维护缺陷,新增功能主要由event_mgmt支持。
1.2 解决什么问题
- 管理事件对象,新增事件时发信号,便于运维监听、上报
- 管理部件健康状态
- 管理系统健康状态
- 管理硬件健康状态
1.3 核心功能
- 事件与告警
对外呈现事件与告警两种不同的日志,但对于Event,两者仅严重等级不同,Normal级别的日志称为事件,告警则是Normal级别以上的日志。
- 管理事件状态
- 所有日志都通过Event对象进行管理,即每一条日志都归属于一个对象
- 所有对象都有Assert/Deassert两种状态,所以也包括Normal级别的事件
- 管理硬件健康状态
- 硬件事件通过CSR中Event对象的
AffectHardwareHealth属性控制是否参与硬件健康判断,软件事件通过AddEvent的AffectHardwareHealth参数控制 - 系统硬件健康状态
HardwareHealth由参与判断的事件中最高严重等级决定
- 提供告警机制
读值监听
接口添加
1.4 外部交互边界图
2. API 使用说明与示例
2.1 GetAlarmList
功能说明
查询当前告警。
| 属性 | 内容 |
|---|---|
| 接口名 | bmc.kepler.Systems.Events |
| 首发版本 | bmcsdk 25.03 |
| 废弃状态 | 正常可用 |
参数说明
| 参数名 | 方向 | 类型 | 描述 | 取值范围 |
|---|---|---|---|---|
| StartId | 输入 | U16 | 事件索引,(正序)从第几个开始查询 | U16 |
| Count | 输入 | U16 | 要查询的事件条数 | U16 |
| QueryParameters | 输入 | Array | 查询条件列表,当前支持语言(Lang:en/zh)、严重等级(Severity:Normal/Minor/Major/Critical,严重程度从低到高为 Normal < Minor < Major < Critical,返回指定等级及更严重等级)和事件码(EventCode) | 数组元素为键值对,其中Key、Value均为字符串类型 |
| Total | 输出 | U16 | 事件总条数 | U16 |
| EventList | 输出 | Array | 事件详细信息列表 | 数组元素仍为数组(记为a1),a1的元素为键值对,其中Key、Value均为字符串类型 |
Severity不传时默认按Minor过滤,即返回Minor/Major/Critical;传入某个等级时返回该等级及更严重等级,例如Major返回Major/Critical,Critical仅返回Critical,Normal返回全部等级。传入Normal时会过滤部分重启类事件。
返回值与异常
| 返回值 | 含义 | 触发条件 | 处理建议 |
|---|---|---|---|
| Total不为0 | 成功 | 环境上产生了告警 | 无 |
| Total为0 | 环境上没有产生告警时为成功,如果环境实际产生了告警,则意味着查询失败 | 查询当前告警 | 如果环境实际产生了告警,则要检查入参是否正确 |
| 抛错InternalError | 失败 | 代码内部错误 | 检查CSR配置或代码实现 |
应用场景
查询当前告警。
调试示例
命令行调试
- 不带条件查询10条索引从0开始的事件
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events GetAlarmList 'a{ss}qqa(ss)' 3 Interface cli UserName Administrator ClientAddr <ip> 0 10 0
响应:qa(a(ss)) 1 30 1 "Cause" "1. The power cable is not securely connected or is faulty.@#AB;2. The PSU is faulty." 1 "Description" "The AC/DC input of PSU 2 is lost or out-of-range (SN:xxx, BN:xxx)." 1 "SN" "xxx" 1 "Influence" "The system is powered off unexpectedly." 1 "Suggestion" "1. Check whether the power cables are disconnected or loose.@#AB;2. Replace the power cables.@#AB;3. Replace the PSU." 1 "Timestamp" "1776481334" 1 "TriggerMode" "1" 1 "EventCode" "0x0300000D" 1 "ActionId" "0" 1 "RecordId" "110" 1 "PN" "xxx" 1 "ChassisId" "" 1 "ManagerId" "1" 1 "SystemId" "1" 1 "Severity" "Critical" 1 "MessageArgs" "[\"2\"]" 1 "LedFaultCode" "P02" 1 "ReportChannel" "65535" 1 "SubjectType" "3" 1 "OldEventCode" "0x0803FFFF" 1 "EventName" "PSUInputLost" 1 "AdditionalInfo" "--2" 1 "State" "Asserted" 1 "SensorType" "0x08" 1 "ComponentInstance" "2" 1 "ComponentLocation" "chassis" 1 "ComponentName" "PS--2" 1 "EventReadingType" "0x6f" 1 "EventSequenceNumber" "0x0000000000000027" 1 "NodeId" ""- 查询10条索引从0开始,并且语言为英文、严重等级为紧急的事件
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events GetAlarmList 'a{ss}qqa(ss)' 3 Interface cli UserName Administrator
ClientAddr <ip> 0 10 2 'Lang' 'en' 'Severity' 'Critical'
响应:qa(a(ss)) 1 30 1 "Cause" "1. The power cable is not securely connected or is faulty.@#AB;2. The PSU is faulty." 1 "Description" "The AC/DC input of PSU 2 is lost or out-of-range (SN:xxx, BN:xxx)." 1 "SN" "xxx" 1 "Influence" "The system is powered off unexpectedly." 1 "Suggestion" "1. Check whether the power cables are disconnected or loose.@#AB;2. Replace the power cables.@#AB;3. Replace the PSU." 1 "Timestamp" "1776481334" 1 "TriggerMode" "1" 1 "EventCode" "0x0300000D" 1 "ActionId" "0" 1 "RecordId" "110" 1 "PN" "xxx" 1 "ChassisId" "" 1 "ManagerId" "1" 1 "SystemId" "1" 1 "Severity" "Critical" 1 "MessageArgs" "[\"2\"]" 1 "LedFaultCode" "P02" 1 "ReportChannel" "65535" 1 "SubjectType" "3" 1 "OldEventCode" "0x0803FFFF" 1 "EventName" "PSUInputLost" 1 "AdditionalInfo" "--2" 1 "State" "Asserted" 1 "SensorType" "0x08" 1 "ComponentInstance" "2" 1 "ComponentLocation" "chassis" 1 "ComponentName" "PS--2" 1 "EventReadingType" "0x6f" 1 "EventSequenceNumber" "0x0000000000000027" 1 "NodeId" ""2.2 GetEventList
功能说明
查询历史事件。
| 属性 | 内容 |
|---|---|
| 接口名 | bmc.kepler.Systems.Events |
| 首发版本 | bmcsdk 25.03 |
| 废弃状态 | 正常可用 |
参数说明
| 参数名 | 方向 | 类型 | 描述 | 取值范围 |
|---|---|---|---|---|
| StartId | 输入 | U16 | 事件索引,(正序)从第几个开始查询 | U16 |
| Count | 输入 | U16 | 要查询的事件条数 | U16 |
| QueryParameters | 输入(可选参数) | Array | 条件筛选,详见下表;D-Bus类型为a(ss),即(Key, Value)结构体数组,允许重复传入相同的Key | 数组元素为(Key, Value),其中Key、Value均为字符串类型 |
| Total | 输出 | U16 | 事件总条数 | U16 |
| EventList | 输出 | Array | 事件详细信息列表 | 数组元素仍为数组(记为a1),a1的元素为键值对,其中Key、Value均为字符串类型 |
可选参数
| 参数名称 | 描述 |
|---|---|
| Lang | 查询事件的语言(en:英文,zh:中文),非必选参数,默认英文 |
| SelLevel | 日志级别,按严重等级精确过滤SEL日志(不额外过滤重启类事件),非必选参数。支持的日志级别:Normal/Minor/Major/Critical;可重复传入多个SelLevel,多个值之间为OR关系 |
| SelObjectType | 主体类型,查询符合主体类型条件的SEL日志,非必选参数。可通过查询redfish/v1/Systems/system_id/LogServices/LogServices_id资源获得主体类型列表;可重复传入多个SelObjectType,多个值之间为OR关系 |
| SelBeginTime | 起始时间,查询在起始时间到结束时间范围内产生的SEL日志,非必选参数。支持的日期格式:yyyy-MM-dd HH:mm:ss |
| SelEndTime | 结束时间,查询在起始时间到结束时间范围内产生的SEL日志,非必选参数。支持的日期格式:yyyy-MM-dd HH:mm:ss |
| SelSearchString | 用于模糊匹配事件描述、事件码,ASCII范围(0x20~0x7E),长度0~20字符 |
| SelSelectId | 按RecordId精确查询,非必选参数。传入时仅按RecordId匹配并忽略其他筛选条件(语言除外) |
| SelSelectMode | 查询模式,非必选参数。当前支持ExactQuery:未传SelSelectId时,列表查询返回原始RecordId,不进行SEL转储后的记录号偏移 |
QueryParameters在D-Bus上的类型为a(ss)(结构体数组),不是a{ss}字典,因此允许重复Key;重复的SelLevel/SelObjectType按OR关系过滤。
SelSelectId优先于SelSelectMode;两者同时传入时按SelSelectId精确查询。SelSelectId精确查询返回原始RecordId,不进行SEL转储后的记录号偏移。
GetEventList按SelLevel精确匹配严重等级,不额外过滤重启类事件;重启类事件过滤仅适用于GetAlarmList的Normal查询。
返回值与异常
| 返回值 | 含义 | 触发条件 | 处理建议 |
|---|---|---|---|
| Total不为0 | 成功 | 环境上产生了事件 | 无 |
| Total为0 | 环境上没有产生事件时为成功,如果环境实际产生了事件,则意味着查询失败 | 查询历史事件 | 如果环境实际产生了事件,则要检查入参是否正确 |
| 抛错InternalError | 失败 | 代码内部错误 | 检查CSR配置或代码实现 |
| 抛错PropertyValueError | 失败 | 入参不合法 | 检查入参 |
应用场景
查询历史事件。
限制条件
无
调试示例
命令行调试
- 查询历史事件(不加筛选条件)
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events GetEventList 'a{ss}qqa(ss)' 3 Interface cli UserName <user_name> ClientAddr <ip> 0 10 0
响应:qa(a(ss)) 1 30 1 "Cause" "" 1 "Description" "BMC event records are cleared." 1 "SN" "" 1 "Influence" "" 1 "Suggestion" "" 1 "Timestamp" "947583908" 1 "TriggerMode" "1" 1 "EventCode" "0x1A00000F" 1 "ActionId" "0" 1 "ReportChannel" "65535" 1 "EventReadingType" "0x6f" 1 "OldEventCode" "0x1002FFFF" 1 "ChassisId" "" 1 "ManagerId" "1" 1 "SystemId" "0" 1 "Severity" "Normal" 1 "MessageArgs" "[]" 1 "SubjectType" "26" 1 "RecordId" "1" 1 "PN" "" 1 "SensorType" "0x10" 1 "AdditionalInfo" "" 1 "State" "Asserted" 1 "EventName" "BMCEventCleared" 1 "ComponentInstance" "1" 1 "ComponentLocation" "" 1 "ComponentName" "BMC" 1 "LedFaultCode" "" 1 "EventSequenceNumber" "0x0000000000000050" 1 "NodeId" "00"- 查询历史事件(加筛选条件,未查到满足筛选条件的事件)
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events GetEventList 'a{ss}qqa(ss)' 3 Interface cli UserName Administrator ClientAddr 127.0.0.1 0 10 5 'SelBeginTime' '1970-01-01 00:01:54' 'SelEndTime' '1970-01-02 00:01:11' 'SelSearchString' 'Disk' 'SelObjectType' '2' 'Lang' 'zh'
响应:qa(a(ss)) 0 0- 查询历史事件(Level和Subject多值过滤,多个条件之间为OR关系)
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events GetEventList 'a{ss}qqa(ss)' 3 Interface cli UserName Administrator ClientAddr <ip> 0 10 4 'SelLevel' 'Minor' 'SelLevel' 'Major' 'SelObjectType' '3' 'SelObjectType' '4'
响应:qa(a(ss)) 0 0(示例环境无匹配事件)2.3 ClearEventList
功能说明
清除所有事件。
| 属性 | 内容 |
|---|---|
| 接口名 | bmc.kepler.Systems.Events |
| 首发版本 | bmcsdk 25.03 |
| 废弃状态 | 正常可用 |
参数说明
无
应用场景
清除所有事件。
调试示例
命令行调试
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events ClearEventList a{ss} 3 Interface cli UserName Administrator ClientAddr <ip>2.4 MockEvent
功能说明
事件模拟接口。
| 属性 | 内容 |
|---|---|
| 接口名 | bmc.kepler.Systems.Events |
| 首发版本 | bmcsdk 25.03 |
| 废弃状态 | 正常可用 |
参数说明
| 参数名 | 方向 | 类型 | 描述 | 取值范围 |
|---|---|---|---|---|
| EventCode | 输入 | String | 事件码 | String |
| Enabled | 输入 | U8 | 模拟状态标识 | 0:关闭模拟,1:开启模拟 |
| ObjectIndex | 输入 | U16 | 事件下标 | U16 |
| MockState | 输入 | U8 | 事件状态 | 1:生成告警,0:恢复告警 |
返回值与异常
| 返回值 | 含义 | 触发条件 | 处理建议 |
|---|---|---|---|
| 无返回值 | 成功 | 参数合法且未被限流,模拟任务已提交(异步执行) | 稍后通过GetAlarmList/GetEventList确认模拟结果 |
| 无返回值(静默忽略) | 请求被限流 | 距上次MockEvent调用不足500ms | 等待至少500ms后重试;不要仅凭接口返回成功判断模拟已生效 |
| 抛错PropertyValueError | 失败 | EventCode非法或事件码无匹配对象、Enabled/MockState取值非法、ObjectIndex越界 | 检查入参及事件定义 |
| 抛错ResourceInUse | 失败 | 并发模拟任务达到上限 | 等待现有模拟任务完成后重试 |
应用场景
模拟告警事件。接口调用存在最小间隔限制,短时间重复调用时后续请求会被忽略但仍返回成功;实际模拟任务为异步执行。
调试示例
命令行调试
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events MockEvent a{ss}syqy 3 Interface cli UserName Administrator ClientAddr <ip> 0x0200000B 1 1 12.5 MaskEvent
功能说明
屏蔽事件接口。
| 属性 | 内容 |
|---|---|
| 接口名 | bmc.kepler.Systems.Events |
| 首发版本 | bmcsdk 25.03 |
| 废弃状态 | 正常可用 |
参数说明
| 参数名 | 方向 | 类型 | 描述 | 取值范围 |
|---|---|---|---|---|
| EventCode | 输入 | String | 事件码 | String |
| MaskState | 输入 | U8 | 屏蔽状态 | 0:开启屏蔽,1:关闭屏蔽 |
| Mode | 输入 | U8 | 屏蔽模式 | 1:NONE,不保存屏蔽状态,重启失效 2:RESET,重启后保持屏蔽 3:AC后保持屏蔽 |
返回值与异常
| 返回值 | 含义 | 触发条件 | 处理建议 |
|---|---|---|---|
| 无返回值 | 成功 | 屏蔽状态设置成功 | 通过GetMaskedEventList确认结果 |
| 抛错PropertyValueError | 失败 | Mode或MaskState取值非法 | 检查屏蔽状态和屏蔽模式 |
| 抛错InvalidValue | 失败 | EventCode不存在 | 检查事件码是否已定义 |
应用场景
屏蔽事件接口。
调试示例
命令行调试
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events MaskEvent a{ss}syy 3 Interface cli UserName Administrator ClientAddr <ip> '0x0200000B' 0 12.6 GetEventInfo
功能说明
查询事件配置版本与事件数量信息。
| 属性 | 内容 |
|---|---|
| 接口名 | bmc.kepler.Systems.Events |
| 首发版本 | bmcsdk 25.03 |
| 废弃状态 | 正常可用 |
参数说明
| 参数名 | 方向 | 类型 | 描述 | 取值范围 |
|---|---|---|---|---|
| Version | 输出 | String | 事件配置版本 | String |
| CurEventCount | 输出 | U16 | 当前事件数量 | U16 |
| MaxEventCount | 输出 | U16 | 最大事件数量 | U16 |
返回值与异常
| 返回值 | 含义 | 触发条件 | 处理建议 |
|---|---|---|---|
| 返回Version、CurEventCount、MaxEventCount | 成功 | 接口正常返回 | 无 |
| CurEventCount为0 | 当前没有事件 | 系统中尚未产生事件 | 结合业务确认是否应产生事件;若应有事件,检查事件注册与CSR配置 |
| 抛错InternalError | 失败 | 代码内部错误 | 检查CSR配置或代码实现 |
应用场景
查询事件配置版本、当前事件数量和最大事件数量,用于容量评估与问题定位。
调试示例
命令行调试
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events GetEventInfo a{ss} 3 Interface cli UserName Administrator ClientAddr <ip>
响应:sqq "1.0.0" 2 10000
GetEventInfo方法返回的CurEventCount和MaxEventCount为U16;Events接口同名属性为U32,两者是不同接口签名,读取时以各自接口定义为准。
2.7 GetMaskedEventList
功能说明
查询屏蔽事件列表。
| 属性 | 内容 |
|---|---|
| 接口名 | bmc.kepler.Systems.Events |
| 首发版本 | bmcsdk 25.03 |
| 废弃状态 | 正常可用 |
参数说明
| 参数名 | 方向 | 类型 | 描述 | 取值范围 |
|---|---|---|---|---|
| MaskedEventList | 输出 | Array | 屏蔽事件列表信息,包括EventCode:被屏蔽事件的事件码、EventName:被屏蔽事件的事件标识 | Array |
应用场景
查询屏蔽事件列表。
调试示例
命令行调试
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events GetMaskedEventList a{ss} 3 Interface cli UserName Administrator ClientAddr <ip>
响应:a(ss) 2 "0x1A000053" "BMCAccessI2CDeviceFailure" "0x2C000073" "SystemPowerHigh"2.8 AddEvent
功能说明
添加软件告警。接口返回本次添加事件对应的记录标识RecordId。
| 属性 | 内容 |
|---|---|
| 接口名 | bmc.kepler.Systems.Events |
| 首发版本 | bmcsdk 25.03 |
| 废弃状态 | 正常可用 |
参数说明
| 参数名 | 方向 | 类型 | 描述 | 取值范围 |
|---|---|---|---|---|
| EventInfo | 输入 | Array | 事件信息集合 | 必选参数:(ComponentName:事件主体名称 State:事件状态 EventKeyId:事件标识 MessageArgs:动态参数列表 SystemId:事件归属的SystemId ManagerId:事件归属的ManagerId ChassisId:事件归属的ChassisId NodeId:事件对应的对象) 可选参数:(SubjectType:事件主体类型 SuggestionArgs:事件建议参数 LedFaultCode:LED显示故障码 AdditionalInfo:事件关联部件的补充信息 Timestamp:事件产生时间戳 AffectHardwareHealth:是否参与硬件健康判断) |
| RecordId | 输出 | String | 添加事件对应的记录标识 | String;添加失败时返回"0" |
参数含义
| 参数名称 | 描述 |
|---|---|
| ComponentName | 事件主体名称(必选) |
| State | 事件状态(必选,“true”/“false”) |
| EventKeyId | 事件标识(必选,唯一) |
| SuggestionArgs | 事件建议参数(可选) |
| SubjectType | 事件主体类型(可选)(默认由事件码推导) |
| MessageArgs | 事件描述动态参数(必选) |
| SystemId | 事件归属的SystemId(必选) |
| ManagerId | 事件归属的ManagerId(必选) |
| ChassisId | 事件归属的ChassisId(必选) |
| NodeId | 事件对应的对象(必选) |
| LedFaultCode | LED显示故障码(可选) |
| AdditionalInfo | 事件关联部件的补充信息(可选) |
| Timestamp | 事件产生时间戳(可选,非负整数) |
| AffectHardwareHealth | 是否参与硬件健康判断(可选,true/1表示参与,false/0表示不参与,默认false) |
注释
- MessageArgs、SuggestionArgs需要使用cjson.encode将表编码为字符串。
- ComponentName需要有效,与实际的Component匹配。
- EventName由EventKeyId对应的静态配置推导,不需要传入。
- 无法重复生成同一状态的事件,产生后需要有对应的恢复操作(如
State传false)。 - AffectHardwareHealth仅控制是否参与
HardwareHealth统计,不影响Health统计。 - 硬件事件的参与开关由CSR中Event对象的
AffectHardwareHealth属性配置(默认true);软件事件通过本接口入参控制(默认false)。
返回值与异常
| 返回值 | 含义 | 触发条件 | 处理建议 |
|---|---|---|---|
| RecordId | 成功 | 软件事件添加成功 | 保存返回的记录标识,用于恢复或问题跟踪 |
| "0" | 未生成事件 | 状态重复、组件未匹配或服务处于重启流程 | 检查事件是否已处于相同状态,确认组件对象存在 |
| 抛错PropertyValueError | 失败 | 必选参数缺失或非法、EventKeyId未定义、State非法、SubjectType/Timestamp非法、ComponentName无效、事件已被屏蔽 | 检查入参、事件定义、Component对象和屏蔽状态 |
| 抛错InternalError | 失败 | 代码内部错误 | 检查事件组件日志与CSR配置 |
应用场景
组件通过本接口产生或恢复软件告警。需要软件告警参与硬件健康判断时,传入AffectHardwareHealth为true或1。
调试示例
命令行调试
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events AddEvent 'a{ss}a(ss)' 3 Interface cli UserName Administrator ClientAddr <ip> 9 ComponentName 'BMC' State 'true' EventKeyId 'BMC.InsecureCryptographicAlgorithm' 'MessageArgs' '["SSHKexs","diffie-hellman-group14-sha1,diffie-hellman-group-exchange-sha1"]' 'SystemId' '1' 'ManagerId' '1' 'ChassisId' '1' 'NodeId' '1' 'AffectHardwareHealth' 'true'响应示例:
s "110"返回的RecordId可用于后续恢复事件或问题跟踪。恢复事件时保持其他参数不变,将State置为false。
2.9 ExportEvent
功能说明
导出历史事件记录。接口创建异步导出任务并返回任务标识TaskId,任务完成后可在目标路径获取导出文件。
| 属性 | 内容 |
|---|---|
| 接口名 | bmc.kepler.Systems.Events |
| 首发版本 | bmcsdk 25.03 |
| 废弃状态 | 正常可用 |
参数说明
| 参数名 | 方向 | 类型 | 描述 | 取值范围 |
|---|---|---|---|---|
| Path | 输入 | String | 导出目标路径 | 本地路径:必须以/tmp/开头且长度不超过255字符;远程路径:支持https:、sftp:、nfs:、cifs:、scp:协议 |
| TaskId | 输出 | U32 | 导出任务标识,用于拼接任务路径 | U32 |
返回值与异常
| 返回值 | 含义 | 触发条件 | 处理建议 |
|---|---|---|---|
| TaskId | 成功 | 导出任务创建成功 | 通过任务机制查询进度并到目标路径获取文件 |
| 抛错PropertyValueFormatError | 失败 | 本地路径长度超过255字符 | 缩短导出路径 |
| 抛错InvalidPath | 失败 | 本地路径不在/tmp下、包含..、空格、Shell特殊字符、控制字符或tar注入参数 | 使用合法的/tmp路径 |
| 抛错FileTransferProtocolMismatch | 失败 | 远程路径协议不支持 | 使用支持的远程协议 |
| 抛错DuplicateExportingErr | 失败 | 已有导出任务正在执行 | 等待当前任务结束后重试 |
| 抛错InternalError | 失败 | 任务创建失败或服务不可用 | 检查事件组件日志和任务服务状态 |
应用场景
用于导出历史事件记录(SEL),支持本地下载和远程文件传输。
限制条件
- 本地导出路径必须位于
/tmp目录下。 - 同一时间只允许一个导出任务执行。
- 本地路径导出文件为tar包;路径以
.tar.gz结尾时生成gzip压缩包。
调试示例
命令行调试
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events ExportEvent 'a{ss}s' 3 Interface cli UserName Administrator ClientAddr <ip> '/tmp/event.tar.gz'
响应:u 12.10 CheckEventName
功能说明
批量校验事件名称(EventName)是否已定义。
| 属性 | 内容 |
|---|---|
| 接口名 | bmc.kepler.Systems.Events |
| 首发版本 | bmcsdk 25.03 |
| 废弃状态 | 正常可用 |
参数说明
| 参数名 | 方向 | 类型 | 描述 | 取值范围 |
|---|---|---|---|---|
| EventName | 输入 | String[] | 需要校验的EventName列表 | String[] |
| Result | 输出 | Boolean[] | 校验结果列表,顺序与输入一致;true表示已定义 | Boolean[] |
应用场景
供上层组件或接口定制在引用事件名称前校验事件定义是否存在。
调试示例
命令行调试
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events CheckEventName 'a{ss}as' 3 Interface cli UserName Administrator ClientAddr <ip> 2 'PSUInputLost' 'NotExistEvent'
响应:ab 2 true false2.11 SetAlarmName
功能说明
定制告警名称。设置后,告警描述、建议、原因和影响中的默认名称BMC会被替换为指定名称,并持久化保存。
| 属性 | 内容 |
|---|---|
| 接口名 | bmc.kepler.Systems.Events |
| 首发版本 | bmcsdk 25.03 |
| 废弃状态 | 正常可用 |
参数说明
| 参数名 | 方向 | 类型 | 描述 | 取值范围 |
|---|---|---|---|---|
| AlarmName | 输入 | String | 定制的告警名称 | String |
应用场景
用于OEM定制或品牌化场景,替换告警文案中的默认产品名称。
调试示例
命令行调试
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events SetAlarmName 'a{ss}s' 3 Interface cli UserName Administrator ClientAddr <ip> 'OpenUBMC'
响应:无输出2.12 SetEventSeverity
功能说明
设置指定事件码对应事件的严重等级,并持久化保存。
| 属性 | 内容 |
|---|---|
| 接口名 | bmc.kepler.Systems.Events |
| 首发版本 | bmcsdk 25.03 |
| 废弃状态 | 正常可用 |
参数说明
| 参数名 | 方向 | 类型 | 描述 | 取值范围 |
|---|---|---|---|---|
| EventCode | 输入 | String | 告警码 | 形如0x0200000B的合法事件码 |
| Severity | 输入 | U8 | 设置的告警级别 | 0:Normal,1:Minor,2:Major,3:Critical |
返回值与异常
| 返回值 | 含义 | 触发条件 | 处理建议 |
|---|---|---|---|
| 无返回值 | 成功 | 严重等级设置成功 | 重新查询告警确认等级 |
| 抛错PropertyValueError | 失败 | EventCode非法或不存在、Severity取值非法 | 检查事件码和严重等级 |
| 抛错InternalError | 失败 | 持久化或内部处理失败 | 检查事件组件日志 |
应用场景
用于Redfish EventService.SetEventSeverityLevel等上层接口调整告警严重等级。
调试示例
命令行调试
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events SetEventSeverity 'a{ss}sy' 3 Interface cli UserName Administrator ClientAddr <ip> '0x0200000B' 2
响应:无输出2.13 SetEventAction
功能说明
设置指定事件产生后执行的动作,并持久化保存。
| 属性 | 内容 |
|---|---|
| 接口名 | bmc.kepler.Systems.Events |
| 首发版本 | bmcsdk 25.03 |
| 废弃状态 | 正常可用 |
参数说明
| 参数名 | 方向 | 类型 | 描述 | 取值范围 |
|---|---|---|---|---|
| EventKeyId | 输入 | String | 事件定义标识 | 已定义的事件EventKeyId |
| Action | 输入 | U8 | 设置的事件动作 | 0:无动作,1:下电0S,2:复位OS,3:下电后上电 |
返回值与异常
| 返回值 | 含义 | 触发条件 | 处理建议 |
|---|---|---|---|
| 无返回值 | 成功 | 动作设置成功 | 触发对应事件验证动作 |
| 抛错PropertyValueError | 失败 | EventKeyId不存在或Action取值非法 | 检查事件定义和动作取值 |
| 抛错InternalError | 失败 | 持久化失败 | 检查数据库和事件组件日志 |
应用场景
用于配置事件产生后的主机电源动作,例如故障时下电或复位OS。
调试示例
命令行调试
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events SetEventAction 'a{ss}sy' 3 Interface cli UserName Administrator ClientAddr <ip> 'BMC.InsecureCryptographicAlgorithm' 0
响应:无输出2.14 AddSel
功能说明
动态添加OEM SEL记录,并生成对应的Event对象。
| 属性 | 内容 |
|---|---|
| 接口名 | bmc.kepler.Systems.Events |
| 首发版本 | bmcsdk 25.03 |
| 废弃状态 | 正常可用 |
参数说明
| 参数名 | 方向 | 类型 | 描述 | 取值范围 |
|---|---|---|---|---|
| EventInfo | 输入 | Array | SEL事件信息集合 | 必选参数:EventCode、OldEventCode、Severity、State、Description、SubjectType、SystemId |
参数含义
| 参数名称 | 描述 |
|---|---|
| EventCode | 事件码(必选) |
| OldEventCode | 旧事件码(必选) |
| Severity | 事件严重等级(必选,Normal/Minor/Major/Critical) |
| State | 事件状态(必选,Assert/1表示产生,其他值表示恢复) |
| Description | 事件描述(必选) |
| SubjectType | 事件主体类型(必选) |
| SystemId | 事件归属的SystemId(必选) |
返回值与异常
| 返回值 | 含义 | 触发条件 | 处理建议 |
|---|---|---|---|
| 无返回值 | 成功 | SEL事件提交成功 | 通过GetEventList查询新增记录 |
| 抛错InvalidField | 失败 | 必选参数缺失 | 检查EventInfo中的必选参数 |
应用场景
用于OEM定制场景动态注入SEL事件;处理为异步执行,查询结果可能存在短暂延迟。
调试示例
命令行调试
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events AddSel 'a{ss}a(ss)' 3 Interface cli UserName Administrator ClientAddr <ip> 7 'EventCode' '0x0200000B' 'OldEventCode' '0x0200FFFF' 'Severity' 'Minor' 'State' 'Assert' 'Description' 'OEM SEL test' 'SubjectType' '2' 'SystemId' '1'
响应:无输出2.15 GetAlarmSpecifiedFields
功能说明
查询当前所有告警中指定字段的值列表,结果按值去重且忽略空值。
| 属性 | 内容 |
|---|---|
| 接口名 | bmc.kepler.Systems.Events |
| 首发版本 | bmcsdk 26.06 |
| 废弃状态 | 正常可用 |
参数说明
| 参数名 | 方向 | 类型 | 描述 | 取值范围 |
|---|---|---|---|---|
| EventFieldName | 输入 | String | 待查询的字段名称 | 当前仅支持LedFaultCode |
| EventFieldValues | 输出 | String[] | 当前所有告警的指定字段内容列表 | String[] |
返回值与异常
| 返回值 | 含义 | 触发条件 | 处理建议 |
|---|---|---|---|
| EventFieldValues | 成功 | 查询完成 | 无 |
| 空列表 | 成功 | 当前告警不存在该字段或字段值为空 | 结合当前告警列表确认 |
| 抛错PropertyValueError | 失败 | EventFieldName不支持 | 使用LedFaultCode |
应用场景
用于上层接口汇总当前告警关联的LED故障码等信息。
调试示例
命令行调试
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events GetAlarmSpecifiedFields 'a{ss}s' 3 Interface cli UserName Administrator ClientAddr <ip> 'LedFaultCode'
响应:as 2 'P02' 'P03'2.16 关键属性
bmc.kepler.Systems.Events
对象路径:/bmc/kepler/Systems/:SystemId/Events
| 属性名 | 类型 | 可读写 | 描述 |
|---|---|---|---|
| Health | String | 只读 | 系统健康状态,取值:Normal/Minor/Major/Critical |
| HardwareHealth | String | 只读 | 硬件健康状态,取值:Normal/Minor/Major/Critical;由参与硬件健康判断的事件中最高严重等级决定 |
| EventRecordSeq | U64 | 只读 | 事件记录标识,随着事件产生递增 |
| CriticalCount | U32 | 只读 | 致命告警数量 |
| MajorCount | U32 | 只读 | 严重告警数量 |
| MinorCount | U32 | 只读 | 一般告警数量 |
| Version | String | 只读 | 当前事件配置的版本 |
| CurEventCount | U32 | 只读 | 当前事件数量 |
| MaxEventCount | U32 | 只读 | 最大事件数量 |
| DumpRecord | U64 | 只读 | SEL日志转储的总量,每次转储均会累加 |
| MajorVersion | String | 只读 | 告警语言配置的主版本 |
| MinorVersion | String | 只读 | 告警语言配置的次要版本 |
| AuxVersion | String | 只读 | 告警语言配置的辅助版本 |
| EventMode | U8 | 读写 | 事件记录模式:0表示默认模式,记录达到最大数量后转储;1表示记录达到最大数量后环形记录 |
bmc.kepler.Systems.EventSummary
对象路径:/bmc/kepler/Systems/:SystemId/EventSummary
| 属性名 | 类型 | 可读写 | 描述 |
|---|---|---|---|
| MinorCount | U32 | 只读 | 当前System的一般事件汇总数量 |
| MajorCount | U32 | 只读 | 当前System的严重事件汇总数量 |
| CriticalCount | U32 | 只读 | 当前System的紧急事件汇总数量 |
| Health | String | 只读 | 当前System的健康状态,取值:Normal/Minor/Major/Critical |
| HardwareHealth | String | 只读 | 当前System的硬件健康状态,取值:Normal/Minor/Major/Critical;由参与硬件健康判断的事件中最高严重等级决定 |
调试示例
命令行调试
busctl --user get-property bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events Health
响应:s "Normal"busctl --user set-property bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events EventMode y 1
响应:无输出3. 组件扩展案例
3.1 扩展能力概述
不适用
4. 日志说明
4.1 一键日志收集
| 文件路径 | 内容说明 |
|---|---|
| AppDump/event/current_event.txt | 记录当前告警 |
| AppDump/event/sel.txt AppDump/event/eo_sel.csv | 记录历史事件 |
| AppDump/event/mask_event.txt | 记录屏蔽的事件 |
| AppDump/event/event.db AppDump/event/event_reset.db | 持久化数据库 |
| LogDump/event/alarm.log | 事件硬件对象注册信息以及最近三次的读值 |
4.2 关键日志信息
| 日志片段 | 日志级别 | 含义解读 | 建议处理动作 |
|---|---|---|---|
| Event xxx has no associated component | ERROR | 事件未关联Component对象 | 检查事件CSR中的Component配置及对象解析结果 |
| Event xxx has no component path | ERROR | 事件关联的Component对象缺少path信息 | 检查Component对象是否已正确加载 |
| query definition failed for EventKeyId=xxx | WARNING | 查询事件静态定义失败 | 检查EventKeyId配置及事件定义数据库 |
| register_event_from_object: xxx failed | ERROR | 事件对象注册失败 | 结合异常信息检查事件定义、Component和事件对象属性 |
| Component for event code xxx not found, registration skipped | WARNING | 模拟事件未找到关联Component,注册被跳过 | 检查模拟事件码对应的Component是否存在 |
| add_event: event code xxx is masked | ERROR | 软件事件对应的事件码已被屏蔽 | 检查屏蔽配置,必要时调用MaskEvent解除屏蔽 |
5. 问题定界指南
5.1 典型问题定界
| 现象描述 | 是否为本组件问题 | 判断依据 | 关键证据收集方法 |
|---|---|---|---|
| 告警描述不符合预期 | 否 | Event组件仅提供告警描述的公共机制,传入的参数及格式由开发者自行实现 | 查看告警描述涉及参数的数据源 |
| 告警关联的数据源读数达到了告警门限,但是没有产生告警 | 是 | 已满足告警条件但是未产生告警 |
5.2 调试方法
开启调试日志
busctl资源协作接口方法调试见文档第二章节。
复现问题方法
- CSR不配置要验证的事件,或CSR配置了事件但是未关联对应的Component对象,查看事件的注册情况,预期注册失败
6. 常见问题解答
常见问题解答请查阅《事件告警常见问题》。
附录
附录A 参考资料
附录B 修订记录
| 版本 | 日期 | 修订人 | 修订内容 |
|---|---|---|---|
| v1.0 | 2026-04-30 | mkdlf | 初始版本创建 |
| v1.1 | 2026-11-03 | mkdlf | 适配event_mgmt 0.0.111 C++重构版本,补充接口、HardwareHealth属性及日志说明 |