指标模型管理

AnyRobot 指标模型管理模块提供了指标模型的创建、删除、修改、查询及导入、导出等功能，可实现指标的统一定义及统一管理。您可根据实际业务场景中的指标需求，通过定义说明指标计算规则的查询语句、指标度量单位等参数，自行创建适于不同数据类型（支持指标数据（Metric）、链路数据（Trace）、日志数据（Log）及事件数据（Event））的指标模型。

提示：成功创建指标模型后，您可在AnyRobot可视化分析模块（如：仪表盘图表、服务健康度等）中直接引用，进一步对模型定义的指标数据进行多维度指标分析，详情请参见 指标模型应用 章节。

关于指标模型管理模块的配置操作说明，请参见下文：

► 创建指标模型

进入数据管理>数据模型>指标模型配置页面，如下所示：

点击【+新建】，进入“新建指标模型”的配置页面，如下所示：

1. 配置基本信息

配置参数说明如下：

2. 配置模型信息

在“模型配置”区域，配置指标模型的参数信息，如下所示：

配置参数说明如下：

• *指标类型：在下拉框中选择指标的类型，默认为“原子指标”。原子指标可以理解为是对指标计算逻辑、具体算法的第一层抽象，皆在从根源上规范指标的定义，以保证指标的一致性。

说明：指标类型为必选项，当前仅支持配置“原子指标”。

• *日志分组：点击【设置日志分组】后，在弹出的"选择日志分组"抽屉中配置数据来源日志库所属的日志分组。

说明：1. 日志分组为必填项。配置时，仅支持选择日志分组中的根分组，且仅支持配置1个分组；

         2. 若找不到需要的日志分组，可点击抽屉最下方的“新建日志分组”进行创建。

• *查询语言：您需根据数据源的数据类别（category）选择适用的查询语言，可选项：PromQL、DSL。具体如下：

说明：查询语言为必选项。

• *计算公式：根据上方已配置的*查询语言，填写用于说明指标计算规则的对应查询语句。配置生效后，系统会根据此处定义的计算公式进行指标计算，得到对应指标数据（请参见 预览指标数据了解详情）。

说明：计算公式为必填项。

1）当*查询语言选择“PromQL”时，需填写用于说明指标计算规则的PromQL查询语句，具体书写规范请参见《AnyRobot Eyes 5 UniQuery 开发者指南》2.3PromQL查询语言>2.3.1-2.3.4 章节，若获取此文档失败请联系相关技术支持人员。

2）当*查询语言选择“DSL”时，配置框中默认提供了DSL语句的预输入框架，您可参照下图中的简要提示，根据实际需求修改自定义或默认参数，以快速配置所需公式。您也可以详细了解下文针对预输入计算公式（DSL语句）结构说明后，再进行配置。

提示：预输入计算公式（DSL语句）中尖括号"<>"内为自定义字段，您可根据实际需求自行修改；"（默认）”标识部分为示例的默认参数，您可直接应用，也可根据实际需求自行修改。

▶︎ 预输入计算公式（DSL语句）结构说明

指标模型通过此处配置的DSL语句实现对指定数据集的聚合查询操作，进而提取所需指标。配置框中提供的预输入DSL语句为嵌套的聚合结构（如上图所示），包括过滤查询、聚合查询两部分。其中，“aggs”部分具体定义了需执行的聚合查询操作，即terms（词条）聚合、date_histogram（日期直方图）聚合、value_count（计数）聚合。

提示：您可根据实际指标需求自行定义聚合操作，具体可参见支持的聚合方式了解可配置的聚合方式。

预输入DSL语句查询目的说明：

针对指定数据集，terms聚合先按照<terms-field-name>.keyword字段的值对数据进行分组。在每个分组内再进行date_histogram聚合，按照@timestamp字段进行时间分组，时间分组的间隔由${{__interval}}决定。最后，在每个时间间隔内再进行value_count聚合，统计每个时间间隔内@timestamp字段对应的文档数，生成对应的指标数据。可用于实现指定时间间隔内不同类别指定统计指标的统计分析。详细说明如下：

• • 过滤查询部分

• • 聚合查询部分

• terms（词条）聚合

• date_histogram（日期直方图）聚合

• value_count (计数)聚合

▶︎ 计算公式（DSL语句）基本规范说明

上文仅对预输入框架中示意的聚合方式进行了配置说明，若实际场景中需要使用其他聚合方式，请参考OpenSearch官网文档>Aggregations章节中对应聚合方式的示例结构书写。DSL计算公式的书写需遵循DSL语句的基本语法结构（具体请参见OpenSearch官网文档）及以下特有约束。

• 聚合方式及聚合层数约束

• • 当前不支持并行聚合（Multiple aggregation）查询；
  • 支持的聚合方式如下：

1）分桶聚合：date_histogram（日期直方图）、terms（词条）、filters（过滤）、range（范围）、date_range（日期范围）；

2）值聚合：value_count（计数）、cardinality（去重计数）、sum（求和）、avg（均值）、max（最大值）、min（最小值）、top_hits（桶内排序取 Top N）。

• • 支持配置的分桶聚合层数需≤7，值聚合层数需＝1，各层聚合的聚合名称不能重复。

• 子聚合约束

• • date_histogram（日期直方图） 
    • 计算公式中必须包含date_histogram，且只能有一个；
    • date_histogram 分桶聚合下的子聚合类型需为值聚合。
  • top_hits（桶内排序取 Top N）
    • top_hits 需满足如下结构：

"size": <number>,
"sort": [
    {
        "<sort_field_name>": {
            "order": "desc | asc"
        }
    }
],
"_source": {
    "includes": [
        "<field_name1>",
        "<field_name2>",
        ......
    ]
}

校验说明：1. 完成指标模型的配置后，点击【数据预览】/【保存】按钮，系统将对计算公式（PromQL语句/DSL语句)的合法性进行校验，校验通过后，方可预览指标数据/成功创建指标模型；

       2. 当前暂不支持对查询语句中字段的权限进行校验，若查询了日志分组中不存在的字段，数据查询结果则为空。

注意：当前版本仅支持DSL的时序分析。

*度量字段：仅当*查询语言选择“DSL”时，此项可配置且为必填项，配置说明如下： 

• • 当计算公式中的值聚合方式为top_hits时，此处配置的度量字段应为top_hits中_source所包含的字段名称，且此字段名称对应的字段类型应为数值字段，不兼容日期。
  • 当计算公式中的值聚合方式为其他类型时，此处配置的度量字段应为公式中的值聚合名称，若配置的度量字段与值聚合名称不匹配，系统将会报错。

 说明：度量字段为必填项。

*单位类型：根据实际指标需求设置输出指标（即“度量值”）的度量单位类型，可选项包括：数值单位、存储单位、时间单位、传输速率。

*度量单位：根据实际指标需求设置输出指标（即“度量值”）的度量单位，不同单位类型下可选择的具体度量单位如下：

• • 数值单位：无, 千, 百万, 十亿, 万亿,%
  • 存储单位：bit(s), Byte(s), KB, MB, GB, TB, PB
  • 时间单位：微秒，毫秒, 秒, 分, 时, 天, 周, 月, 年
  • 传输速率：bps, Kbps, Mbps

► 预览指标数据
完成指标模型各项参数的配置后，点击表单下方的【数据预览】，可在页面右侧弹出的抽屉中预览此模型定义的指标数据，包括指定统计周期内的指标趋势图、指标数据，如下所示：

说明：数据预览抽屉默认展示最近30分钟的数据，数据的默认步长会因指标模型已配置的查询语言及计算公式中的数据间隙（interval）值的不同而有所不同，具体如下：

1. 当指标模型的查询语言为“PromQL”，预览数据时默认步长为6min；

2. 当指标模型的查询语言为“DSL”：

• • 若计算公式中配置的间隙（interval）值为常量，预览数据的默认步长为已配置的间隙（interval）值；
  • 若计算公式中配置的间隙（interval）值为变量，预览数据的默认步长为6min。

提示：在时序数据中，“步长”指的是时间序列相邻数据点之间的时间间隔或间距，步长的设置对于时序数据的分析、建模非常重要，需要结合具体场景及数据特征进行设置，较小的步长可以提供更为详细和动态变化的数据，同时也会导致数据量激增从而提高对计算性能的要求。

指标模型数据预览项说明：

► 其他管理操作

•  批量导入创建指标模型

进入指标模型配置页面，点击列表上方的【导入】按钮，在弹出的窗口中选中包含指标模型配置信息的文件，点击【打开】后即可批量导入并创建指标模型。

注意：

1. 仅支持导入json格式的文件；

2. 支持导入多个指标模型：导入时，若指标模型的日志分组名称不存在，则导入操作失败。您需在完成对应日志分组的创建后，再进行导入操作；若AnyRobot中存有重名的指标模型对象，则导入动作将会停止，导入操作失败；

3. 批量导入失败后，您可在审计日志中查看对应的“失败”记录。

在指标模型列表中勾选某一指标模型后，点击列表上方的【导出】按钮，可将已创建的指标模型以“.json”格式导出，如下所示：

提示：支持导出多个指标模型。

•  查看/编辑/删除指标模型

在指标模型配置页面，选中列表中需查看/修改/删除的指定模型后，点击列表操作列的“查看/编辑/删除”按钮后，系统可分别执行对应操作。

说明：

1. 支持删除已被系统其他模块引用的指标模型，删除后，引用该模型的其他分析模块将会报错提示；

2. 指标模型被删除后，您可在审计日志中查看相应的“删除”日志。