文档首页> 网络智能体> AIOps服务> 常见问题> 用户如何制作一个原子能力包
更新时间:2022-03-25 GMT+08:00
分享

用户如何制作一个原子能力包

AIOps提供上传自定义原子能力包的能力。

首先我们需要了解如何制作一个原子能力zip包,zip包内容和目录结构必须遵循如图1所示,否则会上传失败。
图1 zip包内容和目录结构
表1 原子能力zip包目录结构

目录/文件

详细说明

来源

SampleDatas

存放初始的样例数据,供用户体验上传,可以为空。

可单击“应用货架”,单击“原子能力列表”页签,在“原子能力列表”页面中单击“新建”,在弹出的“组件导入”页面,选择“配置文件”参数对应的“配置文件样例下载”获取。

Others

预留目录,可以为空。

-

Model

存放通过模型训练生成的模型包。

通过模型训练生成模型包的具体步骤请参考快速入门

metadata.json

原子能力配置文件介绍如下文所示。

可单击“应用货架”,单击“原子能力列表”页签,在“原子能力列表”页面中单击“新建”,在弹出的“组件导入”页面,选择“配置文件”参数对应的“配置文件样例下载”获取样例模板metadata.json。

参考表2定制配置文件。

原子能力配置文件介绍

  • 文件介绍

    原子能力描述文件,是AIOps服务提供的配置文件。原子能力按要求配置注册后,AIOps服务就能准确识别各原子能力(包含原子能力基本信息,原子能力支持的数据结构,原子能力的标注信息,以及AIOps和原子能力之前的通信方式)。

    • 文件说明

      配置文件内容可参考AIOps服务提供的样例文件(原子能力创建对话框内可下载配置文件样例),文件内容如下:

      {
          "templateVersion": "v1.1",
          "capVersion": "202000324",
          "capNameEN": "aiops-atom-sample",
          "capNameCN": "原子能力样例",
          "capDescriptionEN": "AIOps atom sample to show the basic input output process",
          "capDescriptionCN": "原子能力样例,展示基础的输入输出",
          "useInstructionEN": "The input data structure is in the form of Key-Value",
          "useInstructionCN": "输入数据结构为Key-Value形式",
          "isolationType": "physical",
          "endPoint": "https://example",
          "managementUri": {
              "processCtrl": "/aiops/assignment"
          },
          "hostingAtomCapConfig": {
              "specification": {
                  "cpu": "2",
                  "memory": "8192"
              },
              "nodeCount": "1",
              "dependentResources": [
              ]
          },
          "dataAccess": {
              "input": [
                  {
                      "funcName": "inputFunc1",
                      "accessType": [
                          "kafka"
                      ],
                      "restUrl": "",
                      "dataType": "data_type_sample"
                  }
              ],
              "output": [
                  {
                      "funcName": "func1",
                      "accessType": [
                          "kafka"
                      ],
                      "restUrl": "",
                      "dataType": "data_type_sample"
                  }
              ]
          },
          "customDataType": [
              {
                  "name": "data_type_sample",
                  "fields": [
                      {
                          "name": "value",
                          "length": 32,
                          "type": "Float",
                          "mandatory": "Y",
                          "desc": "KPI值"
                      }
                  ]
              }
              ],
          "isReceiveMark": false,
          "eventMarkConfig": {
              "markDataType": "alarm_event",
              "markFeedBackType": "aiops",
              "MarkControlConfig": "",
              "markDataAccessType": "kafka",
              "markRestUrl": "",
              "markField": "level",
              "markValueType": "AIOPS.alarm",
              "customMarkValues": {
                  "0": "致命",
                  "1": "严重",
                  "2": "一般"
              }
          }
      }

      样例配置文件内字段配置说明如表2所示。

      表2 样例配置文件字段配置说明

      字段名

      字段值

      是否必须

      描述

      templateVersion

      v1.1

      Y

      原子能力模板版本

      capVersion

      1.1.1

      Y

      原子能力版本

      capNameEN

      atom_extrnal_example

      Y

      原子能力英文名

      capNameCN

      外部原子能力注册样例

      Y

      原子能力中文名

      capDescriptionEN

      atom_extrnal_example

      N

      原子能力英文描述

      capDescriptionCN

      外部原子能力注册样例

      N

      原子能力中文描述

      useInstructionEN

      The input data structure is in the form of Key-Value

      N

      使用说明英文介绍

      useInstructionCN

      输入数据结构为Key-Value形式

      N

      使用说明中文介绍

      domain

      IT应用

      Y

      原子能力适用领域

      isolationType

      logical/physical/stateless

      Y

      原子能力隔离类型。

      物理隔离/逻辑隔离/无状态

      networkPosition

      aiops-vpc/cross-vpc

      Y

      原子能力所属的网络位置。

      取值aiops-vpc表示与AIOps服务属于同一个VPC;取值cross-vpc表示与AIOps服务不属于同一个VPC

      endPoint

      https://example

      Y

      原子能力外部服务API调用地址。

      当原子能力为模型包托管方式时该参数为空

      managementUri

      -

      Y

      AIOps与原子能力交互的管理接口

      managementUri.processCtrl

      /aiops/assignment

      N

      流程控制接口

      managementUri.config

      /anomaly/detect-target

      N

      配置接口,可为空

      dataAccess

      -

      Y

      数据接入方式

      dataAccess.input

      -

      Y

      数据输入配置

      dataAccess.input.funcName

      inputFunc1

      Y

      输入功能名称

      dataAccess.input.accessType

      ["kafka"]/["rest"]

      Y

      接入方式

      dataAccess.input.restUrl

      -

      N

      当“dataAccess.input.accessType”选择“rest”方式时填写rest的请求接口

      dataAccess.input.restTemplate

      {"input_access_info":{"obs_sk":"${obs_sk!}","obs_address":"${obs_address!}","obs_path":"${obs_path!}","obs_ak":"${obs_ak!}"},"id":"${id!}"}

      N

      rest请求模板

      dataAccess.input.dataType

      AIOPS.alarm_event/inputDataType

      Y

      数据输入类型。以“AIOPS.”开头的为系统预制类型,无需提供customDataType数据结构定义。用户自定义数据类型需与customDataType.name名称相同并自定义编辑customDataType数据类型

      dataAccess.output

      -

      Y

      数据输出配置

      dataAccess.output.funcName

      outFunc1

      Y

      输出功能名称

      dataAccess.output.accessType

      ["kafka"]/["obs"]

      Y

      接入方式

      dataAccess.output.restUrl

      -

      N

      当“dataAccess.output.accessType”选择“obs”方式时填写rest接口

      dataAccess.output.restTemplate

      {"input_access_info":{"obs_sk":"${obs_sk!}","obs_address":"${obs_address!}","obs_path":"${obs_path!}","obs_ak":"${obs_ak!}"},"id":"${id!}"}

      N

      rest接口模板

      dataAccess.output.dataType

      AIOPS.alarm_event/outputDataType1

      Y

      数据输出类型。以“AIOPS.”开头的为系统预制类型,无需提供customDataType数据结构定义。用户自定义数据类型需与customDataType.name名称相同并自定义编辑customDataType数据类型

      customDataType

      -

      Y

      输入输出数据类型

      customDataType.name

      inputDataType/outputDataType1

      Y

      输入输出数据类型名称

      customDataType.fields

      -

      Y

      字段集合

      customDataType.fields.name

      -

      Y

      字段名称

      customDataType.fields.type

      String

      Y

      字段类型

      customDataType.fields.length

      -

      Y

      字段长度

      customDataType.fields.desc

      -

      N

      字段描述

      customDataType.fields.mandatory

      Y/N

      Y

      字段是否必须

      isReceiveMark

      true/false

      Y

      当设置值为true时,开启标注反馈功能

      eventMarkConfig

      -

      N

      当“isReceiveMark值”为“true”时该参数必填

      eventMarkConfig.markDataType

      alarm_event

      Y

      标注反馈数据类型名称

      eventMarkConfig.markFeedBackType

      aiops/self

      Y

      标注反馈框架。

      • 使用AIOps提供的原子能力时请选择aiops
      • 使用自定义的反馈框架时请选择self

      eventMarkConfig.MarkControlConfig

      -

      N

      当“eventMarkConfig.markFeedBackType”选择“self”时该参数必填

      eventMarkConfig.markDataAccessType

      kafka/rest

      Y

      标注反馈接入方式。

      eventMarkConfig.markRestUrl

      -

      N

      当“eventMarkConfig.markDataAccessType

      ”为“rest”时该参数必填,填写为接收数据的rest接口

      eventMarkConfig.markField

      level

      Y

      标注反馈等级名称

      eventMarkConfig.markValueType

      AIOPS.alarm

      Y

      标注反馈输出数据类型

      eventMarkConfig.customMarkValues

      {"0":"致命","1":"严重","2":"一般"}

      Y

      标注反馈等级

分享:

    相关文档

    相关产品

close