标准集成

本文介绍如何基于产品官方自定义的标准集成方案进行对接。

简介

标准集成是运维事件中心官方提供的标准监控集成API,支持用户自定义场景接入,将相关异常告警以标准集成数据格式进行推送即可,从而通过流转规则触发报警或事件实现统一的运维管理;查看以下集成步骤完成集成接入。

如何实现标准集成接入?

步骤1:找到标准集成监控源

进入运维事件中心-集成中心-集成配置菜单找到标准集成监控源,进入标准集成的新增集成页面查看集成步骤完成集成接入。

步骤2:配置报警推送URL地址

在控制台获取含集成密钥的推送URL地址。

https://public-alert.aliyuncs.com/event/standard/{集成密钥}
说明

以上URL中的集成密钥为标准集成的集成密钥。

步骤3:按照标准集成数据格式推送告警记录

将自定义场景的异常告警记录,按照标准集成数据格式推送至URL地址。

步骤4:确认集成

完成以上配置后点击集成密钥下的「确认集成」按钮完成集成配置。

步骤5:验证集成是否成功

在标准集成监控侧配置告警、订阅规则并触发报警后,前往集成配置页面查看到标准集成监控源状态为“已接收”,则说明已集成成功。

标准集成数据格式

标准集成目前仅支持POST方式集成,后续将逐步开放Get、Push等集成接入方式。

重要

推送的日志请务必按以下JSON格式配置推送,确保所有告警字段都能通过流转规则完成配置;查看ECS上通过脚本进行主动推送告警记录至标准集成最佳实践完成告警接入。

{
    "summary":"Cpu_util at 85.16% on machine 112.11.123.11",
    "priority":"P1",
    "name":"Cpu 使用超额预警",
    "timestamp":"2021-07-17T08:42:58.315+0000",
    "region":"shanghai",
    "source":"112.11.123.11",
    "application":"zheda/mozi",
    "group":"线上",
    "class":"Load",
    "details":{
        "freeSpace":"1%",
        "pingTime":"1500ms",
        "loadAvg":"0.75"
    },
    "tags":"{}"
}

字段说明如下:

字段

日志字段

描述

是否必要

字符类型

样例

告警摘要

summary

Event的报警记录摘要

必要

字符串(String)

如:" Cpu_util at 85.16% on machine 112.11.123.11" 格式:{指标} at {指标值}on{告警对象}

优先级

priority

Event 优先等级

必要

字符串(String)

如:{P1/P2/P3/P4}

告警名称

name

Event名称(监控项的名称)

非必要

字符串(String)

如:Cpu_usage ; 使用超额预警

告警时间

timestamp

时间戳

必要

字符串(String)

如:'2018-04-08T00:00:00Z'

告警地区

region

不同地域的产品字段

非必要

字符串(String)

如:shang hai / zhe jiang …

告警对象

source

Event 告警触发对象,如主机ID或主机名

必要

字符串(String)

如:machine 112.11.XXX.XX(hostID)or {hostname…}

所属分组

group

告警对象的分组或集群

非必要

字符串(String)

如:日常/预发/线上等分组

所属应用

application

受影响的应用系统

非必要

字符串(String)

如:Zheda/Mozi…

告警分类

class

Event对应的指标类型

非必要

字符串(String)

如:CPU / Load / DiskIO …

告警内容

details

Event 的内容详情,如:content

必要

字符串(String)

如:{"free space": “1%”, "ping time": "1500ms", "load avg": 0.75 }

扩展字段

tags

扩展字段

非必要

字符串(String)

支持用户自定义扩展字段