跳转至

实体类型管理


本文档介绍如何自定义实体类型,扩展统一目录的资产管理能力。

进入统一目录 > 实体列表,点击左侧栏“设置”图标,选择“管理实体类型”,即可进入实体类型管理页面。

新建实体类型

  1. 在实体类型管理页面右上角点击“新建实体类型”;
  2. 填写基本信息:

    • 实体类型:全局唯一标识,如 kubernetes_deployment
    • 显示名:输入实体类型的显示名;
    • 描述:按需补充说明该类型的用途;
    • 展开“高级配置(可选)”区域,通过 YAML 自定义 Data Schema、显示列及关联视图;
    • 点击“保存”完成创建。
注意
  • 实体类型标识不允许重复,若已存在系统将提示错误;
  • 删除类型前,需确保该类型下无关联实体,否则无法删除。

高级配置(可选)

在新建或编辑实体类型时,基本信息下方展示“高级配置(可选)”区域,系统将基于默认模板生成以下配置,您可以直接使用默认配置,也可以按需编辑 YAML。

数据 Schema 配置

定义实体类型的字段、来源、必填、校验规则等。默认根据系统默认 DataSchema 模板生成 YAML 预览。

  • 官方实体类型:以 dataschema.yaml 作为基础,支持追加 custom_properties
  • 自定义实体类型:基于统一目录默认模板作为基础,支持自定义字段、来源、必填、枚举、默认值及校验规则。

点击查看数据 Schema 配置说明

默认显示列配置

用于配置实体列表中的固定列、默认列和可选列。

配置规则:

  • field:字段名;
  • fixed:是否为固定显示列,默认为 false。固定列始终展示,不出现在显示列启用/禁用清单中;
  • hidden:是否默认隐藏,默认为 falsefalse 表示默认展示,true 表示默认不展示,但可在显示列配置中开启;
  • 简写方式如 nameentity_type 等价于 field: namefield: entity_type,并默认展示;
  • 用户个人列偏好优先于类型默认配置。

点击查看默认显示列配置说明

配置实体详情页中的关联视图。

  • 对于官方配置,支持通过 YAML 启用或关闭内置关联视图;
  • 支持通过 YAML 添加自定义关联视图;
  • 日志关联视图如需配置默认索引,通过 YAML 中的 index 字段配置,多个索引使用数组形式。

配置示例:

telemetry:
  - name: { zh-CN: "错误日志", en-US: "Error Logs" }
    type: explorer
    viewName: logs
    index: ["app-prod", "gateway-prod"]
    query: "service='{{metadata.service}}' AND df_status NOT IN ['ok','info']"

点击查看关联视图配置说明

实体类型列表

实体类型列表页面展示当前工作空间内所有实体类型,包括系统预设、官方内置和自定义类型。列表展示各类型的显示名、实体类型标识、描述、实体数量及分类标签。

类型分类

分类 包含类型
系统预设 system(系统)
官方内置 服务、主机、数据库、队列、K8s Service、Deployment 等
自定义 用户创建的类型(如 K8s 资源、业务域等)
权限限制
  • system 类型支持编辑和健康度配置
  • 其他官方内置类型仅支持编辑;
  • 自定义类型支持编辑和删除。

健康度配置

system 类型支持健康度配置,用于为所有该系统类型的实体统一设置默认的健康度计算方式。

点击 system 类型行操作菜单中的“健康度配置”,选择任一以下两种方式:

方式 说明
默认算法 使用上述平台内置聚合算法计算健康度
自定义函数 调用 Func 平台函数计算健康度。选择后需指定具体的 Func 函数
生效规则
  1. 此处配置作为该系统类型的默认规则,对所有 system 实体生效;
  2. 在新建或编辑某个 system 实体时,您可以选择跟随默认配置,或单独指定自定义函数。单独指定的实体不受此处配置变更影响;
  3. 若此处配置的自定义函数被删除或不可用,跟随默认配置的实体健康度将显示为"未知"。已单独指定的实体不受影响。

什么是系统健康度

系统(system)是用户自建的业务聚合实体,代表一个业务系统或平台集合(如“支付系统”“订单系统”)。由于告警/事件通常关联其下层的服务、主机、数据库等实体,而非直接关联系统本身,系统健康度通过聚合其组成实体的未恢复告警状态计算得出。

简单来说:系统健康度反映的是“组成这个系统的各个部分”整体运行得怎么样。

健康状态说明

系统健康度分为四种状态:

状态 分数区间 含义 常见场景
正常 80–100 组成实体整体运行良好,无未恢复告警 所有组成实体均无活跃告警
关注 60–79 组成实体存在需关注的异常 部分实体有 warning 或 error 级别告警
严重 0–59 组成实体存在严重异常,建议立即处理 核心实体有 fatal/critical 告警,或多个实体同时故障
未知 健康度暂时无法计算 系统暂无组成实体,或新建系统后首次计算尚未完成
默认算法说明

默认算法基于以下三步聚合计算:

1. 确定组成实体及其重要性

系统健康度基于其组成实体(如服务、主机、数据库等)计算。不同实体对系统的影响程度不同:

  • 每个实体都有基础重要等级,等级越高的实体对系统健康度影响越大;
  • 您也可以在系统中为某个组成实体调整其健康影响权重,覆盖默认等级;
  • 若某个实体设置为"不参与计算",则该实体的告警不影响系统健康度。

2. 评估单个实体的告警影响

当组成实体存在未恢复告警时,平台会根据告警严重程度进行扣分:

告警严重程度 对实体的影响
fatal / critical 严重扣分
error 中等扣分
warning 轻微扣分
info / 已恢复 不扣分

同一实体同时存在多个活跃告警时,平台取影响最大的前 3 个活跃故障,按递减系数叠加(第 1 个按全额,第 2 个按 50%,第 3 个按 25%)。这样既避免了大量低级告警导致分数失真,也不会低估多故障并发的风险。

3. 加权计算系统总分并判定状态

系统分数采用加权平均方式计算:

  • 将每个组成实体的告警扣分乘以其重要性权重;
  • 对所有组成实体的加权扣分求和,再除以总权重;
  • 用 100 分减去上述加权平均扣分,得到最终系统分数。

状态判定

分数区间 状态
80–100 正常
60–79 关注
0–59 严重
自定义函数

管理关联视图

点击单行实体右侧图标,进入“管理关联视图”页面。页面分为内置关联视图自定义关联视图两个区域。

内置关联视图

系统默认提供的关联视图,可按需开启或关闭。

  • 若当前实体类型存在官方内置视图,页面将自动列出,默认处于启用状态;
  • 启用/禁用:支持自定义开启或关闭当前视图的展示。

关闭后,该视图不再在实体详情页中展示。

自定义关联视图

支持按规范格式自定义配置关联视图。

配置完成后,该类型所有实体在详情页均会展示对应的 tab,便于快速下钻分析。

点击查看配置详情

配置完成后,该类型所有实体在详情页均会展示对应的 tab,便于快速下钻分析。

文档评价

文档内容是否对您有帮助? ×