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

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

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

1、单接口监控报告

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

1. API 综合监控报告

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

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

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

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

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

3. 选择监控报告的节点（地区）范围

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

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

4. 流程实时监控状态

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

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

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

6. 流程正确率趋势图

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

7. 流程运行时间统计

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

8. 实时监控报告

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

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

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

9. 详细监控日志

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

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

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

2、流程监控报告

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

1. 实时监控报告

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

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

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

2. 详细监控日志

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

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

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

3、项目监控报告

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

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

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

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

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

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

2. 选择监控报告的节点（地区）范围

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

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

3. API 监控状态统计

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

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

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

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

5. API 正确率趋势图

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

6. 流程监控状态统计

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

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

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

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

8. 流程正确率趋势图

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

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

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

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

10. 项目内异常的 API 列表

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

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

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

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

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