概要介绍
故障知识库是接口平台为支持API透传过程中故障信息的集中管理而提供的功能性模块,其主要目标在于实现对故障信息的收集、结构化存储、自动关联及解决方案的展示,从而提升运维人员在面对API透传异常时的响应效率与处理准确性。
故障信息维护
对于高频故障,务必及时录入并完善解决方案,形成团队共享资产
故障信息维护
入口路径:API运维 > 故障知识库
在此页面,可以看到所有故障信息条目和其解决方案,并按需进行新增或编辑。
关键字段说明:
- 知识分类:分为“内部错误”(程序异常)和“业务错误”(断言失败)
- 故障级别:标识故障对系统影响的严重程度
- 知识来源:手动录入 or 自动提取
故障提取配置
故障信息除了手动录入外,还支持自动提取
配置入口:服务注册 > API详情 > API后端 > 故障提取配置
配置三要素:
- 故障信息类型:如故障编码、故障详情、解决方案
- 响应对象:状态码、JSON、XML 或 响应内容
- 字段路径:使用 JSONPath/XPath 定位具体字段
相似度阈值:
- 默认 80%:过高 → 频繁新建重复知识;过低 → 无法匹配有效方案
- 系统优先按故障编码全等匹配,无编码则用故障详情做相似度匹配
自动关联:让系统“找方案”
当API调用的平台响应状态为“失败” 或 业务状态为“失败” 时,日志详情页将自动显示“故障解决方案”Tab页。
解决方案展示
查看入口: 接口平台 > API监控 接口平台 > 日志集成链路
当API调用“失败”时,日志页会自动出现 「故障解决方案」Tab 页,展示:
- 知识名称
- 解决方案
- 知识来源(标注“自动匹配”)
实用功能按钮: 编辑解决方案:一键跳转至知识编辑页 查看更多解决方案:基于当前异常信息,重新搜索知识库,提供备选方案
向量(Vector)匹配,更智能
除了传统的文本相似度匹配,平台还支持基于向量库的智能匹配,适用于大规模知识库场景。
向量匹配
向量库的智能匹配,优势明显:
- 匹配速度更快
- 支持大规模知识预处理
启用步骤:
步骤1:创建向量库(可选)
- 进入【AIGC平台 > 向量库管理】;
- 若无默认向量库,需新建一个(建议联系管理员确认)。
步骤2:创建知识库
- 路径:【AIGC平台 > 知识库管理 > 知识库定义】;
- 点击“新建”,名称建议为“故障知识库”;
- 保存后进入详情页,打开【知识资源】Tab;
- 新建一个知识资源(名称可同为“故障知识库”),用于绑定数据源。
步骤3:启用向量匹配
- 返回接口平台的【基础配置】;
- 开启“启用向量匹配”选项;
- 选择上一步创建的知识库;
- 保存配置。
步骤4:数据同步
- 首次启用时,系统将自动执行全量同步,将现有故障知识导入向量库;
- 后续每当故障知识发生增删改,系统将增量同步至向量库。
当API调用“失败”时,日志页会自动出现 「故障解决方案」Tab 页,匹配模式变更为向量匹配。
结语
故障知识库作为接口平台的重要运维支撑模块,提供了一套完整的故障信息生命周期管理机制,该功能适用于所有依赖API透传的业务场景,尤其在高频率、多租户、复杂业务断言的环境中,能够显著降低MTTR(平均修复时间),提升系统可观测性与运维标准化水平。
汉得企业级系统集成平台(中文名集星獭,英文名JeeStar),是一站式多系统集成、多云集成、多端集成、多协议集成、多设备集成、数据集成、页面集成的全域集成解决方案。集成平台沉淀了汉得多年ToB项目实施的系统集成经验,在消除企业信息孤岛、数据孤立、打通多源多端的数据断链及混合云对接等场景中提供了高效便捷的功能及策略方案。
联系我们
-
如果您想了解集星獭更详细的功能介绍和产品信息,请查阅我们的产品文档。 移动端 👉:集星獭产品文档 PC端 👉:open.hand-china.com/document-ce…
-
如果您有疑问或者建议,可以通过开放平台进行工单反馈,问题分类请选择【产品/集星獭JeeStar】 👉 open.hand-china.com
-
相关产品咨询或更多信息了解,欢迎联系我们。 邮箱:jeestar@sys.hand-china.com