自定义字段
title: "自定义字段"
description: "了解、配置和使用自定义字段"
date: "2024-05-11T10:00:00+08:00"
url: "https://docs.flashcat.cloud/zh/flashduty/custom-fields"
了解、配置和使用自定义字段。
视频介绍
使用场景
FlashDuty 已支持接入大部分常见的告警系统,我们将推送内容中的大部分信息放到了 Labels 进行展示。尽管如此,我们用户还是会有一些扩展或定制性的需求,比如人工标记一个故障是否为误报。因此我们提供了自定义字段功能,来进一步丰富故障描述。
通过自定义字段,您可以添加自定义的元数据,记录特定的故障相关信息,并在故障处理过程中传递和使用这些信息。以下是的自定义字段常见使用场景:
- 灵活定义:您可以根据需要创建多个自定义字段,并定义字段的名称、类型、可选项和默认值。常见的自定义字段类型包括文本、下拉列表、Checkbox等。
- 信息关联:通过自定义字段,可以将故障与其他相关数据关联起来。例如,可以添加自定义字段来标识受影响的系统、地理位置、关联的客户或是否误报等。
- 筛选和分类:故障列表支持按照自定义字段筛选和分类视图。您可以根据自定义字段的值来创建常用筛选项,以便更好地组织和处理故障。
配置自定义字段
创建字段
:::highlight orange 💡
一个账户最多支持创建15个自定义字段。
:::
进入控制台 故障管理=>自定义字段
点击 创建自定义字段
输入以下信息
- 字段名称:API 中标识字段,创建后不可修改。
- 展示名称:故障详情页中的展示字段,创建后可以修改。
- 字段描述:辅助故障处理人理解和使用该字段。
选择字段类型,按需添加可选项以及默认值。字段类型有如下选择:
- 文本:纯文本输入框,最多输入500字符。
- 单选:单选下拉框,允许输入十个选项,每个可选项不得超过200字符。
- 多选:多选下拉框,允许输入十个选项,每个可选项不得超过200字符。
- 复选:Checkbox。
点击 提交,完成
:::highlight orange 💡
如果字段设置了默认值,系统将在故障生成时,自动写入该字段,并赋予默认值。注意,字段仅对新故障生效,对已有的故障没有任何影响。
:::
更新字段
仅允许更新以下部分内容:
- 展示名称
- 字段描述
- 字段可选项(仅单选和多选类型)
- 默认值
:::highlight orange 💡
字段更新后仅对新故障生效,对已有的故障没有任何影响。
:::
删除字段
您随时可以在控制台发起删除操作。但是请注意,删除是一个耗时的操作,当删除字段时,系统会扫描历史的故障,并且异步更新,删除字段与故障的关联关系。在没有删除完成之前,您无法重新创建一个同名的字段。
常见问题
为什么不可以在按我创建的字段检索故障?
请确认您想要检索的字段类型是否是 文本 类型。为了保证系统的稳定性,系统目前不支持检索文本类型的字段,请您理解。