首页 > 其他分享 >实用干货丨Eolink Apikit 配置和告警规则的各种用法

实用干货丨Eolink Apikit 配置和告警规则的各种用法

时间:2023-11-15 17:55:36浏览次数:42  
标签:监控 api 干货 hook API Eolink Apikit alert 告警

API在运行过程中可能会遇到各种异常情况,如响应时间过长、调用频率过高、请求参数错误等,这些异常会对系统的稳定性和性能产生严重影响。因此,对API进行异常监控和告警是非常必要的。本文将介绍 Eolink Apikit 中使用的告警规则,帮助开发者和运维人员更好地监控和管理 API。


全局告警设置

邮件告警

若需要对所有监控项目设置全局的告警通知,可以在 API监控的项目列表页面,选择 异常告警页面\

image

在这里设置的告警信息,对所有项目有效。

在告警邮箱内设置相应人员的邮箱:

image

注意事项:

  • 发送告警邮件需要消耗告警资源包。API告警、API恢复正常,均会产生告警邮件。
  • 告警邮件以项目为单位,同一时刻内,监控到异常的API和场景,会发送一封邮件。
  • API和场景的新建、修改、开启监控操作会立即发送监控,结果异常会产生首次告警:
    • 监控频率<五分钟的,邮件间隔时间五分钟一次;
    • 监控频率≥五分钟的,按照监控频率发送.
  • 场景和API首次告警后,后续的所有告警会累计到5分钟再整合发送一封邮件。

告警邮件示例:

image

WebHook 告警

告警回调 API 内填入相应的 Webhook 地址:

image

注意事项:

  • 回调 API 最多支持设置三个,API 推送消息次数每日无上限。
  • 回调API能够自定义接收的告警信息的数据类型,类型包括:JSON、Query参数、FormData、XML。
  • API和场景的新建、修改、开启监控操作会立即发送监控,结果异常会产生首次告警:
    • 监控频率<五分钟的,邮件间隔时间五分钟一次;
    • 监控频率≥五分钟的,按照监控频率发送。

Webhook 的 JSON 返回示例:

1. API 监控

{
    "space_id": 708,                                //工作空间ID
    "space_name": "新版本测试",                        //工作空间名称
    "hook_request_time": "2020-09-22 14:47:35",        //请求时间:Y-m-d H:i:s
    "hook_request_timestamp": 1600757255,            //请求时间戳
    "hook_product": "api_monitor",                    //产品,API网络监控
    "hook_event": "alert",                            //操作,值可能性有:alert、recover;其中 alert:告警信息;recover:恢复正常信息
    "hook_operation": "api_alert",                    //事件,值可能性有:api_alert、api_recover;其中 api_alert:告警事件;api_recovet:恢复正常事件
    "content": {
        "project_id": 1399,                            //出现告警的项目ID
        "project_name": "监控测试",                    //出现告警的项目名称
        "apis": [                                    //告警的API列表
            {
                "api_id": 23308,                    //异常APIID
                "api_name": "百度",                    //异常API名称
                "api_url": "http://www.baidu.com/",        //异常API地址
                "exception_count": 1,                //异常次数
                "node_name": "上海",                  //出现异常的地区
                "report_desc": "请求超时",            //异常原因
                "status_code": 0,                    //http状态码
                "response_time": "74ms",            //响应时间
                "time": "2020-09-22 14:47:01"        //异常时间
            }
        ],
        "other_msg": [
            "Eolinker"            //微信UserId
        ]
    }
}

2. 流程监控

{
    "space_id": 708,                //工作空间ID
    "space_name": "新版本测试",        //工作空间名称
    "hook_request_time": "2020-09-23 16:54:55",            //请求时间:Y-m-d H:i:s
    "hook_request_timestamp": 1600851295,                //请求时间戳
    "hook_product": "api_monitor",                    //产品,API网络监控
    "hook_event": "alert",                //操作,值可能性有:alert、recover;其中 alert:告警信息;recover:恢复正常信息
    "hook_operation": "scene_alert",        //事件,值可能性有:scene_alert、scene_recover;其中 scene_alert:告警事件;scene_recovet:恢复正常事件
    "content": {
       "project_id": 1399,                            //出现告警的项目ID
        "project_name": "监控测试",                    //出现告警的项目名称
        "scenes": [
            {
                "scene_id": 347,        //异常流程ID
                "scene_name": "测试流程",        //异常流程名称
                "exception_count": 11,        //异常次数
                "node_name": "中国-广东省-广州市",        //节点名称
                "time": "2020-09-23 16:44:52"    //异常时间
            }
        ],
        "other_msg": [
            "Eolinker"            //微信UserId
        ]
    }
}

项目告警设置

告警设置

重定向

可以设置是否跟随请求的重定向HTTP 状态码为301302

image

验证 SSL 证书

可以设置是否校验SSL证书

image

发送 Eolinker Token 头部

可以设置是否发送Eolinker Token头部,Eolinker Token用于标识请求发送自Eolinker平台

image

发送 no-chche 头部

可以设置是否发送no-cache头部,用于更新缓存数据

image

告警频率

当 API 持续异常时,可以设置 API 的告警频率,比如当设置告警频率为5分钟时,会在 API 出现告警时的第0分钟(立刻)、 第5分钟、 第10分钟…等时间点发送告警 信息,直到 API 状态恢复正常。

image

连续超时判断

为避免网络抖动的影响,您可以设置当同一个 API 连续超时多次时才产生一次告警,减少误报。

image

告警人员设置

当 API 产生告警时,可以直接通知到具体的项目人员,点击添加通知人员

image

选择相应的人员账号,即可通知该成员。

注意:成员需要先在个人设置处设置好邮箱账号

image


邮件告警

若成员没有在个人帐号内设置邮箱,或需要通知到项目外的人员时,可以直接在额外告警邮箱处设置告警邮箱:

image

系统会将异常API通过邮件的方式通知到相应的运维人员。

告警邮件示例:

image

WebHook 告警

在告警回调 API 内填入相应的 Webhook 地址:

image

注意事项:

  • 回调 API 最多支持设置三个,API 推送消息次数每日无上限。
  • 回调API能够自定义接收的告警信息的数据类型,类型包括:JSON、Query参数、FormData、XML。
  • API和场景的新建、修改、开启监控操作会立即发送监控,结果异常会产生首次告警:
    • 监控频率<五分钟的,邮件间隔时间五分钟一次;
    • 监控频率≥五分钟的,按照监控频率发送。

Webhook 的 JSON 返回示例:

1. API 监控

{
    "space_id": 708,                                //工作空间ID
    "space_name": "新版本测试",                        //工作空间名称
    "hook_request_time": "2020-09-22 14:47:35",        //请求时间:Y-m-d H:i:s
    "hook_request_timestamp": 1600757255,            //请求时间戳
    "hook_product": "api_monitor",                    //产品,API网络监控
    "hook_event": "alert",                            //操作,值可能性有:alert、recover;其中 alert:告警信息;recover:恢复正常信息
    "hook_operation": "api_alert",                    //事件,值可能性有:api_alert、api_recover;其中 api_alert:告警事件;api_recovet:恢复正常事件
    "content": {
        "project_id": 1399,                            //出现告警的项目ID
        "project_name": "监控测试",                    //出现告警的项目名称
        "apis": [                                    //告警的API列表
            {
                "api_id": 23308,                    //异常APIID
                "api_name": "百度",                    //异常API名称
                "api_url": "http://www.baidu.com/",        //异常API地址
                "exception_count": 1,                //异常次数
                "node_name": "上海",                  //出现异常的地区
                "report_desc": "请求超时",            //异常原因
                "status_code": 0,                    //http状态码
                "response_time": "74ms",            //响应时间
                "time": "2020-09-22 14:47:01"        //异常时间
            }
        ],
        "other_msg": [
            "Eolinker"            //微信UserId
        ]
    }
}

2. 流程监控

{
    "space_id": 708,                //工作空间ID
    "space_name": "新版本测试",        //工作空间名称
    "hook_request_time": "2020-09-23 16:54:55",            //请求时间:Y-m-d H:i:s
    "hook_request_timestamp": 1600851295,                //请求时间戳
    "hook_product": "api_monitor",                    //产品,API网络监控
    "hook_event": "alert",                //操作,值可能性有:alert、recover;其中 alert:告警信息;recover:恢复正常信息
    "hook_operation": "scene_alert",        //事件,值可能性有:scene_alert、scene_recover;其中 scene_alert:告警事件;scene_recovet:恢复正常事件
    "content": {
       "project_id": 1399,                            //出现告警的项目ID
        "project_name": "监控测试",                    //出现告警的项目名称
        "scenes": [
            {
                "scene_id": 347,        //异常流程ID
                "scene_name": "测试流程",        //异常流程名称
                "exception_count": 11,        //异常次数
                "node_name": "中国-广东省-广州市",        //节点名称
                "time": "2020-09-23 16:44:52"    //异常时间
            }
        ],
        "other_msg": [
            "Eolinker"            //微信UserId
        ]
    }
}

Eolink Apikit 支持自定义告警规则,支持聚合多次告警信息,通过 API、邮件、钉钉、微信等方式及时通知相关运维人员。了解更多 API 异常监控请前往官网:www.eolink.com/

标签:监控,api,干货,hook,API,Eolink,Apikit,alert,告警
From: https://www.cnblogs.com/apibest/p/17834411.html

相关文章

  • 【转】JDK8 升级 JDK11 最全实践干货来了 | 京东云技术团队
    原文地址:JDK8升级JDK11最全实践干货来了|京东云技术团队作者:京东云开发者1.前言截至目前(2023年),Java8发布至今已有9年,2018年9月25日,Oracle发布了Java11,这是Java8之后的首个LTS版本。那么从JDK8到JDK11,到底带来了哪些特性呢?值得我们升级吗?而且升级过程会......
  • 【转】JDK11 升级 JDK17 最全实践干货来了 | 京东云技术团队
    原文地址:JDK11升级JDK17最全实践干货来了|京东云技术团队原文作者:京东云开发者1.前言上篇文章给大家带来了JDK8升级JDK11的最全实践,相信大家阅读后已经对JDK11有了比较深入的了解。2021年9月14日,Oracle发布了可以长期支持的JDK17版本,那么从JDK11到JDK17,......
  • # yyds干货盘点 # 由['a', 'b', 'c']变为['c', 'a', 'b&
    大家好,我是皮皮。一、前言前几天在Python最强王者交流群【吴超建】问了一个Python基础问题,一起来看看吧。由['a','b','c']变为['c','a','b','c']请教下有没有优雅一点的写法?二、实现过程这里【巭孬......
  • Linux-AT命令干货分享,还不赶紧收藏!
    AT简介AT即Attention,AT指令集是从终端设备(TerminalEquipment,TE)或数据中断设备(DataTerminalEquipment,DTE)向终端适配器(TerminalAdapter,TA)或数据电路终端设备(DataCircuitTerminalEquipment,DCE)发送的。通过TA,TE发送AT指令来控制移动台(MobileStation,MS)的功能,与GSM......
  • # yyds干货盘点 # 从5亿行数据中,筛选出重复次数在1000行的数据行,也爆内存了
    大家好,我是皮皮。一、前言前几天在Python最强王者交流群【巭孬......
  • #yyds干货盘点#react之useEffect
    React的HooksAPI为我们提供了一种新的处理副作用的方式——useEffect。useEffect函数接受两个参数:一个是_副作用函数_和一个_依赖数组_。副作用函数是在组件render之后运行,而依赖数组告诉React何时应该执行或跳过该副作用。如果没有提供依赖数组,`useEffect`将在每次渲染后运行。......
  • # yyds干货盘点 # 对5亿行数据去重,各位有没有啥方法。。。内存直接爆了
    大家好,我是皮皮。一、前言前几天在Python最强王者交流群【巭孬......
  • #yyds干货盘点#react的useState源码分析
    简单说下为什么React选择函数式组件,主要是class组件比较冗余、生命周期函数写法不友好,骚写法多,functional组件更符合React编程思想等等等。更具体的可以拜读dan大神的blog。其中Functioncomponentscapturetherenderedvalues这句十分精辟的道出函数式组件的优势。但是在16.8之......
  • 【虹科干货】TWAMP:什么是双向主动测量协议?
    TWAMP(双向主动测量协议)是什么?它在网络性能测量中有什么作用?如果您对IP网络中设备之间的性能问题感兴趣,或者想了解TWAMP与OWAMP之间的区别,以及TWAMP测试的好处。 一、TWAMP是什么?TWAMP代表“双向主动测量协议”,如RFC5357中所述,它是一种用于测量IP网络中任意两个设备或端点之间的网......
  • 【虹科干货】Lambda数据架构和Kappa数据架构——构建现代数据架构
    如何更好地构建我们的数据处理架构,如何对IT系统中的遗留问题进行现代化改造并将其转变为现代数据架构?该怎么为你的需求匹配最适合的架构设计呢,本文将分析两种最流行的基于速度的数据架构,为你提供一些思路。文章速览:什么是数据架构?基于速度的数据架构结语 一、什么是数据......