跳到主要内容
版本:3.7.0

标签的基本概念

ONE平台提供了丰富健全的标签能力,用户可按需为包括实体、指标、仪表盘在内的各种数据添加标签,这些添加的标签可用于数据检索、权限管理能场景。

关键概念说明

标签:为保证各类场景使用标签的通用性,ONE平台定义标签是一个”key : value“的键值对,使用key代表维度类型,value代表维度值;

共享标签/我的标签:平台按标签使用场景将标签分成共享标签和我的标签两种类型,提供不同的权限控制方式。共享标签表示一些公共的标签,这些标签需要被全部数据的使用者了解,用于如权限控制等公共场景;我的标签表示是仅个人使用的标签,这些标签除了创建者外对其它数据使用者无意义,用于分组过滤等用户使用场景。

image-20251016113227502

备注

共享标签和我的标签虽然是面向不同使用场景的标签类型,但其在概念和功能使用上并没有区别,故后续文档中的功能使用演示将主要以共享标签进行截图示例。

平台标签管理功能的基本用法

标签管理页面是平台标签能力的关键体现,用户在此页面可进行标签key管理、手动标签管理、自动标签规则管理、批量操作实体标签等操作。

标签Key管理

ONE平台定义标签是由完整的key : value结构组成的标识,用户定义标签需先定义key的内容及用法。

创建标签Key

用户可通过页面“创建标签key”功能创建自己需要的key。

image-20251016113356108

功能使用须知:

1、标签key由“汉字、大小写字母、数字、-、_”构成,最大长度100;

2、标签类型分为 手动/自动两种,当前要求按key定义,一个key下的标签不支持手动和自动混用;

  • 手动:需要用户人为创建标签的value,并按value指定这个标签添加给特定的实体实例;
  • 自动:用户不能直接定义value及value和实体实例的关联,需要定义规则,系统将自动按规则生成value和value与实体实例的关联。
提示

”我的标签“目前暂不支持自动标签功能,用户在“我的标签”下仅可创建手动标签。

3、标签生效方式主要解决 怎么自动清理无效标签的问题,考虑到有些标签新的出现就需要删除旧的标签,所以将生效方式区分成“追加/覆盖”两种。(标签生效方式是在真正为实体打标签时触发的)

  • 覆盖:同一个key下新标签覆盖旧标签;
  • 追加:同一个key下添加新标签时保留旧标签;
提示

按标签使用经验建议用户手动类型选择追加,自动类型选择覆盖。

4、特殊生效方式是考虑到平台标签会按实体关系传递,传递过程中实体的1-1或1-N的关系会发生转变,故支持用户按实体来指定标签的生效方式,如果部分实体需要采用不同于其它实体的生效方式,可通过此功能指定;

提示

特殊生效方式为非必填内容,如存在用户可一次选择多个实体使用特殊生效方式。

5、标签key描述用于记录用户关于当前key的说明内容,建议将key的作用和使用方式作为描述内容;

管理标签Key

标签key列表展示当前用户所有已创建的key,用户可通过列表对这些key进行管理,包括:编辑key、删除key、管理key下的标签;

image-20251016114419233

信息

标签Key管理时其它需关注项:

1、共享标签展示环境下所有已创建的key,我的标签展示环境下用户已创建的key;

2、因标签将作为数据特征在平台内广泛使用,故按标签创建的方式将标签区分为预置/自定义两种,便于用户在平台内进行标签管理。

  • 预置表示非ONE平台标签管理体系内创建的标签(如:后台预置、探针采集定义、ETL数据流配置定义等);因预置标签非标签管理体系创建,故页面不直接提供预置标签编辑、删除的功能,如用户需要操作预置标签可通过预置标签的来源功能去干预(如ETL创建的预置标签可从ETL配置页面进行操作)。
  • 自定义表示用户通过ONE平台标签管理体系创建的标签(如:标签管理页面,标签插件);因为探针、ETL这些数据写入方会将标签写入底层数据,故将他们定义的标签全部看作共享标签,原则上仅共享标签会出现预置标签,我的权限全部为自定义标签。
编辑标签key

用户可通过列表的编辑功能对已创建的标签key进行编辑

image-20251016115056784

功能使用说明:

  • 自定义标签,如用户已定义规则或标签value则不允许用户调整“标签类型”,其余内容均可编辑调整;
  • 预置标签,预置标签仅允许用户查看标签内容,不允许编辑/删除。

从当前ETL、探针、后台预置标签的场景看,预置的标签类型应该都是手动的,预置标签的详情管理页面如下图所示,仅展示标签和标签引用情况,不支持用户做修改。

image-20251016115226051

删除标签

如用户确认已创建的某个key及key下的所有标签均不再使用,用户可通过列表功能将key删除,删除key将同步删除key下已创建的所有标签。

image-20251016115315623

手动标签使用及管理

备注

因预置标签不支持用户从标签管理页面操作,故此章节内容仅适用于自定义标签。

标签详情

用户在标签管理页面创建后“手动”类型的key后可以点击key前往“手动标签的标签管理页面” 对此key下的标签进行管理,包括:新建标签、查看标签被实体实例的引用情况、修改/删除标签等。

image-20251016115452068

创建标签

用户新建手动标签分为“创建标签”和“关联实体”两步,创建标签定义标签的value内容和描述,关联实体则是考虑用户操作连贯性增加的快捷操作,使用户创建标签过程中可以同步指定这个标签要添加给那些实体实例,如用户不需要关联实体直接跳过此步即可。

1、创建标签

image-20251016115617978

功能使用说明:

  • 标签输入框平台已默认填充“key:”用户输入value即可组成标签完整的key : value内容,标签value由“汉字、大小写字母、数字、-、_”构成,最大长度100;

2、关联实体

image-20251016115815060

功能使用说明:

  • 关联实体页面左侧展示平台所有支持添加标签的实体及此实体下已勾选的实例数量
    • 此处展示实体与实体模型管理功能勾选使用的实体保持一致,如用户已注册的某种实体未展示在此功能选项中,用户可前往数据模型页面查看模型体系管理功能的配置是否符合预期;
    • 因平台预置实体数量超100,建议用户直接使用检索功能,按实体名称查找需要的实体。
  • 关联实体页面右侧展示用户左侧选中实体在CMDB已注册的实例列表,用户可以在列表勾选实例表示为此实例添加标签
    • 此处实例列表与资源体系列表使用相同的数据,如用户期望修改列表展示属性,可前往资源体系页面修改对应实例列表的自定义表头配置;
    • 对于超高基数实体当前页面仅支持用户为标为关键的实例加标签;

标签管理

1、标签列表,用户可通过列表了解当前key下所有已创建的标签及其基本信息。

image-20251016120154780

功能使用说明:

  • 标签列表检索支持用户输入标签(key:value)的任意部分模糊匹配

2、查看标签引用情况,用户点击标签列表引用次数即可查看那些实体实例引用了此标签;

image-20251016120246535

功能使用说明:

  • 列表被引用次数仅展示实例引用当前标签的统计值,不考虑其它数据引用此标签的情况;
  • 引用标签的实例列表与创建标签时的关联实体页面类似,左侧展示引用实例涉及的实体,右侧展示实际引用的实例列表。

3、编辑标签,如用户对标签value或描述内容不满意,可通过列表编辑功能修改标签value和描述内容。

4、删除标签,如用户确认某标签已不再使用,可通过列表删除功能对其进行删除。

信息

标签删除影响说明:

  • 用户删除标签系统将自动解除此标签和实体实例的引用关系;
  • 因历史时序数据不可修改故删除标签不影响指标、事件等时序数据历史写入的标签内容。

5、编辑实体,用户可通过编辑实体 批量为实体实例打标签或解除标签,页面操作与创建标签时关联实体页面基本一致,勾选保存后给实例打标签,去勾选保存后给实例摘标签。

自动标签使用及管理

标签详情

用户创建自动类型的标签key后需在key列表点击key前往“标签管理”页创建自动标签规则,平台可按用户创建的规则自动给实体实例加标签。

image-20251016121220862

自动标签规则创建

image-20251016121634735

功能使用说明:

  • 标签值来源描述系统自动打标签时 具体操作的标签value是怎么确定的,目前支持 固定值和实体属性两种;
    • 固定值,value是一个固定的字符串,当系统判断实例满足自动打标签的条件时就把这个固定的key : value添加给对应实例;
    • 实体属性,value来源与实例的属性值,系统会自动将实例的属性值取出作为标签添加给符合条件的实例。

自动添加固定值标签的规则配置

image-20251016121833296

配置说明:

  • 标签值:用户需在标签值定义一个实体 和 需要作为标签value的固定内容;
    • 此处选择的实体主要是为了与下方取值范围和标签传递功能对应,如固定值标签不需按关系传递则选择要打标签实体即可,如固定值标签需要传递则需选择传递开始的实体;
    • 此处输入的value值校验规范与手动标签value值的校验规范一致。
  • 标签取值范围:用户可添加条件来明确满足那些条件的实体实例需要自动添加定义的固定值标签;
    • 默认无任何范围条件,表示为实体下全部实例添加此标签;
    • 用户可点击添加范围条件,一个规则下至多允许添加10个范围条件;
    • 范围条件构成,用户添加范围条件可选择实体除“账户ID/环境ID/创建时间/修改时间/生命周期/数据来源/来源详情”外的其它任一属性作为过滤条件;
  • 添加标签:用户在此部分定义标签要自动添加给那些实体实例;
    • 勾选项含义
      • 为提取标签值的实例自身自动添加此标签,用于 明确标签值来源的实体是否要添加此标签;
      • 按从属关系为与提取标签值的实例相关的其它实体实例自动添加此标签,用于 明确标签值是否按关系传递及要传递给那些实体实例。
    • 因添加标签部分再定义系统的实际标签操作行为,故一个规则至少得选中一个标签添加方式,默认两种都勾选;
      • 如勾选按从属关系传递标签,则因至少选择一个需要传递实体;
      • 传递实体的下拉选项为与此实体关系可达的所有实体,包含自己(比如:系统 包含 子系统)。

自动添加指来源于实体属性的标签规则配置

image-20251016122002982

配置说明:

  • 标签值:级联选择标签值来源的实体和标签来源来的实体属性,此类规则平台会将实体属性值作为标签value自动按规则为实例添加标签;
  • 标签取值范围:用户可添加条件来明确满足那些条件的实体实例需要将对应属性值取出来作为标签使用,功能使用和限制与固定值标签规则配置部分描述内容一致;
  • 添加标签:用户在此部分定义提取出来的属性值需要作为标签添加给那些实体,功能使用和限制与固定值标签规则配置部分描述内容一致;
信息

因从实体属性中提取出去的标签值可能包含长度超限,故对于长度超限的标签值平台会自动截断。

自动标签规则管理

1、规则执行,用户创建的规则需要执行后才生效,用户可通过启用自动执行让规则周期性的自动执行;如用户期望即时看的规则的执行效果,可通过列表的立即执行功能手动触发规则执行,触发后系统将按规则对平台现存数据进行标签操作。

image-20251016122138272

2、查看标签,规则执行后平台将按规则生成标签并将标签添加给符合条件的实体实例,用户可点击列表“查看标签”了解规则生成了那些标签及这些标签打给了那些实体实例。

image-20251016122225907

3、编辑/删除规则

  • 编辑规则时用户可对标签除“标签值来源”的其它配置内容按需进行调整,调整后保存并执行即可按调整后规则生效;
  • 删除规则平台将同步删除此规则创建的标签;

横向关系拓展

平台自动标签可按实体模型间关系进行传递,因调用关系复杂且数据量极大,故平台默认仅支持按实例间的包含和运行在两种类型的关系进行标签传递,如用户必须要求按某种调用关系传递标签可在自动标签传递或手动标签传递规则配置页前往”横向关系拓展“页面选择自己需要进行标签传递的调用关系,选择后即可在标签传递规则配置页面选到用户指定的调用关系对应的实体模型。

image-20251016122458526

image-20251016135028470

手动标签传递

基于客户反馈的”期望给某类资源打标签时其相关的其它资源也能自动添加此标签“的场景,平台也为手动标签扩展了自动传递功能,用户可基于标签Key配置规则,指定当此Key下的标签再被添加给某类资源时自动触发传递给与其相关的其它资源。

image-20251016135748830

信息

手动标签传递规则配置中涉及概念基本与自动标签传递规则一致,如您使用存在问题,可参考前文演示的自动标签配置方式。

平台通用标签插件

为提升用户体验,指标体系提供了通用的标签插件供其它业务方使用,用户可通过页面引用的标签插件了解特定数据实例的标签引用情况,并且可以对此实例的标签引用进行操作,包括解除某个标签和实例的关联和将某个自定义标签打给实例。

image-20251016135410403

功能使用说明:

  • 通用标签插件展示实例数据已添加的预置标签和自定义标签(包括自动标签和手动标签);
  • 预置标签和自动标签 仅展示,不支持通过插件删除引用关系,用户如需操作需前往ETL集成页面和自动规则管理页面;
  • 手动标签(包括共享和我的 两类)的操作与用户的数据权限相关,例如:不具备主机实例的读写权限不可操作主机实例共享标签。

通过标签插件为数据实例加标签

点击插件的新增标签图标,即可为数据实例加标签;用户可选择已创建的标签或者直接在文本框输入新标签,平台将在用户确认操作后创建对应标签并为当前资源添加新建的标签。

image-20251016135509001

功能使用说明:

  • 用户通过插件仅可操作类型为手动的标签,自动标签不再下拉选项中展示;
  • 用户通过插件创建新标签时平台将按以下规范生成标签:
    • 如新标签对应的手动类型的key已存在,则在此key下添加用户创建的value;
    • 如新标签对应的手动类型的key不存在,则自动创建手动类型的key,并在此key下添加用户创建的value;
    • 自动创建的手动类型的key更新策略默认使用追加;
    • 如新标签对应的key为已创建的自动类型的key,则提示异常。

通过标签插件解除实例的标签引用

用户点击插件中的删除图标并确认即可解除实例对此标签的引用。

image-20251016135617197

提示

此功能仅是解除标签和数据实例的关联关系,并不是删除标签,删除标签需前往标签管理页面。