开发常用的 3种 API 监控报告

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: API 监控报告是一种监测 API 异常的工具。在 API 管理中,查看 API 异常监控的监控报告,是 Eolink Apikit 常用的功能。Eolink Apikit 的监控报告有 3种:单接口监控报告、流程监控报告、项目监控报告

API 监控报告是一种监测 API 异常的工具。在 API 管理中,查看 API 异常监控的监控报告,是 Eolink Apikit 常用的功能。Eolink Apikit 的监控报告有 3种:

  • 单接口监控报告
  • 流程监控报告
  • 项目监控报告


1、单接口监控报告

单接口监控报告通常关注单个应用程序接口或系统的性能和可用性。它包括有关接口的指标,如响应时间、错误率、吞吐量等。仅关注一个接口,不包括整个流程或项目。单接口监控报告有助于及时发现和解决与特定接口相关的问题,以确保其正常运行。

1. API 综合监控报告

你可以在流程的综合报告页中看到当前流程在选定的时间段内的整体监控概况,可以点击不同的监控节点来切换不同监控节点发出的监控信息,监控信息包含以下内容包括:

  • 所有监控节点(地区)的监控状态
  • 指定监控节点(地区)的监控状态
  • 流程实时的监控状态
  • 流程监控次数及异常原因统计
  • 流程正确率趋势图
  • 流程运行时间统计

1.png

2. 选择监控报告的时间段

项目监控报告默认显示最新的实时报告,实时报告会显示项目最新的一次监控统计。如果你希望查看一段时间内的报告,可以选择今天、3天、7天或者是其他自定义的时间段。

注意,选择实时报告时,正确率趋势图表会显示今天的数据,因为正确率趋势无法仅根据最新的一次监控情况计算得出,必须显示一段时间内的数据才能够绘制趋势图。

2.png

3. 选择监控报告的节点(地区)范围

监控报告可以选择查看什么监控节点的报告数据,项目简况报告默认选择查看综合统计,也就是所有节点数据的汇总报告。

如果你希望仅查看某个监控节点的数据,点击相应的节点名称即可。节点名称前面会有绿色或红色的圆点,表示在当前选中的时间段内,该节点是否有异常的历史记录,如果出现过API或者流程监控异常,则会显示红色圆点,提示你查看相关的监控告警列表。

3.png

4. 流程实时监控状态

当前流程最新一次监控的结果,显示流程当前为正常情况还是异常情况的API数量。

4.png

5. 流程监控次数及异常原因统计

图表会显示在选中时间段内的流程的正确次数以及异常次数。

5.png

6. 流程正确率趋势图

流程正确率趋势图会显示在选中时间段内的流程正确率趋势,正确率趋势最小统计单位是小时,也就是一天最多会显示24个统计点;当选择的时间段大于1天时,正确率的统计点为一天,即一天统计一次正确率。

6.png

7. 流程运行时间统计

流程的运行时间图表会显示流程从开启监控以来,维持正确运行的时长以及错误运行的时长,可以对流程的质量有直观体现。

7.png

8. 实时监控报告

进入 API 的监控详情页,选择时间段为 实时,此时页面会显示该 API 最新一次的监控报告,可以看到API最新一次请求的各阶段时间分析:

  • 总时间
  • 重定向时间
  • 首字节时间
  • DNS解析时间
  • TCP建立连接时间
  • 握手时间
  • 等待首字节时间

8.png

还可以看到请求完整的请求内容和返回内容:

9.png

9. 详细监控日志

进入 API 监控详情页,点击页面上方的详细监控日志标签。进入监控日志标签页后,你可以查看选择需要查看的时间段、日志所属的节点。

在日志列表中,你可以看到选定时间段和节点内的每一次监控请求。你可以在列表中筛选只查看异常的日志,点击查看报告按钮可以查看异常日志的详细请求内容。

注意,系统仅会记录异常的监控日志,并且线上产品的异常监控日志最长保存日期为15天。

10.png


2、流程监控报告

流程监控报告关注业务流程中涉及的多个接口、系统或环节。它包括有关整个流程的指标,如流程持续时间、各个步骤的完成情况、流程吞吐量等。覆盖整个业务流程,而不仅仅是单个接口。流程监控报告帮助组织了解业务流程的整体性能,找出流程中的瓶颈或问题,以便改进流程效率和质量。

1. 实时监控报告

进入流程监控详情页,选择时间段为 实时,此时页面会显示该流程最新一次的监控报告,包含以下内容:

  • API 基本信息:API 请求地址、监控状态、监控节点IP地址、监控状态等;
  • 流程的监控步骤以及每一步的监控状态。

11.png

你可以点击监控步骤来查看详细的监控内容:

12.png

2. 详细监控日志

进入流程监控详情页,点击页面上方的详细监控日志标签。进入监控日志标签页后,你可以查看选择需要查看的时间段、日志所属的节点。

在日志列表中,你可以看到选定时间段和节点内的每一次监控请求。你可以在列表中筛选只查看异常的日志,点击查看报告按钮可以查看异常日志的详细请求内容。

注意,系统仅会记录异常的监控日志,并且线上产品的异常监控日志最长保存日期为15天。

13.png


3、项目监控报告

项目监控报告关注整个项目的状态和进展情况。它包括项目的关键指标、计划与实际的对比、风险和问题的跟踪等。涵盖项目的各个方面,包括范围、时间、成本、质量和风险等。项目监控报告有助于项目管理人员和利益相关者了解项目的健康状况,及时采取措施以确保项目按计划推进,减少风险,确保项目成功完成。

你可以在项目概况页中看到当前项目在选定的时间段内的整体监控概况,包括:

  • 所有监控节点(地区)的监控状态
  • 指定监控节点(地区)的监控状态
  • API 监控状态统计
  • API 监控次数及异常原因统计
  • API 正确率趋势图
  • 流程监控状态统计
  • 流程监控次数以及异常次数比例
  • 流程正确率趋势图
  • 项目正常运行时间统计
  • 项目内异常的 API 列表
  • 项目内异常的流程列表

14.png

1. 选择监控报告的时间段

项目监控报告默认显示最新的实时报告,实时报告会显示项目最新的一次监控统计。如果你希望查看一段时间内的报告,可以选择今天、3天、7天或者是其他自定义的时间段。

注意,选择实时报告时,正确率趋势图表会显示今天的数据,因为正确率趋势无法仅根据最新的一次监控情况计算得出,必须显示一段时间内的数据才能够绘制趋势图。

15.png

2. 选择监控报告的节点(地区)范围

监控报告可以选择查看什么监控节点的报告数据,项目简况报告默认选择查看综合统计,也就是所有节点数据的汇总报告。

如果你希望仅查看某个监控节点的数据,点击相应的节点名称即可。节点名称前面会有绿色或红色的圆点,表示在当前选中的时间段内,该节点是否有异常的历史记录,如果出现过API或者流程监控异常,则会显示红色圆点,提示你查看相关的监控告警列表。

16.png

3. API 监控状态统计

API 监控状态图表会显示当前项目内的 API 总数、监控中的 API 数量、正常API、异常API以及整体API正确率数据。

如果当前选中的时间段内有API出现了异常,则图表显示API监控状态为异常,否则为正常。

17.png

4. API 监控次数及异常原因统计

图表会显示在选中时间段内的请求次数、各种错误原因的次数。你可以通过这个图表了解出现最多的异常原因来进行针对性排查。

18.png

5. API 正确率趋势图

API 正确率趋势图会显示在选中时间段内的API正确率趋势,正确率趋势最小统计单位是小时,也就是一天最多会显示24个统计点;当选择的时间段大于1天时,正确率的统计点为一天,即一天统计一次正确率。

19.png

6. 流程监控状态统计

流程监控状态图表会显示当前项目内的API流程总数、监控中的流程数量、正常流程、异常流程以及整体流程正确率数据。

如果当前选中的时间段内有流程出现了异常,则图表显示监控状态为异常,否则为正常。

20.png

7. 流程监控次数以及异常次数比例

图表会显示在选中时间段内的请求次数、错误次数。

21.png

8. 流程正确率趋势图

流程正确率趋势图会显示在选中时间段内的流程正确率趋势,正确率趋势最小统计单位是小时,也就是一天最多会显示24个统计点;当选择的时间段大于1天时,正确率的统计点为一天,即一天统计一次正确率。

22.png

9. 项目正常运行时间统计

项目运行时间统计图表会统计在选定的时间段内项目的累计正常时间以及累计异常时间,并且会将每段正常、异常时间进行统计,方便你了解项目在什么时间段开始出现异常,以及异常的持续时间等。

如下图表示项目在2020年2月23日凌晨0点起至2020年2月23日晚20点32分54秒处于异常状态,随后项目恢复正常。

23.png

10. 项目内异常的 API 列表

系统会统计在选定时间内出现过异常的 API,你可以通过异常 API 列表快速定位异常的 API,并且根据异常次数排序来找到异常次数最多的 API。

点击列表项的更多消息按钮,可以进入该 API 的监控详情页。

24.png

11. 项目内异常的流程列表

系统会统计在选定时间内出现过异常的流程,你可以通过异常流程列表快速定位异常的流程,并且根据异常次数排序来找到异常次数最多的流程。

点击列表项的更多消息按钮,可以进入该流程的监控详情页。

25.png

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
3天前
|
监控 供应链 搜索推荐
阿里妈妈商品详情API接口:开发、应用与收益的深度剖析
阿里妈妈是阿里巴巴旗下的数字营销平台,其商品详情API接口为开发者提供了获取淘宝、天猫等电商平台商品详细信息的工具。本文介绍了该接口的开发流程、应用场景及带来的收益,揭示了其在电商生态中的重要地位。
25 6
|
3天前
|
供应链 搜索推荐 API
1688APP原数据API接口的开发、应用与收益(一篇文章全明白)
1688作为全球知名的B2B电商平台,通过开放的原数据API接口,为开发者提供了丰富的数据资源,涵盖商品信息、交易数据、店铺信息、物流信息和用户信息等。本文将深入探讨1688 APP原数据API接口的开发、应用及其带来的商业收益,包括提升流量、优化库存管理、增强用户体验等方面。
26 6
|
5天前
|
监控 搜索推荐 API
京东商品详情API接口的开发、应用与收益探索
在数字化和互联网高速发展的时代,京东通过开放商品详情API接口,为开发者、企业和商家提供了丰富的数据源和创新空间。本文将探讨该API接口的开发背景、流程、应用场景及带来的多重收益,包括促进生态系统建设、提升数据利用效率和推动数字化转型等。
19 3
|
10天前
|
供应链 搜索推荐 API
探索1688榜单商品详细信息API接口:开发、应用与收益
本文深入探讨了1688榜单商品详细信息API接口的开发与应用,涵盖接口概述、开发条件、调用方法及数据处理等内容。该API帮助企业高效获取1688平台商品信息,应用于商品信息采集、校验、同步与数据分析等领域,有效提升了企业的运营效率、库存管理、销售转化率及市场策略制定能力,降低了采购成本,提升了客户满意度。
36 9
|
13天前
|
算法 Java API
如何使用Java开发获得淘宝商品描述API接口?
本文详细介绍如何使用Java开发调用淘宝商品描述API接口,涵盖从注册淘宝开放平台账号、阅读平台规则、创建应用并申请接口权限,到安装开发工具、配置开发环境、获取访问令牌,以及具体的Java代码实现和注意事项。通过遵循这些步骤,开发者可以高效地获取商品详情、描述及图片等信息,为项目和业务增添价值。
47 10
|
13天前
|
存储 API 数据库
使用Python开发获取商品销量详情API接口
本文介绍了使用Python开发获取商品销量详情的API接口方法,涵盖API接口概述、技术选型(Flask与FastAPI)、环境准备、API接口创建及调用淘宝开放平台API等内容。通过示例代码,详细说明了如何构建和调用API,以及开发过程中需要注意的事项,如数据库连接、API权限、错误处理、安全性和性能优化等。
58 5
|
12天前
|
数据可视化 搜索推荐 API
速卖通获得aliexpress商品详情API接口的开发、应用与收益。
速卖通(AliExpress)作为阿里巴巴旗下的跨境电商平台,为全球消费者提供丰富商品。其开放平台提供的API接口支持开发者获取商品详情等信息,本文探讨了速卖通商品详情API的开发流程、应用场景及潜在收益,包括提高运营效率、降低成本、增加收入和提升竞争力等方面。
30 1
|
26天前
|
JSON API 数据格式
探索后端开发:从零构建简易RESTful API
在数字时代的浪潮中,后端开发如同搭建一座桥梁,连接着用户界面与数据世界。本文将引导读者步入后端开发的殿堂,通过构建一个简易的RESTful API,揭示其背后的逻辑与魅力。我们将从基础概念出发,逐步深入到实际操作,不仅分享代码示例,更探讨如何思考和解决问题,让每一位读者都能在后端开发的道路上迈出坚实的一步。
|
1月前
|
缓存 前端开发 API
深入浅出:后端开发中的RESTful API设计原则
【10月更文挑战第43天】在数字化浪潮中,后端开发如同搭建梦想的脚手架,而RESTful API则是连接梦想与现实的桥梁。本文将带你领略API设计的哲学之美,探索如何通过简洁明了的设计,提升开发效率与用户体验。从资源定位到接口约束,从状态转换到性能优化,我们将一步步构建高效、易用、可维护的后端服务。无论你是初涉后端的新手,还是寻求进阶的开发者,这篇文章都将为你的开发之路提供指引。让我们一起走进RESTful API的世界,解锁后端开发的新篇章。
|
29天前
|
缓存 API 数据库
Python哪个框架合适开发速卖通商品详情api?
在跨境电商平台速卖通的商品详情数据获取与整合中,Python 语言及其多种框架(如 Flask、Django、Tornado 和 FastAPI)提供了高效解决方案。Flask 简洁灵活,适合快速开发;Django 功能全面,适用于大型项目;Tornado 性能卓越,擅长处理高并发;FastAPI 结合类型提示和异步编程,开发体验优秀。选择合适的框架需综合考虑项目规模、性能要求和团队技术栈。
26 2
下一篇
DataWorks