跳转至

本地 Func 如何上报自定义高级函数

如果您想在时序图 > 高级函数中使用配置好的本地函数,需在创建好观测云连接器后在本地 Func 中新建本地函数脚本,同步发布后即可使用自定义高级函数。

具体操作

步骤一:创建观测云连接器

参考创建观测云连接器

步骤二:编写高级函数

参考编写自建通知函数

在 Func 中新建本地函数脚本,示例算法写法如下:

'''
高级函数示例算法

示例处理内容为:    
1. 数据传入 DQL 语句
2. 返回算法处理后的结果

注意:  
    检测算法的入口函数固定为`AlgorithmScriptName(data,**kwargs)`
    data 为 DQL 查询数据后里面'series'的结构,示例结构如下:
        [
            {
              'name': 'cpu',
              'tags': {'image': 'nginx'},
              'columns': ['usage_total', 'last'],
              'values': [[1681200000000, 8],[1681202880000, 23],......]
              }
              ...
           ]
    **kwargs 为算法可选参数

入口函数:DBSCAN(data,eps)
输出示例:  
    [
        {
            'status'        : "abnormal_series",
                            # 标记此条时序数据是正常还是离群,离群 status 为 "abnormal_series",正常 status 为 "normal_series"
            'name'          : 'cpu',
            "tags"          : {'image': 'nginx'},
            'colums'        : ['usage_total', 'last'],
            "values"        : [[1681274880000,8],[1681277760000,20],……],
        },
        ...
    ]
'''

函数写好后,添加 category 类型,用户 category 类别写法如下:

@DFF.API('用户自定义函数名称', category='guance.dqlFunc')
Warning

代码编写完成后,不要忘记发布!!!

步骤三:使用本地函数

上述步骤操作完毕后,自定义的高级函数即已经新增到观测云的工作空间。在观测云场景新建仪表盘,添加时序图,可在高级函数下看到本地函数,如图:

步骤四:显示样式

  • 配置后离群的效果:

  • 如果没有离群,前端原数据展示:

文档评价

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