Eolink Apikit 如何对所有 API 异常请求实时监控 ?

API 小达人
• 阅读 297

API 监控适合业务在互联网上,并且用户来自多个不同的地区,且对API的要求较高的场合,用于解决以下的问题:

  1. 发现由于网络中断或者是API响应异常等导致的服务不可用;
  2. 及时对异常的API进行告警;
  3. 记录监控的日志,方便排查。

Eolink Apikit 除了提供 API 的管理和自动化测试等功能,还提供 API 监控服务,可以为 API 设置定时拨测,并且支持多节点监控,可以从多个不同的地区节点来模拟用户的请求进行监控。


1、创建流程监控

API 流程监控可以同时对多个 API 进行监控,你可以设置多个 API 的监控顺序,数据关联等信息,满足对重点业务场景、操作流程的监控。

进入场景监控设置页面,点击 添加流程 按钮,进入流程编辑页面。

Eolink Apikit 如何对所有 API 异常请求实时监控 ?

在流程编辑页面中设置流程的名称、监控环境、监控频率、监控节点等信息。

Eolink Apikit 如何对所有 API 异常请求实时监控 ?


2、为流程添加 API

1. 添加 API

进入流程编辑页后,点击添加 监控步骤 按钮,在下拉菜单中可以选择从 Eolinker API Management(API 管理产品)中导入 API 信息,或者手动创建监控 API。

Eolink Apikit 如何对所有 API 异常请求实时监控 ?

2. 设置 API 监控信息

点击 新建空白API步骤 的按钮,进入 API 的编辑页后,你可以设置 API 的基本信息、请求信息、校验规则等内容。

API监控的基础信息包括:

  • API请求地址
  • API分组、名称
  • 超时限制:当API的响应时间超出设定的限制时间时,系统将会自动中断该次监控请求,并且报请求超时异常。

3. 请求头部

你可以输入或导入请求头部。批量导入的数据格式为 key : value ,一行一条 header 信息,如:

Connection: keep-alive
Content-Encoding: gzip
Content-Type: application/json
Date: Mon, 30 Dec 2019 20:49:45 GMT

Eolink Apikit 如何对所有 API 异常请求实时监控 ?

4. 请求体

请求体支持以下类型:Form-data(表单)、JSON、XML、Raw(自定义文本类型数据)。

5. Query 参数

Query参数指的是地址栏中跟在问号 ? 后面的参数,如以下地址中的 user_name 参数:

shop/query?shop_id=001

批量导入的数据格式为 ?key=value ,通过 & 分隔多个参数,如:

api.eolinker.com/user/login?user_name=jackliu&user_password=hello

Eolink Apikit 如何对所有 API 异常请求实时监控 ?

6. REST 参数

REST参数指的是地址栏被斜杠 / 分隔的参数,如以下地址中的 user_nameuser_password 参数。

/user/login/{user_name}/{user_password}

注意:只需要在URL中使用 {} 将REST参数括起来,下方的请求参数名中不需要使用 {}

Eolink Apikit 如何对所有 API 异常请求实时监控 ?

7. 权限校验

如果访问API时需要先进行身份验证,可以在权限校验处填写校验的信息。

Eolink Apikit 如何对所有 API 异常请求实时监控 ?


3、设置 API 之间的数据关系

同一个流程里的不同 API 之间可以进行数据关联。比如一个监控流程里有两个 API:

  • 门店创建(/shop/create):创建门店后,会得到返回参数 shop_id
  • 门店查询(/shop/query):根据 shop_id 来查询具体的门店。

我们先设置门店创建API的请求参数和预设返回结果。进入用户登录API的编辑页面:

Eolink Apikit 如何对所有 API 异常请求实时监控 ?

然后我们设置门店查询API。门店查询API只有一个请求参数 shop_idshop_id 的参数值通过门店创建API的返回结果获得。进入门店查询API的编辑页面,设置门店查询API的请求参数,点击参数值的输入框时,上方会出现两个按钮,点击 引用参数值 按钮:

Eolink Apikit 如何对所有 API 异常请求实时监控 ?

在弹窗中选择要绑定的API以及返回参数名称:

Eolink Apikit 如何对所有 API 异常请求实时监控 ?

点击 确认 按钮即可将用户创建API的返回结果绑定到门店查询API的请求参数中。

在执行流程监控的时候,系统会自动将门店创建API的 shop_id 的返回参数动态绑定到门店查询API的请求参数中:

Eolink Apikit 如何对所有 API 异常请求实时监控 ?


4、改变流程的 API 顺序

拖动 API 列表可以改变 API 的执行顺序。但是如果 API 之间存在数据关联,则拖动步骤有可能会破坏 API 之间的数据关联,导致无法正常获得绑定的参数值。

Eolink Apikit 如何对所有 API 异常请求实时监控 ?


5、开启流程监控

流程创建好之后,可以在流程页面的上方点击 开启监控 按钮,来开启流程的监控:

Eolink Apikit 如何对所有 API 异常请求实时监控 ?

也可以在流程列表,操作栏出点击 更多 按钮,在下拉菜单选择 开启监控

Eolink Apikit 如何对所有 API 异常请求实时监控 ?

还可以通过流程列表顶部的 批量操作 按钮,来开启监控:

Eolink Apikit 如何对所有 API 异常请求实时监控 ?


生产环境可能存在同时运行多个版本的代码,并且每个版本的代码都有可能独立迭代,最终分化出不同的版本。如果我们需要对历史版本的API进行自动化测试,或者通过监控来验证线上的稳定性,那么我们可以给每一个版本的API创建一个项目。因为在 Eolink Apikit 中,我们可以为每一个项目设置监控,并且可以独立运行测试用例,满足复杂的API治理的需求。

点赞
收藏
评论区
推荐文章
Johnny21 Johnny21
3年前
Promethus(普罗米修斯)监控
一、任务背景某某某公司是一家电商网站,由于公司的业务快速发展,公司要求对现有机器进行业务监控,责成运维部门来实施这个项目。任务要求1)部署监控服务器,实现7x24实时监控2)针对公司的业务及研发部门设计监控系统,对监控项和触发器拿出合理意见3)做好问题预警机制,对可能出现的问题要及时告警并形成严格的处理机制4)做好监控告警系统,要求可以实
Wesley13 Wesley13
3年前
API管理工具的选择
近几年出现一个新兴的市场,旨在帮助负责管理生产中的分布式API集合的IT部门。这个市场正在迅速成熟,并且有很多功能,可以帮助增强API管理,监控,报告,分析等等。这个市场里流行的API管理工具包括:swagger、postman、eolinker等。这些工具,或者说这些平台,不仅提供API文档管理功能,还包括API在线测试,在确保api易于管理的同时,
Wesley13 Wesley13
3年前
API信息全掌控,方便你的日志管理——阿里云推出API网关打通日志服务
_摘要:_ 近日,阿里云API网关对接了日志服务,可以输出用户在API网关产生的API调用日志,目前支持将API接入API网关的用户查看日志明细、概况、报表分析、在线查询等。访问日志(AcccessLog)是由应用服务生成的日志,每一次API请求都对应一条访问记录,内容包括调用者IP、请求的URL、响应延迟、返回状态码、请求和响应字节数等重要信息
Wesley13 Wesley13
3年前
API网关原理
1、API网关介绍 API网关是一个服务器,是系统的唯一入口。从面向对象设计的角度看,它与外观模式类似。API网关封装了系统内部架构,为每个客户端提供一个定制的API。它可能还具有其它职责,如身份验证、监控、负载均衡、缓存、请求分片与管理、静态响应处理。 API网关方式的核心要点是,所有的客户端和消费端都通过统一的网关接入微服务,在网关层处理所有
Stella981 Stella981
3年前
Serverless 实战:通过 Serverless 架构实现监控告警
在实际生产中,我们经常需要做一些监控脚本来监控网站服务或者API服务是否可用。传统的方法是使用网站监控平台(例如DNSPod监控、360网站服务监控,以及阿里云监控等),它们的原理是通过用户自己设置要监控的服务地址和监测的时间阈值,由监控平台定期发起请求对网站或服务的可用性进行判断。这些方法很大众化,通用性很强,但也不是所有场景都适合。例如,如
融云IM即时通讯 融云IM即时通讯
1个月前
融云IM干货丨 IM调频API接口后,如何监控服务性能?
要确保IM服务API接口调频后的性能监控,可以采取以下策略和步骤:使用专业的监控工具:利用如Postman、Datadog、AWSCloudWatch、NewRelic等工具监控API性能。这些工具可以帮助你监控API的响应时间、吞吐量、错误率等关键性能指
API 小达人 API 小达人
1年前
「Eolink Apikit 」如何快速创建有效的API监控任务?
API监控能够确保API的稳定性。如果一个API出现故障或崩溃,它可能会导致整个应用程序无法正常工作。这对用户和业务来说可能是灾难性的。通过监控API,开发团队可以及时发现问题并采取措施来修复它们,从而降低应用程序中断的风险。作为开发人员,了解API生命周期中的每一个步骤可以帮助改善设计流程以及后续的流程,监控工具可以深入了解API的行为,监控API有助于:1.问题识别、2.问题修复、3.功能分析、4.新版本的迭代。在API管理中,查看API异常监控的监控报告,在EolinkApiki中也是常用的功能,通常你可以在流程综合报告页中看到当前流程在选定时间段内的整体监控情况。
API 小达人 API 小达人
1年前
开发常用的 3种 API 监控报告- Eolink Apikit
API监控报告是一种监测API异常的工具。在API管理中,查看API异常监控的监控报告,是EolinkApikit常用的功能。EolinkApikit的监控报告有3种:单接口监控报告、流程监控报告、项目监控报告
API 小达人 API 小达人
1年前
实用干货丨Eolink Apikit 配置和告警规则的各种用法
API在运行过程中可能会遇到各种异常情况,如响应时间过长、调用频率过高、请求参数错误等,这些异常会对系统的稳定性和性能产生严重影响。因此,对API进行异常监控和告警是非常必要的。本文将介绍EolinkApikit中使用的告警规则,帮助开发者和运维人员更好地监控和管理API。
API 小达人 API 小达人
11个月前
高效管理近 2 万个 API,中金财富是如何做到的?
通过平台设置内控管理,建立起组织内部不同API的权限管控,为实现API统一平台管理奠定基础。将已有存量API传统文档进行了梳理,再进行平台数字化处理。Java通过代码的注解生成API文档,生成的API文档不全,则完善注解之后再重新生成。如果非Java语言的,则通过其他工具转换为Postman等格式再导入到Eolink里面,完成API资产文档的迁移及统一管理、监控。