乐趣区

关于监控工具:提高API采用率的关键快速创建有效的API监控任务

为什么须要 API 监控?

在当今数字化时代,企业应用程序及网站越来越依赖于内部 API 和第三方应用程序提供商。例如一家电商公司,他们的网站可能同时会接入多个内部 API,包含领取、物流、广告等服务。如果在用户购买商品时,凑巧呈现了领取 API 故障,就会导致用户无奈实现付款动作,从而影响公司的整体营收。API 的可靠性间接关系到公司的业务运行。当应用程序中的 API 呈现问题时,会影响到整个网站或应用程序的性能,甚至会导致网站或应用程序间接解体。因而,API 监控变得至关重要。

监控宝 API 监控

监控宝提供的 API 监控可能利用寰球近百个监测点,实时监控 API 的运行状况,包含可用性、正确性、响应工夫等性能数据。通过实时告警和历史统计分析,帮您疾速发现并解决问题,节约企业的运维老本,缩小业务损失。监控宝的 API 监控可能:

  • 实时监控 get、post、put、delete、head、options 六种 API 申请形式,笼罩绝大部分的接口调用格局。
  • 反对 JSON、XML、Text、Response Header、状态码验证及 Postman,JMeter 脚本导入。
  • 通过断言性能监测正确性,反对监控多步申请,从而实现对整个业务流程的监控。

API 监控包含可用性、正确性、响应工夫、可用率、故障率、正确率、均匀可用率、均匀正确率、均匀响应工夫、谬误总时长、谬误总次数、故障总时长、故障总次数 13 个监控指标。判断和计算规定如下:

创立监控工作

配置入口:API 监控 > 工作治理

单击 创立我的项目 创立 API 监控工作,须要配置监控工作的根本信息、事务设置、监控设置和告警设置。

设置根本信息

在创立 API 监控工作页面设置监控工作的根本信息,包含定义工作名称、抉择我的项目是否退出分类。如下图所示。

工作名称

输出工作名称,以便于查找和辨别监控对象。您须要为监控工作设置一个有代表性的名称,例如您须要监控在淘宝中提交订单的业务流程,则可设置监控工作名称为“淘宝 - 提交订单”。

我的项目是否退出分类

为方便管理本人创立的监控工作,您可为以后监控工作抉择一个我的项目分类。您还能够单击创立分类,新建一个我的项目分类作为以后监控工作的分类。

设置初始变量

您可利用变量来存储值,动静地提取 HTTP 响应数据,并在多个申请之间动静地传递数据和状态。比方,增加申请 1 时,可通过设置变量 $a 来动静提取 Response Header 中的 Date 值。而后在增加申请 2 时,应用变量 a 作为断言的目标值。应用变量时须要提前初始化变量,即为变量赋默认值。

在创立 API 监控工作的事务设置页面,单击设置初始化变量,增加并治理初始变量,如下图所示。

设置自定义变量

在自定义变量页面区域,单击增加变量增加一个变量,设置变量名称和变量值。自定义变量仅利用于本监控工作。留神:变量名称必须以 $ 符号结尾,并且是纯字母组成。除自定义变量外,您能够查看零碎变量及自定义零碎变量,零碎变量可用于所有监控工作的 API 申请。

设置零碎变量

在零碎变量页面区域,单击自定义页签,单击增加变量增加零碎变量,定义变量名称和变量形容信息。留神:在自定义零碎变量时,变量名称必须以 $public_结尾。在零碎变量页面区域,单击公共函数页签,查看可用的零碎变量,具体阐明见下表。

设置事务

在创立 API 监控工作的事务设置中增加并治理须要监控的 API 申请。

您可能间接导入脚本来增加 API 申请,也可手动增加和设置 API 申请。增加 API 申请后,可间接复制已增加的申请来创立新的申请。

通过导入脚本增加 API 申请

为疾速创立多条 API 申请,单击导入脚本,在关上的对话框中间接输出脚本内容并导入。导入胜利后,监控宝依据导入的脚本主动创立对应的 API 申请。在关上的导入脚本对话框,单击查看实例理解脚本款式,脚本反对 Postman 和 JMeter 格局。您能够间接应用 Postman 中生成的脚本。

手动增加 API 申请

单击增加申请,关上申请编辑页面,如下图所示。

依据理论须要设置各项内容,具体阐明见下表。

复制 API 申请

为防止反复设置,增加 API 申请后,您可单击【复制按钮】复制以后 API 申请作为一条新的 API 申请,依据须要批改相应内容即可。

挪动 API 申请

当增加多个 API 申请,如果须要调换申请的先后顺序,鼠标拖动指标申请挪动到指标地位。

增加申请距离

单击 增加申请距离,输出发送 API 申请的工夫距离,例如设置“10s”, 则发送一次 API 申请后,期待 10s 发送第二次 API 申请。

测试 API 监控申请

增加 API 申请后,为保障失常监控,需查看是否能申请胜利。单击验证测试来测试申请并查看测试后果,如下图所示。

申请胜利即可用,所有申请都胜利时,监控工作(即整个业务流程)的状态为失常且可用,单击开展 > 返回后果,查看申请的返回后果。增加断言时能力测试申请的正确性,所有申请都正确时监控工作的正确性为“是”,单击开展 > 变量与断言,查看断言详情。

设置监控

在创立 API 监控工作的监控设置中,设置监测点和监控频率,如下图所示。

监测点抉择相应的监测点对指标 API 进行监测。您能够抉择多个监测点也能够创立 / 抉择一个监测点分组。所抉择的监测点或监测点分组的成员均用来监测指标网 API。

  • 抉择监测点:依据需要抉择多个监测点。
  • 抉择监测点分组:抉择或创立监测点分组。若分组内监测点成员有所变动,工作创立后仍会同步。
  • 留神:抉择监测点分组后,监测点分组中的所有监测点都产生故障时才会向您发送告警音讯。
  • 监控频率:监控宝执行监控的工夫距离,例如抉择 2 分钟,则监控宝每隔 2 分钟就执行一次监控。

设置告警

在创立 API 监控工作的告警设置中,设置惯例告警重试次数,间断间断告警揭示,告警线,企业 IM 告诉及告警形式,如下图所示。

告警设置项阐明如下表所示:

小结

在过来的封闭系统中,如果呈现故障,只会对该零碎内的应用程序产生影响,而对于当初大部分企业来说,一个故障就会影响到整个生态系统。监控宝能够利用寰球近百个监测点,实时监控 API 的运行状况,保障企业运维效率及用户体验。点击此处,马上申请监控宝收费试用名额

退出移动版